Create Cross Dock Plan API (Beta)

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 which boxes will go outward against an outward order.
Since box codes can be duplicate for a vendor, hence its mandatory to provide the vendor code against the box codes.
Once a box is added to an order, it can not be added to any other order till the original order is not cancelled.
Limit of number of boxes per request - 250

Note:

Currently Increff WMS only supports box wise crossdocking, so the cross dock plan will be received at the box level for an order from the external system (ERP)
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.
The boxes which are a part of cross dock plan for an order cannot be part of cross dock plan for other order, unless the order gets cancelled

Request

{
  "orderCode": "ORD789",
  "locationCode": "LOC123",
  "boxes": [
    {
      "boxCode": "BOX001",
      "vendorCode": "VENDOR123"
    },
    {
      "boxCode": "BOX002",
      "vendorCode": "VENDOR456"
    }
  ]
}

Parameter Name	Data Type	Description	Mandatory
`orderCode`	String	Code to uniquely identify an order	Yes
`locationCode`	String	Location of the warehouse where the order is created	Yes
`boxes`	Object[]	List of boxes in the order	Yes (min size = 1, max size = 250)
`boxes.boxCode`	String	Code to uniquely identify a box in an order	Yes
`boxes.vendorCode`	String	Code to identify the vendor	Yes

Response

{
  "boxes": [
    {
      "boxCode": "BOX001",
      "vendorCode": "VENDOR123"
    },
    {
      "boxCode": "BOX002",
      "vendorCode": "VENDOR456"
    }
  ]
}

HttpStatus : 200