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 |
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 |
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 |
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 |
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 | N | String | 2021-08-01 00:00:00 | Update time （ Begin of range ），The scope of the inquiry shall not exceed 31 days |
| updateTimeTo | N | 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 |