Ship-to Address
Shipping Addresses are stored at the customer in Business Central. With this service you can receive addresses for a certain customer. The customer address services are to read one specific or filter multiple items by different criteria. You can also update and delete records.
Service Endpoint
The base Endpoint is:
CustShipToAddressIISWebService/CustShipToAddressIISWebService
API Methods
Here are the available methods for the Ship-to Address Service:
- Create
- Read
- Read Multiple
- Update
- Update Multiple
- Delete
Read Multiple Sample
Request
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:cus="http://tempuri.org/CustShipToAddressIISWebService/"
xmlns:cus1="urn:microsoft-dynamics-schemas/page/custshiptoaddress">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://tempuri.org/CustShipToAddressIISWebService/CustShipToAddressIISWebService/ReadMultiple</wsa:Action>
</soap:Header>
<soap:Body>
<cus:ReadMultiple>
<cus:filter>
<cus:CustShipToAddress_Filter>
<cus1:Field>Customer_No</cus1:Field>
<cus1:Criteria>10000</cus1:Criteria>
</cus:CustShipToAddress_Filter>
</cus:filter>
<cus:bookmarkKey></cus:bookmarkKey>
<cus:setSize>0</cus:setSize>
</cus:ReadMultiple>
</soap:Body>
</soap:Envelope>
Response
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://tempuri.org/CustShipToAddressIISWebService/CustShipToAddressIISWebService/ReadMultipleResponse</a:Action>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ReadMultipleResponse xmlns="http://tempuri.org/CustShipToAddressIISWebService/">
<ReadMultipleResult>
<CustShipToAddress>
<Key xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">52;3gAAAAJ7BTEAMAAwADAAMAAAAAJ7/0wAQQBOAEcARQAgAFIASA==6;4161310;</Key>
<Customer_No xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">10000</Customer_No>
<Code xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">LANGE RH</Code>
<Name xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">Möbel-Meller KG</Name>
<Address xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">Lange Reihe 10</Address>
<City xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">Düsseldorf</City>
<Post_Code xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">48436</Post_Code>
<Blocked xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">false</Blocked>
</CustShipToAddress>
<CustShipToAddress>
<Key xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">48;3gAAAAJ7BTEAMAAwADAAMAAAAAJ7/00A3ABOAEMASABFAE4=6;4161300;</Key>
<Customer_No xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">10000</Customer_No>
<Code xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">MÜNCHEN</Code>
<Name xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">Möbel-Meller KG</Name>
<Address xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">Bergstr. 12</Address>
<City xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">Düsseldorf</City>
<Post_Code xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">48436</Post_Code>
<Blocked xmlns="urn:microsoft-dynamics-schemas/page/custshiptoaddress">false</Blocked>
</CustShipToAddress>
</ReadMultipleResult>
</ReadMultipleResponse>
</s:Body>
</s:Envelope>
Field Information
Address Field Information
| Name | Description | Type | max. Length | Occurance |
|---|---|---|---|---|
| 🔑 Customer No | Specifies the number of the customer. | String | 20 | 1..1 |
| 🔑 Code | Code of the address. i.e. this can be an incremented string. | String | 10 | 1..1 |
| Name | Specifies the customer's name. | String | 50 | 0..1 |
| Name_2 | Specifies the customer's add. name information. | String | 50 | 0..1 |
| Address | Specifies the customer's address. i.E. 'Hauptstraße 12b' | String | 50 | 1..1 |
| Address_2 | Specifies the customer's add. address information. | String | 50 | 1..1 |
| City | Specifies the customer's city. | String | 30 | 1..1 |
| Post_Code | Specifies a code for the post code of the customer's address. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Country_Region_Code | Specifies a code for the country/region of the customer's address. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Blocked | Specifies whether the customer is blocked. | Boolean | 0..1 |