CREATE Dispatch Order(s)
messageType: logistics.dispatchOrder
{
"messageHeader":{...},
"dispatchOrder":[{...}]
}Creates a dispatch order in our warehouse system.
Filename format: <location>_<operative>\_DO_<YYYYMMDD>_<uniqueId>\.<extensions>
FTP folder: /in/logistics/dispatchOrders
Sample files
| Property | Type | Mandatory | Description |
|---|---|---|---|
| messageHeader | MessageHeader | M | Message header information |
| dispatchOrder | DispatchOrder | M | Dispatch order |
DispatchOrder
"...": {
"warehouse": {...},
"customerReference1": "REF/8345",
"customerReference2": "0015430",
"orderReference": "ORD-987623",
"receiver": {...},
"deliveryDate": {...},
"deliveryTerm": {...},
"forwarderCode": "56435",
"shippingMode": "",
"serviceCode": "",
"comment1": "Glass inside!",
"comment2": "instructions can be here",
"codValue": 92.70,
"codCurrencyCode": "EUR",
"positions": [{...}]
}| Property | Type | Length | Mandatory | Description |
|---|---|---|---|---|
| warehouse | Warehouse | M | Information about warehouse | |
| customerReference1 | String | 35 | M | Reference, all lines with the same reference are one dispatch order. |
| customerReference2 | String | 35 | O | Reference from customer. |
| orderReference | String | 35 | O | customer's client order reference, if needed |
| receiver | LogisticsParty | M | Receiver of dispatched goods | |
| deliveryDate | ApiDate | 10 | O | Date of desired delivery, time is not used |
| deliveryTerm | DeliveryTerm | O | Delivery term and location | |
| forwarderCode | String | 13 | O | Forwarder code defined in forwarder master database. Align with integration manager. |
| shippingMode | String | 3 | O | Shipping mode for parcel orders. Has to be aligned with respective warehouse. |
| serviceCode | String | 3 | O | Service code for parcel orders. Has to be aligned with respective warehouse. |
| comment1 | String | 35 | O | short comment |
| comment2 | String | 160 | O | long comment |
| codValue | BigDecimal | 15,5 | O | Cash on delivery value |
| codCurrencyCode | String | 3 | O | Cash on delivery currency code |
| positions | Array[DispatchOrderPosition] | M | Positions of dispatch orders |
DispatchOrderPosition
"...": {
"clientPositionNumber": "00010",
"customerPositionReference": "8564168146",
"quantity": 5,
"itemCode": "ART-8456",
"batchNumber": "1654863",
"allocationNumber": "44",
"customsReference": "8564168146",
"packagingType": "PAL",
"pricePerItem": 18.54,
"totalPrice": 92.70,
"currencyCode": "EUR",
}| Property | Type | Length | Mandatory | Description |
|---|---|---|---|---|
| clientPositionNumber | String | 5 | O | Position number from customer |
| customerPositionReference | String | 35 | O | Position reference number from customer. This is a passthrough position not visible in WMS only in dispatch confirmation. |
| quantity | Integer | 10 | M | Quantity in pieces (packing unit level 1) |
| itemCode | String | 20 | M | Item number defined in item master database, no leading spaces |
| batchNumber | String | 35 | O | Batch number |
| allocationNumber | String | 35 | O | Allocation number, if item is should be taken from an allocated (reserved) stock |
| customsReference | String | 35 | O | customs reference of item |
| packagingType | String | 3 | O | packagingType for item |
| pricePerItem | BigDecimal | 15,5 | O | Price per item |
| totalPrice | BigDecimal | 15,5 | O | Total price for items |
| currencyCode | String | 3 | O | ISO 4217 three letter currency code |