1. 接口
Help for ShipSage
  • 中文版 V2.0
    • 接口集成
      • OMS API
        • 入门指南
        • 接口
          • 店铺
          • 仓库
          • 产品
          • 库存
          • 订单
          • 包裹
          • 物流跟踪
          • 发货计划
          • 转运
          • 增值服务
          • 退货
          • 文件上传
  • English V2.0
    • API Integration
      • OMS API
        • Getting Started
        • APIs
          • Account
          • Warehouse
          • Product
          • Inventory
          • Order
          • Shipping
          • Tracking
          • ASN
          • Transfer
          • VAS
          • Return
          • File Upload
  1. 接口

订单

端点#

方法端点描述
GET/api/v202105/orders获取订单列表
POST/api/v202105/orders创建订单
POST/api/v202105/orders取消订单

头部#

键值
AuthorizationBearer eyJ0eXAiOiJKV1QiLCJhbGciOi ...

GET /api/v202105/orders#

请求#

参数#
类型名称描述必填/选填数据结构
queryapiAPI 类型

可用值:
index.by-default		必填enum
querynext_token下一页数据的秘钥选填string
queryplatform_order_id平台订单号选填string
querycustomer_order_id客户订单号选填string
queryaccount_id店铺 id选填integer
queryaccount_name店铺名称选填string
querycreate_time_start订单创建时间 开始 时区：太平洋标准时间选填datetime
querycreate_time_end订单创建时间 结束 时区：太平洋标准时间选填datetime
queryupdate_time_start订单更新时间 开始 时区：太平洋标准时间选填datetime
queryupdate_time_end订单更新时间 结束 时区：太平洋标准时间选填datetime
querystatus订单状态

可用值:
Synced：已同步,
To Be Confirmed：待确认,
Confirmed：已确认,
Processing：处理中,
Cancelled：已取消,
Fulfillment：仓库处理完成,
Shipped：已发货		选填（如果status参数填写了，则create_time_start参数必填）enum

返回#

键值
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
名称描述数据结构
trx_idShipSage 系统内部订单编号string
platform_order_id平台订单号string
customer_order_id客户订单号string
account_name店铺名称string
order_time订单创建时间 时区：太平洋标准时间datetime
paid_time订单付款时间 时区：太平洋标准时间datetime
shipped_time订单发货时间 时区：太平洋标准时间 如果订单有多个包裹，则取最早的那个包裹的发货时间datetime
ship_to_name收件人姓名string
ship_to_address1收件人街道地址1string
ship_to_address2收件人街道地址2string
ship_to_phone收件人电话string
ship_to_city收件人城市string
ship_to_state收件人州/省string
ship_to_country收件人国家string
ship_to_postal_code收件人邮编string
selling_sku销售sku 编码string
customer_sku客户的 sku 编码string
item_idShipSage 系统内部 listing idstring
title订单抬头string
quantity订单数量integer
status订单状态

可用值:
Synced：已同步,
To Be Confirmed：待确认,
Confirmed：已确认,
Processing：处理中,
Cancelled：已取消,
Fulfillment：仓库处理完成,
Shipped：已发货		enum
create_time订单创建时间 时区：太平洋标准时间datetime
update_time订单更新时间 时区：太平洋标准时间datetime
返回示例#
[
    {
        "trx_id": "33693018972994",
        "platform_order_id": null,
        "customer_order_id": null,
        "account_名称": "PartsSquare",
        "created_date": "2022-03-02 20:31:36",
        "paid_time": "2022-03-03 07:09:43",
        "shipped_time": "2022-03-03 13:09:43",
        "ship_to_名称": "Joseph Rothwell",
        "ship_to_address1": "7550 N 12TH ST APARTMENT # 121",
        "ship_to_address2": null,
        "ship_to_phone": null,
        "ship_to_city": "PHOENIX",
        "ship_to_state": "AZ",
        "ship_to_country": "US",
        "ship_to_postal_code": "85020-4563",
        "seller_sku": "130798",
        "customer_sku": "130798",
        "item_id": "0622QSWZBYK",
        "title": "AUTEX 2pcs Gray Interior Door Handle Front/Rear Left Right",
        "quantity": 1,
        "status": "Synced",
        "create_time": "2022-03-03 01:00:28",
        "update_time": "2022-03-03 02:00:33"
    },
    {
        "trx_id": "33693018972994",
        "platform_order_id": null,
        "customer_order_id": null,
        "account_名称": "PartsSquare",
        "created_date": "2022-03-02 20:31:36",
        "paid_time": "2022-03-03 07:09:43",
        "ship_to_名称": "Joseph Rothwell",
        "ship_to_address1": "7550 N 12TH ST APARTMENT # 121",
        "ship_to_address2": null,
        "ship_to_phone": null,
        "ship_to_city": "PHOENIX",
        "ship_to_state": "AZ",
        "ship_to_country": "US",
        "ship_to_postal_code": "85020-4563",
        "seller_sku": "F-130798",
        "customer_sku": "130798",
        "item_id": "0622QSWZBYK",
        "title": "AUTEX 2pcs Gray Interior Door Handle Front/Rear Left Right",
        "quantity": 1,
        "status": "Synced",
        "create_time": "2022-03-03 01:00:28",
        "update_time": "2022-03-03 02:00:33"
    }
]

POST /api/v202105/orders#

请求#

参数#
类型名称描述必填/选填数据结构
queryapiAPI 类型
可用值:
index.by-default		必填enum
bodyaccount_name店铺名称必填string
bodyplatform_order_id平台订单号必填string
bodycustomer_order_id客户订单号选填string
bodyorder_time订单创建时间 时区：太平洋标准时间必填datetime
bodypaid_time订单付款时间 时区：太平洋标准时间必填datetime
bodyship_to_name收件人姓名必填string
bodyship_to_address1收件人街道地址1必填string
bodyship_to_address2收件人街道地址2选填string
bodyship_to_phone收件人电话必填string
bodyship_to_city收件人城市必填string
bodyship_to_state收件人州/省必填string
bodyship_to_country收件人国家必填string
bodyship_to_postal_code收件人邮编必填string
bodyplatform订单的平台选填string
bodywarehouse_id订单发货仓库
可用值:

100: SG-MDW1(Bolingbrook);
101: SG-SMF1(Tracy);
103: SG-MEM1(Southaven);
109: SG-ABE1(Allentown);
112: SG-ATL1 (ShipSage-ATL1);
113: SG-ONT1(Ontario);
114: SG-ONT2(Corona);
116: SG-IAH1(Houston);
117: SG-ONT3(Jurupa Valley);
118:SG-IAH2(Houston);
119:SG-ONT4;
120:SG-SAV1;
130:SG-ONT5		选填string
bodylatest_ship_date最晚发货时间选填date
bodycarrier发货渠道;
例如: UPS, USPS, DHL, FedEx...		选填string
bodycarrier_service物流承运商
例如： UPS Ground, UPS Sure Post, Fedex Ground Home Delivery, Fedex Ground...		选填string
bodyprime是否SFP订单，默认0（如果是SFP订单则会加急处理，订单处理费会更高）:
可用值
0：否
1：是		选填integer
bodyshipping_items面单详情，平台面单或者客户自己的面单可以通过这个对象传参，如果不传此对象，则表示有shipSage 产生面单选填shipping_items
bodyproduct_items订单的产品集必填array
bodyproduct_items.*.selling_sku销售sku 编码必填string
bodyproduct_items.*.quantitysku 数量必填integer
bodyproduct_items.*.unit_pricesku 单价选填double
bodyproduct_items.*.order_item_id订单明细id选填string
shipping_items
类型名称描述必填/选填数据结构
bodypacking_slip装运装箱单附件选填array
bodybol提货单附件选填array
bodylabels面单数据必填array
bodylabels.*.tracking_number跟踪号必填string
bodylabels.*.shipping_carrier发货渠道;
例如: UPS, USPS, DHL, FedEx...
"传了则优先使用；未传时系统按 tracking_number 自动识别；识别失败时用顶层 carrier"		选填string
bodylabels.*.shipping_method物流承运商
例如： UPS Ground, UPS Sure Post, Fedex Ground Home Delivery, Fedex Ground...
"传了则优先使用；未传时按 tracking_number 自动识别；识别失败时用顶层 carrier_service"		选填string
bodylabels.*.with_packing_slip是否合并 PDF。true 时表示 labels.*.url 是"面单 + 装箱单 "合成的多页 PDF；系统会按物理页拆分：Page 1 → 面单、Page 2 → 装箱单。当为true 时不传 packing_slip.url。选填boolean
bodylabels.*.url面单url url； 和 base64 必须传一个选填string
bodylabels.*.base64面单文件 base64； url 和 base64 必须传一个选填base64
bodylabels.*.details包裹明细必填array
bodylabels.*.details.selling_sku包裹明细中的销售 sku 编码必填string
bodylabels.*.details.quantity包裹明细中的 sku 数量必填integer
Body Demo#
{
    "account_name":"ShipSageTest",
    "platform_order_id":"PON-01",
    "customer_order_id":"CON-01",
    "order_time":"2023-01-14 18:12:34",
    "paid_time":"2023-01-14 14:23:32",
    "ship_to_name":"Jackson",
    "ship_to_address1":"address_1",
    "ship_to_address2":"address_2",
    "ship_to_phone":"1234567890",
    "ship_to_city":"City名称",
    "ship_to_state":"State",
    "ship_to_country":"Country",
    "ship_to_postal_code":"1111",
    "platform":"Wayfair",
    "warehouse_id":"100",
    "shipping_items":{
        "packing_slip": {
            "url": "https:/ss..."
        },
        "bol": {
            "url": "https:/SS...."
        },
        "labels":
        [
            {
                "tracking_number": "111",
                "shipping_carrier": "UPS",
                "shipping_method":"UPS Ground",
                "url": "https://www.XXXXX.com/xx1.PDF",
                "base64":"",
                "details": [
                    {
                        "selling_sku":"Test-100001",
                        "quantity": "1"
                    }
                ]
            },
            {
                "tracking_number": "111",
                "shipping_carrier": "UPS",
                "shipping_method":"UPS Ground",
                "url": "",
                "base64":"JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZS...",
                "details": [
                    {
                        "selling_sku":"Test-100001",
                        "quantity": "1"
                    }
                ]
            }
        ]
    }
    "product_items":
    [
        {
            "selling_sku":"Test-100001",
            "quantity": "1",
            "unit_price": "101",
            "order_item_id": "166527415163201"
        }
    ]
}

返回#

键值
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
名称描述数据结构
account_name店铺名称string
platform_order_id平台订单号string
customer_order_id客户订单号string
order_time订单创建时间 时区：太平洋标准时间datetime
paid_time订单付款时间 时区：太平洋标准时间datetime
ship_to_name收件人姓名string
ship_to_address1收件人街道地址1string
ship_to_address2收件人街道地址2string
ship_to_phone收件人电话string
ship_to_city收件人城市string
ship_to_state收件人州/省string
ship_to_country收件人国家string
ship_to_postal_code收件人邮编string
trx_itemsShipSage 系统内部订单明细array
trx_items.*.trx_idShipSage 系统内部订单编号string
trx_items.*.item_idShipSage 系统内部listing编号string
trx_items.*.order_id平台订单编号string
trx_items.*.account_name店铺名称string
trx_items.*.selling_sku销售sku 编码string
trx_items.*.product_name销售sku 名称string
trx_items.*.quantitysku 数量integer
trx_items.*.unit_pricesku 单价double
返回示例#
{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "account_name": "account1",
        "platform_order_id": "23432342341",
        "customer_order_id": null,
        "order_time": "2026-01-20T00:00:00",
        "ship_to_name": "1",
        "ship_to_phone": "1",
        "ship_to_address1": "1",
        "ship_to_address2": null,
        "ship_to_city": "1",
        "ship_to_state": "1",
        "ship_to_country": "1",
        "ship_to_postal_code": "1",
        "trx_items": [
            {
                "trx_id": "AMA-SA-1897-295455-23432342341",
                "item_id": "YYM-295455-202502-1",
                "order_id": "23432342341",
                "account_name": "account1",
                "quantity": 1,
                "unit_price": 1,
                "selling_sku": "TEST1",
                "product_name": "TEST1"
            }
        ]
    }
}

POST /api/v202105/orders#

请求#

参数#
类型名称描述必填/选填数据结构
queryapiAPI 类型

可用值:
store.by-cancel-order		必填enum
bodyplatform_order_id平台订单号,平台订单号和客户订单号至少要传一个选填string
bodycustomer_order_id客户订单号,平台订单号和客户订单号至少要传一个选填string
Body Demo#
{
  
      "platform_order_id": "PON-01"
}

返回#

键值
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
名称描述数据结构
trx_idShipSage 系统内部订单编号string
account_name店铺名称string
platform_order_id平台订单号string
customer_order_id客户订单号string
返回示例#
{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "trx_id": "YC-PON-01-310001",
      "account_名称": "ShipSageTest",
      "platform_order_id": "PON-01",
      "customer_order_id": "CON-01"
    },
    {
      "trx_id": "YC-PON-01-310002",
      "account_名称": "ShipSageTest",
      "platform_order_id": "PON-01",
      "customer_order_id": "CON-01"
    }
  ]
}

#

Modified at 2026-10-21 01:47:38
Previous
库存
Next
包裹
Built with