/amzStaServer/openapi/awd/inbound-shipment/page{
"operation": {
"method": "POST",
"path": "/amzStaServer/openapi/awd/inbound-shipment/page"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"requestExample": {
"page": 1,
"dateType": 1,
"endDateTime": "2023-07-31T23:59:59Z",
"shipmentId": "AWD20230715001",
"sidList": [
123456789,
987654321
],
"length": 10,
"startDateTime": "2023-07-01T00:00:00Z",
"statusList": [
"CREATED",
"IN_TRANSIT"
]
},
"responseExample": "{\n \"code\": 0,\n \"data\": {\n \"countId\": null,\n \"current\": 1,\n \"maxLimit\": 1000,\n \"optimizeCountSql\": true,\n \"orders\": [\n {\n \"asc\": false,\n \"column\": \"gmtCreate\"\n }\n ],\n \"pages\": 1,\n \"records\": [\n {\n \"awdDeliveredGoodsBO\": {\n \"destinationAddressLine1\": \"456 Distribution Ave\",\n \"destinationAddressLine2\": \"Building 3\",\n \"destinationCity\": \"Phoenix\",\n \"destinationCountryCode\": \"US\",\n \"destinationPostalCode\": \"85001\",\n \"destinationStateOrRegion\": \"AZ\"\n },\n \"awdDeliveredGoodsItemBOS\": [\n {\n \"asin\": \"B0ABCD1234\",\n \"boxQuantity\": \"5\",\n \"expiration\": \"2025-12-31\",\n \"fnsku\": \"X000123ABC\",\n \"height\": 10.5,\n \"labelOwner\": \"SELF\",\n \"length\": 15.75,\n \"lengthUnit\": \"INCHES\",\n \"msku\": \"ABC123\",\n \"parentAsin\": \"B0PARENT12\",\n \"prepCategory\": \"NONE\",\n \"prepOwner\": \"SELF\",\n \"productName\": \"Example Product\",\n \"quantityInBox\": \"20\",\n \"sku\": \"SKU12345\",\n \"title\": \"Example Product Title\",\n \"url\": \"https://example.com/product.jpg\",\n \"weight\": 12.3,\n \"weightUnit\": \"POUNDS\",\n \"width\": 8.25\n }\n ],\n \"awdShippingAddressBO\": {\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Suite 100\",\n \"city\": \"Seattle\",\n \"countryCode\": \"US\",\n \"phoneNumber\": \"1234567890\",\n \"postalCode\": \"98101\",\n \"shipperName\": \"Example Shipper\",\n \"stateOrProvinceCode\": \"WA\",\n \"zone\": \"Downtown\"\n },\n \"carrierCode\": \"UPS\",\n \"createByName\": \"API User\",\n \"gmtCreate\": \"2023-07-15T10:00:00Z\",\n \"gmtModified\": \"2023-07-15T14:30:00Z\",\n \"orderId\": \"AWD20230715001\",\n \"remark\": \"Fragile items, handle with care\",\n \"shipBy\": \"2023-07-20\",\n \"sid\": 123456789,\n \"status\": \"SHIPPED\",\n \"trackingId\": \"1Z1234567890123456\",\n \"warehouseReferenceId\": \"PHX5\",\n \"destinationShipperName\":\"\"\n }\n ],\n \"searchCount\": true,\n \"size\": 10,\n \"total\": 1\n },\n \"message\": \"Success\",\n \"error_details\": [],\n \"request_id\": \"c3d4e5f6-g7h8-i9j0-k1l2-m3n4o5p6q7r8\",\n \"response_time\": \"2023-07-15T16:30:45Z\"\n}"
}| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | page | 分页页码 | integer | — | Required | 分页页码 |
| 2 | dateType | 时间类型 1 | integer | — | Required | 时间类型 1:创建 2更新 |
| 3 | endDateTime | 结束时间 | string | — | Required | 结束时间,格式:YYYY-MM-DD 双闭区间 |
| 4 | shipmentId | 货件单号 | string | — | Optional | 货件单号 |
| 5 | sidList | 店铺id列表 | array<any> | — | Optional | 店铺id列表 |
| 6 | length | 分页大小 | integer | — | Required | 分页大小,上限 |
| 7 | startDateTime | 开始时间 | string | — | Required | 开始时间,格式:YYYY-MM-DD 双闭区间 |
| 8 | statusList | 任务状态 | array<any> | — | Optional | 任务状态:CREATED:已创建;SHIPPED:已发货;IN_TRANSIT:运输中;RECEIVING:接收中;DELIVERED:已送达;CLOSED:已关闭;CANCELLED:已取消 |
| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | code | 状态码 | integer | — | Optional | 状态码,0成功 |
| 2 | data | data | object | — | Optional | |
| 2.1 | countId | countId | string | — | Optional | |
| 2.2 | current | current | integer | — | Optional | |
| 2.3 | maxLimit | maxLimit | integer | — | Optional | |
| 2.4 | optimizeCountSql | optimizeCountSql | boolean | — | Optional | |
| 2.5 | orders | orders | array<object> | — | Optional | |
| 2.5.1 | asc | asc | boolean | — | Optional | |
| 2.5.2 | column | column | string | — | Optional | |
| 2.6 | pages | pages | integer | — | Optional | |
| 2.7 | records | records | array<object> | — | Optional | |
| 2.7.1 | awdDeliveredGoodsBO | 配送地址 | object | — | Optional | 配送地址 |
| 2.7.1.1 | destinationAddressLine1 | 配送地址-详细街道地址1 | string | — | Optional | 配送地址-详细街道地址1 |
| 2.7.1.2 | destinationAddressLine2 | 配送地址-详细街道地址2 | string | — | Optional | 配送地址-详细街道地址2 |
| 2.7.1.3 | destinationCity | 配送地址-城市 | string | — | Optional | 配送地址-城市 |
| 2.7.1.4 | destinationCountryCode | 配送地址-国家(地区) | string | — | Optional | 配送地址-国家(地区) |
| 2.7.1.5 | destinationPostalCode | 配送地址-邮政编码 | string | — | Optional | 配送地址-邮政编码 |
| 2.7.1.6 | destinationStateOrRegion | 配送地址-州/省/地区编码 | string | — | Optional | 配送地址-州/省/地区编码 |
| 2.7.2 | awdDeliveredGoodsItemBOS | 发货商品 | array<object> | — | Optional | 发货商品 |
| 2.7.2.1 | asin | asin | string | — | Optional | asin |
| 2.7.2.2 | boxQuantity | 箱数 | string | — | Optional | 箱数 |
| 2.7.2.3 | expiration | 有效期 | string | — | Optional | 有效期 |
| 2.7.2.4 | fnsku | fnsku | string | — | Optional | fnsku |
| 2.7.2.5 | height | 箱子高 | number | — | Optional | 箱子高 |
| 2.7.2.6 | labelOwner | 标签类型(AMAZON | string | — | Optional | 标签类型(AMAZON,SELF) |
| 2.7.2.7 | length | 箱子长 | number | — | Optional | 箱子长 |
| 2.7.2.8 | lengthUnit | 长度单位(INCHES-英制 | string | — | Optional | 长度单位(INCHES-英制, CENTIMETERS-公制) |
| 2.7.2.9 | msku | msku | string | — | Optional | msku |
| 2.7.2.10 | parentAsin | 父asin | string | — | Optional | 父asin |
| 2.7.2.11 | prepCategory | 预处理类别 | string | — | Optional | 预处理类别 |
| 2.7.2.12 | prepOwner | 预处理提供方(AMAZON | string | — | Optional | 预处理提供方(AMAZON,SELF) |
| 2.7.2.13 | productName | 品名 | string | — | Optional | 品名 |
| 2.7.2.14 | quantityInBox | 单箱数量 | string | — | Optional | 单箱数量 |
| 2.7.2.15 | receivedQuantity | 签收量 | number | — | Optional | 签收量 |
| 2.7.2.16 | sku | sku | string | — | Optional | sku |
| 2.7.2.17 | title | 标题 | string | — | Optional | 标题 |
| 2.7.2.18 | url | 图片url | string | — | Optional | 图片url |
| 2.7.2.19 | weight | 箱子重量 | number | — | Optional | 箱子重量 |
| 2.7.2.20 | weightUnit | 重量单位(POUNDS-磅 | string | — | Optional | 重量单位(POUNDS-磅,KILOGRAMS-千克) |
| 2.7.2.21 | width | 箱子宽 | number | — | Optional | 箱子宽 |
| 2.7.3 | awdShippingAddressBO | 发货地址 | object | — | Optional | 发货地址 |
| 2.7.3.1 | addressLine1 | 发货地址-详细街道地址1 | string | — | Optional | 发货地址-详细街道地址1 |
| 2.7.3.2 | addressLine2 | 发货地址-详细街道地址2 | string | — | Optional | 发货地址-详细街道地址2 |
| 2.7.3.3 | city | 发货地址-城市 | string | — | Optional | 发货地址-城市 |
| 2.7.3.4 | countryCode | 发货地址-国家(地区) | string | — | Optional | 发货地址-国家(地区) |
| 2.7.3.5 | phoneNumber | 发货地址-电话号码 | string | — | Optional | 发货地址-电话号码 |
| 2.7.3.6 | postalCode | 发货地址-邮箱编码 | string | — | Optional | 发货地址-邮箱编码 |
| 2.7.3.7 | shipperName | 发货地址-发货方名称 | string | — | Optional | 发货地址-发货方名称 |
| 2.7.3.8 | stateOrProvinceCode | 发货地址-州/省/地区编码 | string | — | Optional | 发货地址-州/省/地区编码 |
| 2.7.3.9 | zone | 发货地址-区 | string | — | Optional | 发货地址-区 |
| 2.7.4 | carrierCode | 承运方式 | string | — | Optional | 承运方式 |
| 2.7.5 | createByName | 创建人名称 | string | — | Optional | 创建人名称 |
| 2.7.6 | gmtCreate | 创建时间 | string | — | Optional | 创建时间 |
| 2.7.7 | gmtModified | 更新时间 | string | — | Optional | 更新时间 |
| 2.7.8 | orderId | AWD入库任务号 | string | — | Optional | AWD入库任务号 |
| 2.7.9 | stockOrderId | 备货单号 | string | — | Optional | 备货单号 |
| 2.7.10 | remark | 备注 | string | — | Optional | 备注 |
| 2.7.11 | shipBy | 发货时间 | string | — | Optional | 发货时间 |
| 2.7.12 | sid | 领星店铺ID | integer | — | Optional | 领星店铺ID |
| 2.7.13 | status | 货件状态 | string | — | Optional | 货件状态:CREATED:已创建;SHIPPED:已发货;IN_TRANSIT:运输中;RECEIVING:接收中;DELIVERED:已送达;CLOSED:已关闭;CANCELLED:已取消 |
| 2.7.14 | trackingId | 跟踪编码 | string | — | Optional | 跟踪编码 |
| 2.7.15 | warehouseReferenceId | warehouseReferenceId | string | — | Optional | referenceId |
| 2.7.16 | destinationShipperName | 物流中心编码 | string | — | Optional | 物流中心编码 |
| 2.8 | searchCount | searchCount | boolean | — | Optional | |
| 2.9 | size | size | integer | — | Optional | |
| 2.10 | total | total | integer | — | Optional | |
| 3 | message | 提示信息 | string | — | Optional | 提示信息 |
| 4 | error_details | 错误信息 | array<any> | — | Optional | 错误信息 |
| 5 | request_id | 请求链路id | array<any> | — | Optional | 请求链路id |
| 6 | response_time | 响应时间 | string | — | Optional | 响应时间 |
The 查询AWD入库货件列表 API (/amzStaServer/openapi/awd/inbound-shipment/page) of 领星ERP is curated by the API asset management module of the Qeasy Cloud data integration platform and kept in sync with 领星ERP version updates.
Qeasy ships with prebuilt adaptation for this API — contact us to start configuring data integration.