3.4.3 List Outbound Orders
Endpoint:
plain
POST /OpenApi/V1/Outbound/Outbounding/list?signature=xxxHTTP method: POST
Request parameters:
| Field | Type | Required | Description | Notes |
|---|---|---|---|---|
| page | int | No | Page number | |
| pageSize | int | No | Page size | Maximum 500 |
| shipmentType | int | No | Shipping type | |
| deliveryType | int | No | Last-mile delivery type | |
| outStatus | int | No | Outbound status | |
| start | int | No | Creation time range start | |
| end | int | No | Creation time range end | |
| keyword | string | No | Keyword (outbound order number, container number, customer reference number, batch number, or SKU) | |
| deliveryTimeStart | int | No | Shipment time range start | |
| deliveryTimeEnd | int | No | Shipment time range end | |
| outboundingBizNo | int | No | Outbound batch number |
Success response example:
json
{
"code": "200",
"result": [{
"outboundingNo": "Outbound order number",
"outboundingBizNo": "Outbound batch number",
"userOutboundNo": "Customer reference number",
"shipmentType": "Shipment type: 100 dropshipping; 200 relabeling and forwarding; 201 expedited forwarding",
"outStatus": "Outbound status: 1 awaiting picking; 2 picking; 3 awaiting shipment; 4 shipped; 5 completed; 6 canceled; 7 intercepted",
"isIntercept": "Whether intercepted: 0 no; 1 yes",
"interceptTime": "Interception time",
"deliveryTime": "Shipment time",
"deliveryType": "Last-mile delivery type: 100 UPS; 101 USPS; 102 FedEx; 200 truck delivery; 300 pickup",
"dLocationId": "Destination ID",
"dLocationType": "Destination type: 0 user address; 1 FBA warehouse",
"shippingType": "Shipping type: 1 by carton; 2 by unit; 3 by carton number",
"containerNum": "Container number",
"outCount": "Outbound quantity",
"outPallet": "Outbound pallet count",
"remark": "Notes",
"eta": "Estimated arrival time",
"createTime": "Creation time",
"deliveryName": "Destination",
"transportName": "Carrier name",
"fnSku": "fnsku",
"expressQty": "Shipping labels per carton",
"fbaQty": "FBA labels per carton",
"fnSkuQty": "FNSKU labels per unit"
}],
"message": "Retrieved successfully"
}Error response example:
json
{
"code": "400",
"result": [],
"message": "Failed to retrieve"
}