Create Distribution Orders

POST /distributionorders

Create new Distribution Orders in batch.

Body Required

id should be omitted on creation of new orders, status is a derived field thus ignored

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
label string

Label of the DO (if any)
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

Default values that are set based on other fields: CANCELLED if CancelledAt is set, COMPLETED if DeliveredQuantity >= Quantity else PROCESSING. Additional possible statuses: ALLOCATED, IN TRANSIT. (handled manually)
toWarehouseExternalId string Required

The external id of the warehouse where quantity is moved to

Responses

201

Created
Hide response attributes Show response attributes object
- 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
- label string
  
  Label of the DO (if any)
- 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
  
  Default values that are set based on other fields: CANCELLED if CancelledAt is set, COMPLETED if DeliveredQuantity >= Quantity else PROCESSING. Additional possible statuses: ALLOCATED, IN TRANSIT. (handled manually)
- toWarehouseExternalId string Required
  
  The external id of the warehouse where quantity is moved to
default

All errors will return the same object with a describing code & message
Hide response attributes Show response attributes object
- error string
- message string
- statusCode integer

POST /distributionorders

curl \
 -X POST https://api.maddenanalytics.com/v2/api/distributionorders \
 -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","label":"DO-14534","orderDate":"2021-07-19T14:05:22.257Z","orderType":"Transfer","quantity":4,"shippedAt":"2021-07-19T14:05:22.257Z","status":"CANCELLED","toWarehouseExternalId":"store1"}]'

Request examples

[
  {
    "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",
    "label": "DO-14534",
    "orderDate": "2021-07-19T14:05:22.257Z",
    "orderType": "Transfer",
    "quantity": 4,
    "shippedAt": "2021-07-19T14:05:22.257Z",
    "status": "CANCELLED",
    "toWarehouseExternalId": "store1"
  }
]

Response examples (201)

[
  {
    "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",
    "label": "DO-14534",
    "orderDate": "2021-07-19T14:05:22.257Z",
    "orderType": "Transfer",
    "quantity": 4,
    "shippedAt": "2021-07-19T14:05:22.257Z",
    "status": "CANCELLED",
    "toWarehouseExternalId": "store1"
  }
]

Response examples (default)

{
  "error": "Error Type (if any)",
  "message": "Message describing the error",
  "statusCode": 400
}