Skip to end of banner
Go to start of banner

Create Cross Dock Plan API (Beta)

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

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 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 system.

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

  • No labels