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 Name | Type | Description |
|---|---|---|
| reference_no | String | Reference Number, must be unique |
| warehouse_code | String | code of inbound warehouse, you can get this one from the Get Warehouse List API |
| expected_date | String | (optional) expected inbound date, ISO 8601 format |
| package | Object | package |
| width | Float | (optional) width of the package, unit with inch |
| length | Float | (optional) length of the package, unit with inch |
| height | Float | (optional) height of the package, unit with inch |
| weight | Float | (optional) weight of the package, unit with pound |
| products | List | product list |
| quantity | Integer | quantity of the product |
| sku | String | sku number |
Response Body
{
"code": 200,
"message": "success"
} Response Body Explanation
| Attribute Name | Type | Description |
|---|---|---|
| code | Integer | Response code: 200 successful, 400/500 failed |
| message | String | message of the result of inbound order creation |
Code Example
Create Inbound Order API Code Example
