Lingxing
切换旧版

查询货件列表

POST/erp/sc/data/fba_report/shipmentList

支持查询FBA货件,对应系统【FBA】>【FBA货件】数据

接口信息

API Path请求协议请求方式令牌桶容量
/erp/sc/data/fba_report/shipmentListHTTPSPOST1

请求参数

sidstring必填
店铺id,多个以英文逗号分隔 ,对应查询亚马逊店铺列表接口对应字段【sid】
start_datestring必填
货件创建开始日期,格式:Y-m-d,左闭右开
end_datestring必填
货件创建截止日期,格式:Y-m-d,左闭右开
offsetinteger
分页偏移量,默认0
lengthinteger
分页长度,默认1000
shipment_idstring
货件单号,多个以英文逗号隔开,仅支持精确搜索
shipment_statusstring
货件状态,多个以英文逗号分隔:
UNCONFIRMED
IN_TRANSIT
DELIVERED
CHECKED_IN
ABANDONED

DELETED
CLOSED
CANCELLED
WORKING
RECEIVING
SHIPPED
READY_TO_SHIP
extra_date_fieldstring
根据start_extra_date和end_extra_date日期范围查询:
update 货件修改日期【默认值为update,目前只支持查询货件修改日期】
start_extra_datestring
开始日期,格式:Y-m-d,左闭右开
end_extra_datestring
结束日期,格式:Y-m-d,左闭右开

请求cURL示例

curl --location 'https://openapi.lingxing.com/erp/sc/data/fba_report/shipmentList?access_token=value&timestamp=value&sign=value&app_key=value' \
--header 'Content-Type: application/json' \
--data '{
    "end_date": "2024-10-10",
    "offset": 0,
    "length": 100,
    "sid": "10",
    "start_date": "2024-04-01"
}'

返回结果

Json Object

参数名说明必填类型示例
code状态码,0 成功是[int]0
message消息提示是[string]success
error_details错误信息是[array]
request_id请求链路id是[string]C3D9F541-8083-E376-EB5C-606A872F5C89
response_time响应时间是[string]2020-05-18 11:23:47
total总数是[int]1
data响应数据是[object]
data>>list数据列表是[array]
data>>list>>id唯一记录id是[int]10407
data>>list>>sid店铺id是[int]2
data>>list>>seller店铺名称是[string]
data>>list>>uid创建人id是[int]
data>>list>>username创建人姓名是[string]
data>>list>>shipment_id亚马逊货件编号是[string]
data>>list>>shipment_name货件名称是[string]FBA (13/08/2020, 02:58) - 1
data>>list>>sta_shipment_id亚马逊货件id(sta货件时返回)是[string]
data>>list>>sta_inbound_plan_id亚马逊货件编号(sta货件时返回)是[string]
data>>list>>sta_plan_nameSTA任务名称(sta货件时返回)是[string]
data>>list>>is_closed是否是已完成状态:0 进行中,1 已完成是[int]1
data>>list>>shipment_status状态:
WORKING:卖家已创建货件,但尚未发货
SHIPPED:承运人已取件
IN_TRANSIT:承运人已通知亚马逊配送中心,知晓货件的存在
DELIVERED:承运人已将货件配送至亚马逊配送中心
CHECK_IN:货件已在亚马逊配送中心的收货区域登记
RECEIVING:货件已到达亚马逊配送中心,但有部分商品尚未标记为已收到
CLOSED:货件已到达亚马逊配送中心,且所有商品已标记为已收到
CANCELLED:卖家在将货件发送至亚马逊配送中心后取消了货件
DELETE:卖家在将货件发送至亚马逊配送中心前取消了货件
ERROR:货件出错,但其并非亚马逊处理
是[string]CLOSED
data>>list>>gmt_modified数据更新时间是[string]2020-10-11 10:59
data>>list>>gmt_create数据创建时间是[string]2020-08-13 23:25
data>>list>>sync_time同步时间【已废弃】是[string]2020-10-11 10:59
data>>list>>destination_fulfillment_center_id物流中心编码是[string]BHX1
data>>list>>is_synchronous是否erp创建:0 erp创建,1 亚马逊后台同步是[int]1
data>>list>>is_uploaded_box是否已上传装箱信息:0 未上传,1 已上传是[int]0
data>>list>>is_sta是否sta货件:0 否,1 是是[int]0
data>>list>>shipping_mode货件类型(GROUND_SMALL_PARCEL 小包裹快递(SPD)、FREIGHT_LTL 汽运零担(LTL))是[string]
data>>list>>shipping_solution承运人(USE_YOUR_OWN_CARRIER 其他承运人、AMAZON_PARTNERED_CARRIER 亚马逊合作承运人)是[string]
data>>list>>alpha_code承运方式编码是[string]
data>>list>>alpha_name承运方式名称是[string]
data>>list>>sta_shipment_date发货日期 格式:yyyy-MM-dd是[string]
data>>list>>sta_delivery_start_date送达时段-开始时间 格式:yyyy-MM-dd HH:mm:ss是[string]
data>>list>>sta_delivery_end_date送达时段-结束时间 格式:yyyy-MM-dd HH:mm:ss是[string]
data>>list>>tracking_number_list追踪编号(SPD类型货件时返回)是[array]
data>>list>>tracking_number_list>>box_id箱号是[string]
data>>list>>tracking_number_list>>tractracking_numberkingNumber追踪编号是[string]
data>>list>>bill_of_lading_number提货单号(BOL)是[string]
data>>list>>freight_bill_number跟踪编号(PRO)是[string]
data>>list>>item_list子项数据是[array]
data>>list>>item_list>>mskuMSKU是[string]
data>>list>>item_list>>fnskuFNSKU是[string]
data>>list>>item_list>>skuSKU是[string]
data>>list>>item_list>>quantity_shipped当前申报量是[int]518
data>>list>>item_list>>init_quantity_shipped货件初始申报量是[int]518
data>>list>>item_list>>quantity_received签收数量:亚马逊配送中心已接收的商品数量是[int]511
data>>list>>item_list>>quantity_shipped_local已发货数量(本地数据)是[int]
data>>list>>item_list>>quantity_in_case每个包装箱中的商品数量是[int]37
data>>list>>item_list>>prep_details预处理明细是[string]
data>>list>>item_list>>prep_instruction预处理操作:大多数为Labeling是[string]Labeling
data>>list>>item_list>>prep_owner预处理拥有者:AMAZON,SELLER,NONE;大多数为SELLER是[string]AMAZON
data>>list>>item_list>>prep_label_owner标签类型:AMAZON,SELLER,NONE是[string]AMAZON
data>>list>>item_list>>expiration有效期是[string]
data>>list>>item_list>>prep_owner预处理拥有者:大多数为SELLER是[string]SELLER
data>>list>>item_list>>release_date生产日期是[string]
data>>list>>item_list>>ware_house_storage_id库存明细id是[int]
data>>list>>item_list>>shipment_plan_list关联的发货计划单号是[array]
data>>list>>item_list>>shipment_plan_list>>shipment_plan_sn发货计划单号是[string]
data>>list>>working_timeWORKING时间是[string]2023-04-24 11:35
data>>list>>shipped_timeSHIPPED时间是[string]2023-04-24 17:35
data>>list>>receiving_timeRECEIVING时间是[string]2023-04-24 17:35
data>>list>>closed_timeCLOSED时间是[string]2023-04-24 17:35
data>>list>>reference_idReference ID是[string]xxxxxx
data>>list>>ship_from_address发货地址是[object]
data>>list>>ship_from_address>>name名称是[string]测试发货名称
data>>list>>ship_from_address>>country_code国家编码是[string]CN
data>>list>>ship_from_address>>state_or_province_code省(州)是[string]广东省
data>>list>>ship_from_address>>city城市是[string]深圳
data>>list>>ship_from_address>>region区是[string]
data>>list>>ship_from_address>>address_line1街道地址1是[string]测试街道111
data>>list>>ship_from_address>>address_line2街道地址2是[string]
data>>list>>ship_from_address>>postal_code邮编是[string]rere2222
data>>list>>ship_from_address>>phone联系电话是[string]15966786622
data>>list>>ship_to_address配送地址是[object]
data>>list>>ship_to_address>>name名称是[string]FTW1名称
data>>list>>ship_to_address>>country_code国家编码是[string]AG
data>>list>>ship_to_address>>state_or_province_code省(州)是[string]省1
data>>list>>ship_to_address>>city城市是[string]城市1
data>>list>>ship_to_address>>region区是[string]区1
data>>list>>ship_to_address>>address_line1街道地址1是[string]地址1
data>>list>>ship_to_address>>address_line2街道地址2是[string]地址2
data>>list>>ship_to_address>>postal_code邮编是[string]123456
data>>list>>ship_to_address>>doorplate门牌号是[string]12

返回成功示例

{
    "code": 0,
    "message": "success",
    "error_details": [],
    "request_id": "1859414A-17D8-7475-EA63-781ED827DA57",
    "response_time": "2024-12-18 15:29:35",
    "data": {
        "list": [
            {
                "id": 494,
                "sid": 10,
                "uid": 0,
                "shipment_id": "",
                "shipment_name": "",
                "is_closed": 1,
                "shipment_status": "CLOSED",
                "gmt_modified": "2024-11-30 12:00",
                "gmt_create": "2024-10-09 15:22",
                "sync_time": "",
                "destination_fulfillment_center_id": "",
                "username": "",
                "seller": "",
                "item_list": [
                    
                    {
                        "id": 147819,
                        "zid": 1,
                        "msku": "",
                        "fnsku": "",
                        "quantity_shipped": 18,
                        "init_quantity_shipped": 18,
                        "quantity_received": 18,
                        "quantity_shipped_local": 18,
                        "quantity_in_case": 0,
                        "prep_details": "",
                        "prep_instruction": "",
                        "prep_owner": "",
                        "release_date": "",
                        "ware_house_storage_id": 0,
                        "shipment_plan_list": [],
                        "sku": ""
                    }
                ],
                "is_synchronous": 1,
                "is_uploaded_box": 0,
                "working_time": "2024-10-09 15:22",
                "shipped_time": "",
                "receiving_time": "2024-10-26 19:24",
                "closed_time": "2024-11-28 04:11",
                "reference_id": "",
                "ship_from_address": {
                    "name": "",
                    "country_code": "",
                    "state_or_province_code": "",
                    "city": "",
                    "region": "",
                    "address_line1": "",
                    "address_line2": "",
                    "postal_code": "",
                    "phone": ""
                },
                "ship_to_address": {
                    "name": "",
                    "country_code": "",
                    "state_or_province_code": "",
                    "city": "",
                    "region": "",
                    "address_line1": "",
                    "address_line2": "",
                    "postal_code": "",
                    "doorplate": ""
                }
            }
        ]
    },
    "total": 1
}