1. LOGISTICS API
1.1. Query first leg order list
post {HTTP(S)host}/api/{version}/firstLeg
1.1.1. SERVICE_TYPE
QUERY_FIRST_LEG_ORDER_LIST
1.1.2. Request
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
firstLegNumber | N | String | T987654321 | The headway tracking number, up to 50 characters |
status | N | String | NEW | see Headway status |
updateTimeFrom | N | String | 2021-08-01 | Update Time (Range Start) |
updateTimeTo | N | String | 2021-08-31 | Update Time (End of Range) |
page | Y | Number | 1 | Page number, default 1 |
pageSize | Y | Number | 100 | Number of records per page. no more than 200; Default is 100 |
1.1.3. Reponse
Base
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
errorCode | Y | String | “DATA_INPUT_ERROR” | Error Code |
errorMsg | Y | String | “The input of Params is incorrect” | Business Error Messages |
state | Y | String | success | Response State |
total | Y | Number | 100 | Total num |
result | Y | List | See FirstLegOrder |
FirstLegOrder
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
firstLegNumber | Y | String | T210824125209 | firstLegNumber |
asnNumber | Y | String | A210824125208 | Inbound order number |
customNumber | Y | String | X123987 | Reference number |
status | Y | String | NEW | status: NEW,COMMITTED,SHIPPING,RECEIVING, FINISHED, CLOSED |
createTime | Y | String | 2021-08-01 00:00:00 | Creation time |
updateTime | Y | String | 2021-08-02 00:00:00 | Update time |
warehouseName | Y | String | W1 | source warehouse |
destWarehouseName | Y | String | W2 | dest warehouse |
portFrom | Y | String | P1 | source port |
portTo | Y | String | P2 | Port of destination |
buyerTitle | Y | String | Customize the buyer's header | Buyer's letterhead |
logisticsName | Y | String | The name of the logistics | Logistics |
carrierName | Y | String | The name of the service provider | Provider |
trackNumber | Y | String | 123456 | Tracking number |
preReceiveTime | Y | String | 2021-08-03 | Estimated time of arrival |
shippingTime | Y | String | 2021-08-03 | Actual shipping time |
forwarder | Y | String | Freight forwarding information | Freight forwarding information |
feeList | Y | List<FirstLegFee> | See FirstLegOrderFee | |
skuList | Y | List | See FirstLegOrderSku |
FirstLegOrderFee
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
name | Y | String | B200308115691 | Name of the expense |
amount | Y | String | S200222115613 | Amount due |
appliedAmount | Y | Decimal | 0.1 | The amount requested |
paidAmount | Y | Decimal | 0.1 | The amount paid |
invalidAmount | Y | Decimal | 0.1 | Closed/Voided amount |
status | Y | String | NEW | Status: NEW, APPLIED,PAID |
FirstLegOrderSku First-leg details
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
sku | Y | String | B200308115691 | sku |
title | Y | String | S200222115613 | The title of the product |
expectedQuantity | Y | Number | 1 | Expected Quantity |
receiveQuantity | Y | Number | 1 | Actual quantity |
packSpecification | Y | Number | 1 | Packing rate |
netWeight | Y | Decimal | 1.0 | net weight |
weight | Y | Decimal | 1.0 | gross weight |
weightUnit | Y | String | KG | see Units of weight |
length | Y | Decimal | 1 | The outer box length |
width | Y | Decimal | 1 | The outer box width |
height | Y | Decimal | 1 | The outer box height |
dimensionUnit | Y | String | cm | see Units of length |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/firstLeg' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_FIRST_LEG_ORDER_LIST"' \
--form 'bizParam="{\"firstLegNumber\":\"T250904149349\"}"' \
--form 'timestamp="1731742317"' \
--form 'sign="a4c8c32ece5712aaebabccf7f2be6ae8"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"asnNumber\":\"A250904149350\",\"carrierName\":\"0811发货物流lzg\",\"createTime\":\"2025-09-04 18:23:08\",\"customNumber\":\"test1000001\",\"destWarehouseName\":\"品晟测试仓库\",\"firstLegNumber\":\"T250904149349\",\"isDeleted\":0,\"logisticsName\":\"0811-lzg\",\"preReceiveTime\":\"2025-09-04\",\"shippingTime\":\"2025-09-04\",\"skuList\":[{\"dimensionUnit\":\"m\",\"expectedQuantity\":1,\"height\":0.0100,\"isDeleted\":0,\"length\":0.0100,\"netWeight\":1.0000,\"packSpecification\":1,\"receiveQuantity\":1,\"sku\":\"FMGAVNO381370036647\",\"title\":\"clickAsia商品1\",\"weight\":1.0000,\"weightUnit\":\"KG\",\"width\":0.0100}],\"status\":\"FINISHED\",\"updateTime\":\"2025-09-08 19:22:50\",\"warehouseName\":\"customer\"}],\"state\":\"success\",\"total\":1}",
"requestId": "d17a7c55-e892-40e2-ae13-924ba1436a53"
}
1.2. Create first leg order
1.2.1. SERVICE_TYPE
CREATE_FIRST_LEG_ORDER
1.2.2. Request
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
destWarehouseType | Y | String | FBA | FBA or OVERSEA The type of the destination warehouse |
skuDetailList | Y | List | see skuDetail |
skuDetail
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
lineId | Y | String | 12134 | Starting with a positive integer 0, the same SerialNumber is the same document content |
warehouseName | Y | String | source warehouse | |
destWarehouseName | Y | String | dest warehouse | |
logisticsName | Y | String | Logistics Name | |
customNumber | N | String | Reference number | |
portFrom | N | String | source port | |
portTo | N | String | dest port | |
buyerTitle | N | String | Buyer's letterhead | |
trackNumber | N | String | Tracking number | |
preReceiveTime | N | String | 2023/10/23 | Estimated time of arrival |
preShipTime | N | String | 2023/10/23 | Estimated shipping time |
remark | N | String | remark | |
containerNumber | N | String | Ocean Container Number | |
sku | Y | String | sku | |
originalAsnNumber | N | String | Inbound order number | |
preExpectedQuantity | Y | String | The number of shipments | |
packingRate | N | String | Number of single boxes (pcs) | |
netWeight | N | String | net weight (KG) | |
length | N | String | length (cm) | |
width | N | String | width (cm) | |
height | N | String | height (cm) | |
skuRemark | N | String | sku remark | |
fbaNo | Y | String | Shipment number, required for FBA | |
refId | N | String |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/firstLeg' \
--form 'appId="TEST"' \
--form 'serviceType="CREATE_FIRST_LEG_ORDER"' \
--form 'bizParam="{
\"destWarehouseType\": \"OVERSEA\",
\"skuDetailList\": [
{
\"lineId\": 0,
\"warehouseName\": \"customer\",
\"destWarehouseName\": \"易达云【测试】\",
\"logisticsName\": \"1\",
\"sku\": \"429732\",
\"preExpectedQuantity\": 1
}
]
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="de36b24db8b9c440c93d40c16e3787cf"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"state\":\"success\"}",
"requestId": "60525b5b-577e-4342-840b-f3c2a2d01f2a"
}
1.3. Query first leg logistics
1.3.1. SERVICE_TYPE: QUERY_FIRST_LRG_LOGISTICS
1.3.2. Request
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
warehouseName | Y | String | Warehouse name |
1.3.3. Reponse
Base
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
errorCode | Y | String | “DATA_INPUT_ERROR” | Error Code |
errorMsg | Y | String | “The input of Params is incorrect” | Business Error Messages |
state | Y | String | success | Response State |
bizContent | Y | List | See logisticsInfo |
logisticsInfo
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
id | Y | String | Logistics ID | |
logisticsName | Y | String | The name of the logistics |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/firstLeg' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_FIRST_LRG_LOGISTICS"' \
--form 'bizParam="{
\"warehouseName\": \"易达云【测试】\"
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="832c9f894c49a430a3a9508ef44c4c25"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"id\":3095,\"logisticsName\":\"易达云测试-LA-寄售-FBA扣减库存\"}],\"state\":\"success\"}",
"requestId": "844371af-ab79-4375-8a34-e3b68cea18ad"
}
1.4. Push tracking status sepc
1.4.1. SERVICE_TYPE
PUSH_TRACKING_PACKAGE
1.4.2. Request
Base
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
orderNumber | Y | String | “S230109129883” | System order number |
onlineOrderId | Y | String | xsasx | online Order number |
trackingNumber | Y | String | trackingNumber | 11111 |
carrier | Y | String | carrier | LEX TH |
status | Y | String | CREATED | Logistics tracking status |
example(default form-data type):
JSON格式:
{"appId":"1751530655877-10658", "bizParam":"{\"carrier\":\"J&T Express\",\"onlineOrderId\":\"579877366324626911\",\"orderNumber\":\"S2508053858595\",\"status\":\"CREATED\",\"trackingNumber\":\"762388742732\"}", "serviceType":"PUSH_TRACKING_PACKAGE", "timestamp":1754373394777, "sign":"c0fe6c3ab1a92831dffa5796fbf08a27"}
FORM-DATA格式:
{appId=1751530655877-10658, bizParam={"carrier":"J&T Express","onlineOrderId":"579877366324626911","orderNumber":"S2508053858595","status":"CREATED","trackingNumber":"762388742732"}, serviceType=PUSH_TRACKING_PACKAGE, timestamp=1754373394777, sign=c0fe6c3ab1a92831dffa5796fbf08a27}
1.5. Query first lege tracking package
1.5.1. SERVICE_TYPE
QUERY_FIRST_LRG_TRACKING_PACKAGE
1.5.2. Request
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
updateTimeFrom | Y | String | 2021-08-01 00:00:00 | Update time ( Begin of range ),The scope of the inquiry shall not exceed 31 days |
updateTimeTo | Y | String | 2021-08-31 00:00:00 | Update time ( End of range ),The scope of the inquiry shall not exceed 31 days |
orderNumbers | N | List | ["111111","22222"] | Order numbercollection, no more than 200 pcs |
onlineOrderIds | N | List | ["111111","22222"] | online No more than 200 single number collections |
trackingNumbers | N | List | ["111111","22222"] | Logistics Tracking number collection, no more than 200 pcs |
returnDetails | N | boolean | true | Whether to return logistics details, the default is false |
page | Y | Number | 1 | Page number, default 1 |
pageSize | Y | Number | 100 | Number of records per page. no more than 200; Default is 100 |
1.5.3. Reponse
Base
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
errorCode | Y | String | “DATA_INPUT_ERROR” | Error Code |
errorMsg | Y | String | “The input of Params is incorrect” | Business Error Messages |
state | Y | String | success | Response State |
bizContent | Y | String | json | See PageData |
PageData
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
result | Y | String | See TrackingPackage | |
total | Y | number | 5 | Total num |
TrackingPackage
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
orderNumber | Y | String | “S230109129883” | System order number |
onlineOrderId | Y | String | xsasx | online Order number |
trackingNumber | Y | String | trackingNumber | 11111 |
carrier | Y | String | carrier | LEX TH |
status | Y | String | CREATED | Logistics tracking status |
eventList | N | List | Logistics details, See Event |
Event
Params | Require | DataType | Sample | Description |
---|---|---|---|---|
eventDate | Y | number | Timestamp of the event | 1706011481000 |
event | Y | String | Event | |
timeZoneId | Y | String | Asia/Manila | timeZone |
Request:
curl --location --request POST 'https://gerp-test1.800best.com/api/v1/firstLeg' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_FIRST_LRG_TRACKING_PACKAGE"' \
--form 'bizParam="{
\"page\": 1,
\"pageSize\":3,
\"updateTimeFrom\":\"2025-06-01 00:00:00\",
\"updateTimeTo\":\"2025-07-01 00:00:00\"
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="f3e86869c80fb102c36bee7de7db04c8"'
Response:
{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"carrier\":\"DPDDE\",\"onlineOrderId\":\"56912848239\",\"orderNumber\":\"S250610145162\",\"status\":\"NOT_FOUND\",\"trackingNumber\":\"01475240195458\"},{\"carrier\":\"DARAZ (AUTO)\",\"onlineOrderId\":\"2025061000008\",\"orderNumber\":\"S250611145236\",\"status\":\"NOT_FOUND\",\"trackingNumber\":\"20250611\"},{\"carrier\":\"DHL\",\"onlineOrderId\":\"S250612145255\",\"orderNumber\":\"S250612145255\",\"status\":\"NOT_FOUND\",\"trackingNumber\":\"CA764272822DE\"}],\"state\":\"success\",\"total\":18}",
"requestId": "47b280d4-e77e-43b4-8f81-6636e94105ef"
}