Lingxing
切换旧版

查询WFS货件列表

POST/cepf/warehouse/api/openApi/queryWFSCargoPage

接口信息

API Path请求协议请求方式令牌桶容量
/cepf/warehouse/api/openApi/queryWFSCargoPageHTTPSPOST10

请求参数

store_idarray<any>
店铺id
cargo_status_listarray<any>
货件平台状态:
0 PENDING_SHIPMENT_DETAILS
1 AWAITING_DELIVERY
2 RECEIVING_IN_PROGRESS
3 CLOSED
4 CANCELLED
inbound_order_idstring
入库订单编号
start_timestring
开始时间【创建时间】,格式:Y-m-d,双闭区间
end_timestring
结束时间【创建时间】,格式:Y-m-d,双闭区间
offsetinteger
分页偏移量,默认0
lengthinteger
分页长度,默认15,上限200
update_time_gestring
货件更新开始时间,格式:yyyy-MM-dd HH:mm:SS
update_time_lestring
货件更新结束时间,格式:yyyy-MM-dd HH:mm:SS
cargo_update_time_gestring
货件平台更新时间开始 格式:yyyy-MM-dd HH:mm:ss
cargo_update_time_lestring
货件平台更新时间结束 格式:yyyy-MM-dd HH:mm:ss

请求示例

{
    "store_id": [
        "110418202566107648",
        "11098710969430528"
    ],
    "cargo_status_list": [1,2,3,4],
    "inbound_order_id": "lkxxxxxx555",
    "start_time": "2023-07-15",
    "end_time": "2023-07-16",
    "offset": 0,
    "length": 15
}

返回结果

Json Object

codeinteger必填
状态码,0 成功
示例 0
messagestring必填
消息提示
示例 success
error_detailsarray<any>必填
错误信息
request_idstring必填
请求链路id
示例 f4044649b1be46398c7eb4e6eb6ab6d5.1684735739946
response_timestring必填
响应时间
示例 2023-05-06 23:59:59
dataobject必填
响应数据
隐藏子属性
totalstring必填
总数
示例 15
recordsarray<object>必填
列表数据
隐藏子属性
idstring必填
WFS货件id
示例 200498
cargo_codestring必填
货件单号
示例 lry-shipment-31
cargo_create_datestring必填
货件创建时间
示例 2023-05-06 23:59:59
cargo_good_listarray<object>必填
商品信息
隐藏子属性
declare_numstring必填
货件初始申报量
示例 10
gtinstring必填
GTIN码
示例 gtin
mskustring必填
msku
示例 mskuxxx
product_namestring必填
品名
示例 ueeshop222bt
received_numstring必填
签收数量
示例 10
shipments_numstring必填
已发货数量
示例 10
skustring必填
sku
示例 sku
dameged_qtystring必填
损坏数量
cargo_statusstring必填
平台货件状态
示例 PENDING_SHIPMENT_DETAILS
cargo_sync_statusstring必填
货件本地状态
示例 已申报
country_namestring必填
国家
示例 美国
creatorstring必填
创建者
示例 王xxx
distribution_addressesstring必填
配送地址(街道,城市,省/区,国家,国家编码,邮编)拼接
示例 xxxxxxx
in_bound_order_idstring必填
入库订单编号
示例 lry-inbound-31
logistics_codestring必填
物流编号
示例 LRY03
return_addressesstring必填
退货地址(街道,城市,省/区,国家,国家编码)拼接)
示例 xxxxxxx
store_idstring必填
店铺id
示例 110000000020008001
store_namestring必填
店铺名称
示例 测试店铺
shipping_list_codesarray<any>必填
发货单号
示例 ["SP202307250010002","SP202307250010001"]
update_datestring必填
更新时间
示例 2023-05-06 23:59:59
statusinteger必填
货件状态:
0 PENDING_SHIPMENT_DETAILS (等待发货详情) , 表示系统正在等待发货的详细信息
1 AWAITING_DELIVERY (等待送达) ,表示货物已发出,正在等待送达
2 RECEIVING_IN_PROGRESS (接收中) , 表示货物正在被接收处理中
3 CLOSED (已关闭) , 表示物流过程已完成并关闭
4 CANCELLED (已取消) , 表示物流过程已被取消
status_namestring必填
货件状态说明
to_pending_timestring必填
更新为Pending Shipment Details状态的时间戳
to_await_timestring必填
更新为Awaiting Delivery状态的时间戳
to_receive_timestring必填
更新Receiving in Progress状态的时间戳
to_closed_timestring必填
更新为CLOSED状态的时间戳
to_cancelled_timestring必填
更新为Cancelled状态的时间戳

返回成功示例

{
    "code": 0,
    "message": "success",
    "error_details": [],
    "request_id": "c4db3691436d4acbbda0f8b1dc53fe97.1689845618385",
    "response_time": "2023-07-20 17:33:39",
    "data": {
        "total": "1",
        "records": [
            {
                "id": "200498",
                "in_bound_order_id": "test0508001-inbound-1",
                "store_id": "110000000018008001",
                "store_name": "测试店铺",
                "country_name": "美国",
                "creator": "",
                "shipping_list_codes": [
                    "SP202307270010196"
                ],
                "logistics_code": "LRY03",
                "cargo_create_date": "2023-03-08 03:02:30",
                "cargo_code": "test0508001-shipment-1",
                "update_date": "2023-05-08 11:20:52",
                "cargo_status": "PENDING_SHIPMENT_DETAILS",
                "cargo_sync_status": "已申报",
                "distribution_addresses": "3 Sorbello Way,Pedricktown1,NJ9,美国,US,08067",
                "return_addresses": "860 W California Ave,Sunnyvale,94086,加拿大,CA",
                "cargo_good_list": [
                    {
                        "msku": "test1_sku1CIlPbdpXO1",
                        "sku": "ueeshop1111",
                        "product_name": "ueeshop1111",
                        "gtin": "006344827368521",
                        "shipments_num": "0",
                        "received_num": "0",
                        "declare_num": "10",
			            "dameged_qty":"0"
                    }
                ]
            }
        ]
    }
}

返回失败示例

{
    "code": 1,
    "message": "参数检验不通过",
    "error_details": ["length: length 最大值200"],
    "request_id": "f4044649b1be46398c7eb4e6eb6ab6d5.1684735739946",
    "response_time": "2023-05-22 14:08:59",
    "data": null
}