包裹 - Help for ShipSage

端点

方法	端点	描述
GET	/api/v202105/shippings	获取包裹列表

头部

键	值
Authorization	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi ...

GET /api/v202105/shippings

请求

参数

类型	名称	描述	必填/选填	数据结果
query	api	API 类型可用值: index.by-default	必填	enum
query	next_token	下一页数据的秘钥	选填	string
query	trx_id	ShipSage 系统内部订单编号	选填	string
query	platform_order_id	平台订单号	选填	string
query	customer_order_id	客户订单号	选填	string
query	account_id	店铺 ID	选填	integer
query	account_name	店铺名称	选填	string
query	create_time_start	包裹创建时间开始时区：太平洋标准时间	选填	datetime
query	create_time_end	包裹创建时间结束时区：太平洋标准时间	选填	datetime
query	update_time_start	包裹更新时间开始时区：太平洋标准时间	选填	datetime
query	update_time_end	包裹更新时间结束时区：太平洋标准时间	选填	datetime

键	值
errcode	0/4000
errmsg	ok/Error Info
data	Data Properties

Data Properties

名称	描述	数据结果
shipping_id	ShipSage 系统内部包裹编号	integer
carrier	发货渠道; 例如: UPS, USPS, DHL, FedEx...	string
service_type_name	物流承运商例如： UPS Ground, UPS Sure Post, Fedex Ground Home Delivery, Fedex Ground...	string
warehouse_name	发货仓库名称	string
tracking_number	跟踪号	string
is_reship	是否重新发货可用值: 0:否, 1:是	enum
length	包裹长度（inch）	double
width	包裹宽度（inch）	double
height	包裹高度（inch）	double
weight_lb	包裹重量（磅）	integer
weight_oz	包裹重量（盎司）	integer
ship_to_name	收件人姓名	string
ship_to_address1	收件人街道地址1	string
ship_to_address2	收件人街道地址2	string
ship_to_phone	收件人电话	string
ship_to_city	收件人城市	string
ship_to_state	收件人州/省	string
ship_to_country	收件人国家	string
ship_to_postal_code	收件人邮编	string
status	包裹状态可用值: CREATED：已创建, PICKED：已拣货, PACKED：已打包, FINAL SCANNED：已发货， UNFULFILLABLE：无法发货， VOIDED：已作废， PENDING：待定， SYNCED：已从OMS同步到WMS	enum
final_scan_time	仓库最终扫描时间时区:太平洋标准时间	datetime
shipping_fee_estimated	预估运费	double
shipping_fee	实际运费	double
handling_fee	处理费	double
packing_material_fee	包材费	double
create_time	The shipping 包裹创建时间时区：太平洋标准时间	datetime
update_time	The shipping 包裹更新时间时区：太平洋标准时间	datetime
detail_items	包裹明细	array
detail_items.*.shipping_id	ShipSage 系统内部包裹编号	integer
detail_items.*.trx_id	ShipSage 系统内部订单编号	string
detail_items.*.platform_order_id	平台订单号	string
detail_items.*.customer_order_id	客户订单号	string
detail_items.*.account_id	店铺 ID	string
detail_items.*.account_name	店铺名称	string
detail_items.*.product_id	integer
detail_items.*.sk	integer
detail_items.*.customer_sku	客户的 sku 编码	string
detail_items.*.product_name	产品名称	string
detail_items.*.qty	发货数量	integer

返回示例

[
    {
        "shipping_id": 5639864,
        "carrier": "UPS",
        "service_type_name": "UPS Ground",
        "warehouse_id": 101,
        "warehouse_name": "Tracy",
        "tracking_number": "1Z3Y4R930398123456",
        "is_reship": 0,
        "length": 46,
        "width": 18,
        "height": 5,
        "weight": 14300,
        "weight_lb": 31,
        "weight_oz": 8.4,
        "ship_to_name": "Elijah Sanchez",
        "ship_to_address1": "2117 KENTUCKY ST",
        "ship_to_address2": null,
        "ship_to_phone": "16026716610",
        "ship_to_city": "BAKERSFIELD",
        "ship_to_state": "CA",
        "ship_to_country": "US",
        "ship_to_postal_code": "93305",
        "status": "CREATED",
        "create_time": "2022-03-06 02:05:03",
        "update_time": "2022-03-06 02:05:03",
        "detail_items": [
            {
                "shipping_id": 5639864,
                "trx_id": "SS10-PON-001",
                "platform_order_id": "PON-001",
                "customer_order_id": "CON-001",
                "account_id": 123,
                "account_name": "TestAccount01",
                "product_id": 111864,
                "sku": 209582,
                "customer_sku": "209582",
                "product_name": "1 Set Matte Black Metal Clothing Rack V2S_Racks,Shelves&Drawers",
                "qty": 1
            }
        ]
    },
    {
        "shipping_id": 5639863,
        "carrier": "UPS",
        "service_type_name": "UPS Sure Post",
        "warehouse_id": 103,
        "warehouse_name": "Southaven",
        "tracking_number": "1Z3Y4R930398123457",
        "is_reship": 0,
        "length": 13,
        "width": 10,
        "height": 2,
        "weight": 1300,
        "weight_lb": 2,
        "weight_oz": 13.9,
        "ship_to_name": "Elijah Sanchez",
        "ship_to_address1": "2117 KENTUCKY ST",
        "ship_to_address2": null,
        "ship_to_phone": "16026716610",
        "ship_to_city": "BAKERSFIELD",
        "ship_to_state": "CA",
        "ship_to_country": "US",
        "ship_to_postal_code": "93305",
        "status": "CREATED",
        "create_time": "2022-03-06 02:05:03",
        "update_time": "2022-03-06 02:05:03",
        "detail_items": [
            {
                "shipping_id": 5639863,
                "trx_id": "SS10-PON-001",
                "platform_order_id": "PON-001",
                "customer_order_id": "CON-001",
                "account_id": 123,
                "account_name": "TestAccount01",
                "product_id": 111804,
                "sku": 209522,
                "customer_sku": "209522",
                "product_name": "46\"x17.3\"x68.9\" Blue Cover with box for V2S,V7,V30_Racks,Shelves&Drawers",
                "qty": 1
            }
        ]
    }
]

包裹

端点#

头部#

GET /api/v202105/shippings#

请求#

参数#

返回#

Data Properties#

返回示例#

端点

头部

GET /api/v202105/shippings

请求

参数

返回

Data Properties

返回示例