Create or Update Distribution Orders using externalDOID and externalRowID
POST
/v1/distributionorders/batch
Create or Update Distribution Orders using externalDOID and externalRowID
Body Required
composite key is required per item
-
cancelledDate string
Date that the order was cancelled
-
completedDate string
Date that the order was received and completed:
-
deliveredQuantity integer
Quantity that has been relocated
-
deliveryDate string
Date that the order will be delivered
-
deliveryWindow string
Delivery Window of DO (if any)
-
externalDistributionOrderId string Required
The external distribution order id used as a header
-
externalRowId string
The external row id
-
fromWarehouseExternalId string Required
The external id of the warehouse where quantity is moved from
-
id integer
-
key string Required
Key, used as a reference to source system
-
orderDate string Required
Date that the purchase order was created
-
orderType string
Order type of DO (if any)
-
quantity integer
Quantity to be relocated
-
shippedAt string
Date that the order was shipped
-
status string
Status, CANCELLED if CancelledAt is set, COMPLETED if DeliveredQuantity >= Quantity else PROCESSING
-
toWarehouseExternalId string Required
The external id of the warehouse where quantity is moved to
POST /v1/distributionorders/batch
curl \
-X POST https://ma-api.maddenanalytics.com/v1/distributionorders/batch \
-H "Authorization: $API_KEY" \
-d '[{"cancelledDate":"2021-07-19T14:05:257Z","completedDate":"2021-07-19T14:05:257Z","deliveredQuantity":2,"deliveryDate":"2021-07-19T14:05:22.257Z","deliveryWindow":"SS24","externalDistributionOrderId":"DO-14534","externalRowId":"21020","fromWarehouseExternalId":"central","id":42,"key":"7340192703345","orderDate":"2021-07-19T14:05:22.257Z","orderType":"Transfer","quantity":4,"shippedAt":"2021-07-19T14:05:22.257Z","status":"CANCELLED","toWarehouseExternalId":"store1"}]'
Request example
[
{
"cancelledDate": "2021-07-19T14:05:257Z",
"completedDate": "2021-07-19T14:05:257Z",
"deliveredQuantity": 2,
"deliveryDate": "2021-07-19T14:05:22.257Z",
"deliveryWindow": "SS24",
"externalDistributionOrderId": "DO-14534",
"externalRowId": "21020",
"fromWarehouseExternalId": "central",
"id": 42,
"key": "7340192703345",
"orderDate": "2021-07-19T14:05:22.257Z",
"orderType": "Transfer",
"quantity": 4,
"shippedAt": "2021-07-19T14:05:22.257Z",
"status": "CANCELLED",
"toWarehouseExternalId": "store1"
}
]
Response examples (200)
[
{
"message": "Missing BrandName",
"reference": "123456-001-43",
"referenceField": "key",
"statusCode": 400
}
]
Response examples (default)
{
"error": "Error Type (if any)",
"message": "Message describing the error",
"statusCode": 400
}