Inbound | POST | /orders/cross-dock-plan
Summary
This API can be used to create a cross dock plan from ERP system against an outward order already created in Increff system
Description
Cross dock plan specifies the SKU wise qty in the box which needs to be shipped for an which boxes will go outward against an outward order.
Currently all the items in a box can be shipped in the same outward order, so the cross dock plan will be received at the box level for an order from the external system (ERP)
Hence, API can be used by the external systems to create a cross dock plan in Increff systemOnce a box is added to an order, it can not be added to any other order till the original order is not cancelled.
Cross dock plan can be created for the same order in multiple requests. In such cases, the previous plan will not get replaced, the boxes mentioned in the next request will be included for the same order.
Limit of number of boxes per request - 250
| Note |
|---|
boxCodes have to be unique across all vendors. |
Request
| Code Block | ||
|---|---|---|
| ||
{
"orderCode": "ORD789order1",
"locationCode": "LOC123location1",
"boxesboxCodes": [
{ "boxCode": "BOX001",
"vendorCode": "VENDOR123"
},
{
"boxCode": "BOX002",
"vendorCode": "VENDOR456"
}
"box1", "box2"
]
} |
Parameter Name | Data Type | Description | Mandatory |
| String | Code to uniquely identify an order | Yes |
| String | Location of the warehouse where the order is created | Yes |
boxes
| List |
Yes
(min size = 1, max size = 250)
boxes.boxCode
String
<String> | Codes to uniquely identify |
the boxes in an order |
Yes
boxes.vendorCode
String
Code to identify the vendor
Yes
Response
...
| language | json |
|---|
...
Min Value: 1 Max Value: 250 | Yes |
Response
Empty Response