Delivery (DESADV) - API
Insert a delivery for this product into the database. The delivery message can only be sent once. It will contain the delivered order lines.
There can be multiple deliveries, the DesadvNumber must be unique per delivery message. For this you need a different message.
Before sending this XML the order confirmation must be send. In this order confirmation the line numbers of the product within the order are set.
Order incoming - feedback - cXML
or
URL
/proxy/des_adv_xml/delivery/Method
POST
Parameters
Extra parameter must be supplied: user and shop, eg. /proxy/des_adv_xml/delivery/?shop=1&user=10
Fields
No picture version
Field | Type | Mandatory | Description |
|---|---|---|---|
Desadv.DesadvDetail.Packaging.LineItems | array | yes | Collection of items with data |
Desadv.DesadvDetail.Packaging.LineItems.Item.ItemNum | int | yes | The line number in the order |
Desadv.DesadvDetail.Packaging.LineItems.Item.OrderNum | char | yes | The ERP ordernumber which belongs to the order. It also checks the CloudSuite ordernumber when the ERP cannot be found |
Desadv.DesadvDetail.Packaging.LineItems.Item.QuantityValue | decimal (12,4) | yes | The amount of items orders (fractions are possible) |
Desadv.DesadvDetail.Packaging.LineItems.Item.SellerItemID | char | yes | Partnumber of the product |
Desadv.DesadvHeader.Comment | char | no | Any comment about this packing slip |
Desadv.DesadvHeader.DesadvDate | date (yyyy-mm-dd) | yes | Date of the packing slip, eg. 2017-07-02 |
Desadv.DesadvHeader.DesadvNumber | char | yes | Unique packing slip ID |
Desadv.DesadvHeader.PlannedDeliveryDate | date (yyyy-mm-dd) | yes | The expected delivery of the products in this delivery, eg. 2017-07-02 |
Desadv.DesadvHeader.TransportDetails.TransportModeCode | char | yes, but can be empty | The transporter which sends the order |
Desadv.DesadvHeader.TransportDetails.MeansOfTransport.Identification | char | yes, but can be empty | Track & Trace code |
Desadv.DesadvParty.BuyerParty.IDInSupplierSys | char | yes | The ID of the customer |
Desadv.DesadvParty.BuyerParty.Name | char | no | The name of the customer |
Desadv.DesadvParty.ShipToParty.IDInSupplierSys | char | yes | The ID of the customer delivery address |
Desadv.DesadvParty.ShipToParty.Name | char | no | The name of the customer (at the delivery location) |
Desadv.DesadvParty.Extrinsic | char | no | Extra field: <Extrinsic name="IgnoreAddresses">true</Extrinsic> |
Multiple trackingcodes version / Pictures and multiple trackingcode version
Field | Type | Mandatory | Description |
|---|---|---|---|
Desadv.DesadvDetail.Packaging.LineItems | array | yes | Collection of items with data |
Desadv.DesadvDetail.Packaging.LineItems.Item.ItemNum | int | yes | The line number in the order |
Desadv.DesadvDetail.Packaging.LineItems.Item.OrderNum | char | yes | The ERP ordernumber which belongs to the order. It also checks the CloudSuite ordernumber when the ERP cannot be found |
Desadv.DesadvDetail.Packaging.LineItems.Item.QuantityValue | decimal (12,4) | yes | The amount of items orders (fractions are possible) |
Desadv.DesadvDetail.Packaging.LineItems.Item.SellerItemID | char | yes | Partnumber of the product |
Desadv.DesadvHeader.Comment | char | no | Any comment about this packing slip |
Desadv.DesadvHeader.DesadvDate | date (yyyy-mm-dd) | yes | Date of the packing slip, eg. 2017-07-02 |
Desadv.DesadvHeader.DesadvNumber | char | yes | Unique packing slip ID |
Desadv.DesadvHeader.PlannedDeliveryDate | date (yyyy-mm-dd) | yes | The expected delivery of the products in this delivery, eg. 2017-07-02 |
Desadv.DesadvHeader.TransportDetails.TransportModeCode | char | yes | The transporter which sends the order |
Desadv.DesadvHeader.TransportDetails.MeansOfTransport.Identification.TrackingId | char | yes | Track & Trace code |
Desadv.DesadvHeader.TransportDetails.MeansOfTransport.Identification.PackageId | char | yes | Unique package name (eq. if the package is send in multiple boxes in one shipment) |
Desadv.DesadvHeader.TransportDetails.MeansOfTransport.Identification.Images.Image | char | yes | URL to the image (eq. the picture of the box before shipment) |
Desadv.DesadvParty.BuyerParty.IDInSupplierSys | char | yes | The ID of the customer |
Desadv.DesadvParty.BuyerParty.Name | char | no | The name of the customer |
Desadv.DesadvParty.ShipToParty.IDInSupplierSys | char | yes | The ID of the customer delivery address |
Desadv.DesadvParty.ShipToParty.Name | char | no | The name of the customer (at the delivery location) |
Desadv.DesadvParty.Extrinsic | char | no | Extra field: <Extrinsic name="IgnoreAddresses">true</Extrinsic> |
Addendum
With this message it is possible to send shipments. Orders with multiple shipments and shipments with multiple orders are possible and can be combined. Also partial deliveries (even on orderline level) are possible.
ORDER | DELIVERY | DELIVERY 2 |
|---|---|---|
ORDER 1 | DELIVERY A (complete) | |
ORDER 4 | DELIVERY B (partial) | |
ORDER 5 | DELIVERY B (partial) | |
ORDER 6 (20 pieces) | DELIVERY D (8) | DELIVERY E (12) |
Body
No picture version
<?xml version="1.0" encoding="UTF-8"?>
<Desadv>
<DesadvHeader>
<DesadvNumber>0080155790</DesadvNumber>
<DesadvDate>2017-08-07</DesadvDate>
<PlannedDeliveryDate>2017-12-01</PlannedDeliveryDate>
<Comment>34|45|56</Comment>
<TransportDetails>
<TransportModeCode>Regular Transporter</TransportModeCode>
<MeansOfTransport>
<Identification> DEADC387530204FACD</Identification>
</MeansOfTransport>
</TransportDetails>
</DesadvHeader>
<DesadvParty>
<BuyerParty>
<Name>Customername</Name>
<IDInSupplierSys>0000030735</IDInSupplierSys>
</BuyerParty>
<ShipToParty>
<Name>Buyer name</Name>
<IDInSupplierSys>0000030907</IDInSupplierSys>
</ShipToParty>
<Extrinsic name="IgnoreAddresses">true</Extrinsic>
</DesadvParty>
<DesadvDetail>
<Packaging>
<LineItems>
<Item>
<OrderNum>W000070</OrderNum>
<ItemNum>1</ItemNum>
<SellerItemID>357831</SellerItemID>
<QuantityValue>1</QuantityValue>
</Item>
<Item>
<OrderNum>W000070</OrderNum>
<ItemNum>2</ItemNum>
<SellerItemID>357835</SellerItemID>
<QuantityValue>2</QuantityValue>
</Item>
</LineItems>
</Packaging>
</DesadvDetail>
</Desadv>Multiple trackingcodes
<?xml version="1.0" encoding="UTF-8"?>
<Desadv>
<DesadvHeader>
<DesadvNumber>446909</DesadvNumber>
<DesadvDate>2018-01-09</DesadvDate>
<PlannedDeliveryDate>2018-01-12</PlannedDeliveryDate>
<Comment/>
<TransportDetails>
<TransportModeCode>Transport</TransportModeCode>
<MeansOfTransport>
<Identification>
<TrackingId>13123123123123</TrackingId>
<PackageId>120851</PackageId>
</Identification>
<Identification>
<TrackingId>54646465456455</TrackingId>
<PackageId>120852</PackageId>
</Identification>
</MeansOfTransport>
</TransportDetails>
</DesadvHeader>
<DesadvParty>
<BuyerParty>
<Name/>
<IDInSupplierSys>addressid</IDInSupplierSys>
</BuyerParty>
<ShipToParty>
<Name/>
<IDInSupplierSys>11351</IDInSupplierSys>
</ShipToParty>
<Extrinsic name="IgnoreAddresses">true</Extrinsic>
</DesadvParty>
<DesadvDetail>
<Packaging>
<LineItems>
<Item><OrderNum>286</OrderNum><ItemNum>10</ItemNum><SellerItemID>30010012_ZAK</SellerItemID><QuantityValue>3</QuantityValue></Item>
</LineItems>
</Packaging>
</DesadvDetail>
</Desadv>Pictures and multiple trackingcode version
<?xml version="1.0" encoding="UTF-8"?>
<Desadv>
<DesadvHeader>
<DesadvNumber>446909</DesadvNumber>
<DesadvDate>2018-01-09</DesadvDate>
<PlannedDeliveryDate>2018-01-12</PlannedDeliveryDate>
<Comment/>
<TransportDetails>
<TransportModeCode>Secrid transport</TransportModeCode>
<MeansOfTransport>
<Identification>
<TrackingId>https://someurl?query=123456&locale=en_EN</TrackingId>
<PackageId>120851</PackageId>
<Images>
<Image>https://someurl/b0a2402a-e8c1-40d4-ba17-2fca61e78226.jpg</Image>
<Image>https://someurl/040a960a-1e42-4e08-ba93-194b4d3271a9.jpg</Image>
<Image>https://someurl/1944c9b4-3caf-4a83-9a81-b900de68403f.jpg</Image>
</Images>
</Identification>
<Identification>
<TrackingId>https://someurl?query=123457&locale=en_EN</TrackingId>
<PackageId>120852</PackageId>
<Images>
<Image>https://someurl/2dea61d6-9ff4-455f-8c6f-3ffdbb5fc4ed.jpg</Image>
<Image>https://someurl/ba314147-dc01-4109-9e43-5f3423509b0d.jpg</Image>
<Image>https://someurl/1762ac94-b1a9-4701-8d6a-fcd2f802406b.jpg</Image>
</Images>
</Identification>
</MeansOfTransport>
</TransportDetails>
</DesadvHeader>
<DesadvParty>
<BuyerParty>
<Name/>
<IDInSupplierSys>addressid</IDInSupplierSys>
</BuyerParty>
<ShipToParty>
<Name/>
<IDInSupplierSys>11351</IDInSupplierSys>
</ShipToParty>
</DesadvParty>
<DesadvDetail>
<Packaging>
<LineItems>
<Item><OrderNum>O-23</OrderNum><ItemNum>1</ItemNum><SellerItemID>123456-1234</SellerItemID><QuantityValue>5</QuantityValue></Item>
<Item><OrderNum>O-23</OrderNum><ItemNum>2</ItemNum><SellerItemID>12345-67</SellerItemID><QuantityValue>5</QuantityValue></Item>
</LineItems>
</Packaging>
</DesadvDetail>
</Desadv>Result fields
Fieldname | Type | Description |
|---|---|---|
Status@code | integer | The resultcode. See Generic response codes |
Status@text | string | The description of the status. |
Result example
<?xml version="1.0" ?>
<cXML>
<Reponse>
<Status code="499" text="Error during processing:"/>
</Reponse>
</cXML>Related content
© 2024 CloudSuite BV, All rights reserved