3.2.1 Create an Inbound Order
Endpoint:
plain
POST /OpenApi/V1/Inbound/Inbounding/create?signature=xxxHTTP method: POST
Request parameters:
| Field | Type | Required | Description | Notes |
|---|---|---|---|---|
| userInboundNo | string | No | Customer reference number | |
| inboundingType | int | Yes | Inbound type: 1 full container; 2 loose cargo | Default: 1 |
| carrierType | int | Yes | Transport mode: 100 sea freight; 200 air freight; 300 transfer | Default: 100 |
| arrivalType | int | Yes | Arrival method | Default: 100 |
| containerNum | string | No | Container number or air waybill (AWB) number | |
| caseInboundPallet | int | No | Expected inbound pallet count | Default: 0 |
| etd | int | No | Shipment time | UNIX timestamp |
| eta | int | No | Estimated arrival time | UNIX timestamp |
| remark | string | No | Notes | |
| distanceUnit | int | Yes | Dimension unit: 1 in; 2 cm | Default: 1 |
| massUnit | int | Yes | Weight unit: 1 lb; 2 kg | Default: 1 |
| inboundingDetailList | array | Yes | Inbound SKU data; see the format below | |
| warehouseCode | string | Yes | Warehouse code |
inboundingDetailList array format:
json
[{
"isMultipleSku": "Whether multiple SKUs are included: 1 no; 2 yes",
"operateType": "Operation type: 100 storage; 200 relabeling and forwarding; 201 expedited forwarding",
"deliveryType": "Last-mile delivery type: 100 UPS; 101 USPS; 102 FedEx",
"dLocationName": "Destination name",
"dLocationType": "Destination type: 0 user address; 1 FBA warehouse",
"sku": "SKU; required when isMultipleSku is 1",
"length": "Length; required when isMultipleSku is 2",
"width": "Width; required when isMultipleSku is 2",
"height": "Height; required when isMultipleSku is 2",
"weight": "Weight; required when isMultipleSku is 2",
"netWeight": "Net weight; required when isMultipleSku is 2",
"caseCarton": "Expected carton count",
"logisticsData": "【ShipmentId、ReferenceId】",
"fnSku": "fnSku",
"expressQty": "Shipping labels per carton",
"fbaQty": "FBA labels per carton",
"fnSkuQty": "FNSKU labels per unit",
"remark": "Notes",
"lotNo": "Lot number; may be empty when isMultipleSku is 1",
"expirationDate": "Expiration time; may be empty when isMultipleSku is 1",
"detailList": [{
"sku": "sku",
"casePiecesQty": "Units of this SKU per carton",
"logisticsData": "【ShipmentId、ReferenceId】",
"fnSku": "fnSku",
"lotNo": "Lot number",
"expirationDate": "Expiration time"
}]
}]Success response example:
json
{
"code": "200",
"result": {
"inboundingNo": "IB20260428001"
},
"message": "Created successfully"
}Error response example:
json
{
"code": "400",
"result": [],
"message": "Failed to create"
}