This API describes how to create an inbound order.

Common Parameter

Test Endpoint: https://api-dev.gcparcelservice.com/openapi/inbound-order/create

Production Endpoint: https://api.gcparcelservice.com/openapi/inbound-order/create

Method: POST


Request Body

{
  "reference_no": "abc123",
  "warehouse_code": "LAX01W",
  "expected_date": "2024-03-30T11:20:30Z",
  "package": {
    "width": 6.21,
    "length": 5.93,
    "height": 8.68,
    "weight": 7.23,
    "products": [
      {
        "quantity": 10,
        "sku": "sku-1"
      },
      {
        "quantity": 20,
        "sku": "sku-2"
      }
    ]
  }
}

Request Body Explanation

Attribute NameTypeDescription
reference_noStringReference Number, must be unique
warehouse_codeStringcode of inbound warehouse, you can get this one from the Get Warehouse List API
expected_dateString(optional) expected inbound date, ISO 8601 format
packageObjectpackage
widthFloat(optional) width of the package, unit with inch
lengthFloat(optional) length of the package, unit with inch
heightFloat(optional) height of the package, unit with inch
weightFloat(optional) weight of the package, unit with pound
productsListproduct list
quantityIntegerquantity of the product
skuStringsku number

Response Body

{ 
  "code": 200,
  "message": "success"
} 

Response Body Explanation

Attribute NameTypeDescription
codeIntegerResponse code: 200 successful, 400/500 failed
messageStringmessage of the result of inbound order creation


Code Example

Create Inbound Order API Code Example