Sales Shipment
This service is to recieve posted sales shipments from Business Central.
Service Endpoint
The base Endpoint is:
OutboundSalesShipmentIISWebService/OutboundSalesShipmentIISWebService
API Methods
Here are the available methods for the Sales Shipment Service:
- GetSalesShipment
- GetSalesShipmentByDate
- GetSalesShipmentAsPDF
GetSalesShipment
Sample Request
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:out="http://tempuri.org/OutboundSalesShipmentIISWebService/" xmlns:x53="urn:microsoft-dynamics-nav/xmlports/x5371204">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://tempuri.org/OutboundSalesShipmentIISWebService/OutboundSalesShipmentIISWebService/GetSalesShipment</wsa:Action>
</soap:Header>
<soap:Body>
<out:GetSalesShipment>
<out:outboundSalesShipment/>
<out:fromDocNo>1</out:fromDocNo>
<out:customerNo>10000</out:customerNo>
<out:maxEntries>1</out:maxEntries>
<out:showDetails>false</out:showDetails>
</out:GetSalesShipment>
</soap:Body>
</soap:Envelope>
Sample 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/OutboundSalesShipmentIISWebService/OutboundSalesShipmentIISWebService/GetSalesShipmentResponse</a:Action>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetSalesShipmentResponse xmlns="http://tempuri.org/OutboundSalesShipmentIISWebService/">
<outboundSalesShipment>
<Sales_Shipment xmlns="urn:microsoft-dynamics-nav/xmlports/x5371204">
<Header_General>
<Document_No>102001</Document_No>
<Order_Date>2017-01-05</Order_Date>
<Shipment_Method_Code>EXW</Shipment_Method_Code>
<Currency_Code/>
<Shipping_Agent_Code/>
<Customer_Order_No/>
<External_Document_No/>
<Payment_Method_Code/>
</Header_General>
<Header_Sell_To_Customer>
<Customer_No>10000</Customer_No>
<Contact_No/>
<Name>Möbel-Meller KG</Name>
<Name_2/>
<Address>Tischlerstr. 4-10</Address>
<Address_2/>
<Post_Code>48436</Post_Code>
<City>Düsseldorf</City>
<Country_Code/>
</Header_Sell_To_Customer>
<Header_Bill_To_Customer>
<Customer_No>10000</Customer_No>
<Contact_No/>
<Name>Möbel-Meller KG</Name>
<Name_2/>
<Address>Tischlerstr. 4-10</Address>
<Address_2/>
<Post_Code>48436</Post_Code>
<City>Düsseldorf</City>
<Country_Code/>
</Header_Bill_To_Customer>
<Header_Ship_To_Customer>
<Code/>
<Name>Möbel-Meller KG</Name>
<Name_2/>
<Address>Tischlerstr. 4-10</Address>
<Address_2/>
<Post_Code>48436</Post_Code>
<City>Düsseldorf</City>
<Country_Code/>
</Header_Ship_To_Customer>
</Sales_Shipment>
</outboundSalesShipment>
</GetSalesShipmentResponse>
</s:Body>
</s:Envelope>
GetSalesShipmentByDate
Sample Request
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:out="http://tempuri.org/OutboundSalesShipmentIISWebService/"
xmlns:x53="urn:microsoft-dynamics-nav/xmlports/x5371204">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://tempuri.org/OutboundSalesShipmentIISWebService/OutboundSalesShipmentIISWebService/GetSalesShipmentByDate</wsa:Action>
</soap:Header>
<soap:Body>
<out:GetSalesShipmentByDate>
<out:outboundSalesShipment/>
<out:fromDocNo>1</out:fromDocNo>
<out:customerNo>10000</out:customerNo>
<out:maxEntries>1</out:maxEntries>
<out:showDetails>true</out:showDetails>
<out:fromDate>2016-01-01</out:fromDate>
<out:toDate>2017-04-14</out:toDate>
</out:GetSalesShipmentByDate>
</soap:Body>
</soap:Envelope>
Sample 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/OutboundSalesShipmentIISWebService/OutboundSalesShipmentIISWebService/GetSalesShipmentByDateResponse</a:Action>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetSalesShipmentByDateResponse xmlns="http://tempuri.org/OutboundSalesShipmentIISWebService/">
<outboundSalesShipment>
<Sales_Shipment xmlns="urn:microsoft-dynamics-nav/xmlports/x5371204">
<Header_General>
<Document_No>102001</Document_No>
<Order_Date>2017-01-05</Order_Date>
<Shipment_Method_Code>EXW</Shipment_Method_Code>
<Currency_Code/>
<Shipping_Agent_Code/>
<Customer_Order_No/>
<External_Document_No/>
<Payment_Method_Code/>
</Header_General>
<Header_Sell_To_Customer>
<Customer_No>10000</Customer_No>
<Contact_No/>
<Name>Möbel-Meller KG</Name>
<Name_2/>
<Address>Tischlerstr. 4-10</Address>
<Address_2/>
<Post_Code>48436</Post_Code>
<City>Düsseldorf</City>
<Country_Code/>
</Header_Sell_To_Customer>
<Header_Bill_To_Customer>
<Customer_No>10000</Customer_No>
<Contact_No/>
<Name>Möbel-Meller KG</Name>
<Name_2/>
<Address>Tischlerstr. 4-10</Address>
<Address_2/>
<Post_Code>48436</Post_Code>
<City>Düsseldorf</City>
<Country_Code/>
</Header_Bill_To_Customer>
<Header_Ship_To_Customer>
<Code/>
<Name>Möbel-Meller KG</Name>
<Name_2/>
<Address>Tischlerstr. 4-10</Address>
<Address_2/>
<Post_Code>48436</Post_Code>
<City>Düsseldorf</City>
<Country_Code/>
</Header_Ship_To_Customer>
<Sales_Shpt_Lines>
<Sales_Shpt_Line>
<Line_No>10000</Line_No>
<Type>2</Type>
<No>1968-S</No>
<Variant_Code/>
<Description>MEXICO Bürostuhl, schwarz</Description>
<Description_2/>
<Quantity>2</Quantity>
<Unit_Of_Measure_Code>Stück</Unit_Of_Measure_Code>
<Shipment_Date>2017-01-05</Shipment_Date>
<Unit_Price>191.00</Unit_Price>
</Sales_Shpt_Line>
<Sales_Shpt_Line>
<Line_No>20000</Line_No>
<Type>2</Type>
<No>1996-S</No>
<Variant_Code/>
<Description>ATLANTA Whiteboard, Basis</Description>
<Description_2/>
<Quantity>3</Quantity>
<Unit_Of_Measure_Code>Stück</Unit_Of_Measure_Code>
<Shipment_Date>2017-01-05</Shipment_Date>
<Unit_Price>1404.30</Unit_Price>
</Sales_Shpt_Line>
</Sales_Shpt_Lines>
</Sales_Shipment>
</outboundSalesShipment>
</GetSalesShipmentByDateResponse>
</s:Body>
</s:Envelope>
GetSalesShipmentAsPDF
Sample Request
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:out="http://tempuri.org/OutboundSalesShipmentIISWebService/">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://tempuri.org/OutboundSalesShipmentIISWebService/OutboundSalesShipmentIISWebService/GetSalesShipmentAsPDF</wsa:Action>
</soap:Header>
<soap:Body>
<out:GetSalesShipmentAsPDF>
<!--Optional:-->
<out:documentNo>102001</out:documentNo>
<!--Optional:-->
<out:resultBase64String/>
</out:GetSalesShipmentAsPDF>
</soap:Body>
</soap:Envelope>
Sample 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/OutboundSalesShipmentIISWebService/OutboundSalesShipmentIISWebService/GetSalesShipmentAsPDFResponse</a:Action>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetSalesShipmentAsPDFResponse xmlns="http://tempuri.org/OutboundSalesShipmentIISWebService/">
<GetSalesShipmentAsPDFResult/>
<resultBase64String> BASE 64 encoded string </resultBase64String>
</GetSalesShipmentAsPDFResponse>
</s:Body>
</s:Envelope>
Field Information
Header Field Information
| Name | Description | Type | max. Length | Occurance |
|---|---|---|---|---|
| 🔑 Document No* | Specifies the number of the Sales invoice. Leave this empty when creating a new invoice. (Requieres auto incremented no. series in Business Central.) | String | 20 | 1..1 |
| Order_Date | Specifies the order DateTime. Date is saved in NAV/Business Central only! | DateTime | 0..1 | |
| Shipment_Method_Code | Specifies a default shipment method code for the order. Get a list of codes from the Master Data Service | String | 50 | 0..1 |
| Currency_Code | Specifies a default currency code for the invoice. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Shipping_Agent_Code | Specifies a default shipping agent code for the order. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Shipping_Agent_Service_Code | Specifies a default shipping agent service code for the order. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Customer_Order_No | Specifies the customer's order no. | String | 20 | 0..1 |
| External_Document_No | Specifies the external document no. This must be unique in NAV/Business Central. You'll receive an error when insert two orders with the same external document no. | String | 35 | 0..1 |
| Payment_Method_Code | Specifies a default payment method code for the invoice. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Prices_Incl_VAT | Specifies the price to be incl. VAT | Boolean | 0..1 |
Address Sell-to, Ship-to, Bill-to Field Information
| Name | Description | Type | max. Length | Occurance |
|---|---|---|---|---|
| Customer_No | Specifies the number of the customer. | String | 20 | 1..1 |
| Contact_No | Specifies the number of the contact. | String | 20 | 1..1 |
| Code | Specifies the Ship-to Address Codes. | String | 10 | 0..1 |
| Name | Specifies the name. | String | 50 | 0..1 |
| Name_2 | Specifies the additional name. | String | 50 | 0..1 |
| Address | Specifies the address. i.E. 'Hauptstraße 12b' | String | 50 | 1..1 |
| Address_2 | Specifies the add. address information. | String | 50 | 1..1 |
| City | Specifies the city. | String | 30 | 1..1 |
| Post_Code | Specifies a code for the post code of the 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 address. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
Sales Shipment Line Field Information
| Name | Description | Type | max. Length | Occurance |
|---|---|---|---|---|
| 🔑 Line No* | Specifies the pos. number. | Decimal | 1..1 | |
| Type | Specifies the Type: "Item", "Resource", "G/L Account" | String | 0..1 | |
| No | Specifies the No. i.E. Item No. "70000" | String | 20 | 0..1 |
| Variant_Code | Specifies the item variant code | String | 10 | 0..1 |
| Description | Specifies the Description. | String | 50 | 0..1 |
| Description_2 | Specifies the additional Description. | String | 50 | 0..1 |
| Unit_Of_Measure_Code | Specifies the sales unit of measure of the item. | String | 10 | 0..1 |
| Quantity | Specifies the quantity. | Decimal | 1..1 | |
| Line_Amount | Specifies the lines amount | Decimal | 0..1 | |
| Line_Amount_Incl_VAT | Specifies the lines amount incl. VAT. | Decimal | 0..1 | |
| Line_Discount_Percent | Specifies the lines discount percentage. | Decimal | 0..1 | |
| Line_Discount_Amount | Specifies the lines discount amount. | Decimal | 0..1 | |
| Shipment_Date | Specifies the lines shipment date. | DateTime | 0..1 | |
| Unit_Price | Specifies the lines unit price | Decimal | 0..1 |