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/v202206/asns获取发货计划列表
POST/api/v202206/asn/products创建发货计划（sku 库存形态）
PUT/api/v202206/asn/products/{item_id}更新发货计划（sku 库存形态）
DELETE/api/v202206/asns/{itemId}取消 ASN（仅 Draft 状态可取消）
GET/api/v202206/asn-docs获取 ASN 附件列表
POST/api/v202206/asn-docs上传 ASN 附件（单个）
DELETE/api/v202206/asn-docs/{itemId}删除 ASN 附件（仅本公司上传的）
[新增] v202206 补丁（2026-09 新增）：
现有 GET /api/v202206/asns 响应新增 fees 字段（仅 Completed 状态有值）
新增 DELETE /api/v202206/asns/{itemId}：取消 ASN（仅 Draft 状态可取消）
新增 3 个附件接口：GET/POST/DELETE /api/v202206/asn-docs
以下为本次新增内容与说明。

GET /api/v202206/asns#

请求#

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

可用值:
index.by-default		必填enum
queryasn_id发货计划 ID选填integer
querywarehouse_id仓库编码选填integer
queryhandling_unit_id库存管理形态

可用值:
1:sku，2:箱子，3:托盘		选填enum
(integer)
queryshipping_method_id运输方式

可用值:
1: By Express（快递）
2: By Air（空运）
3: By Sea(FCL)（海运整柜）
7: By Truck（陆运卡车）
8:By Sea (LCL)（海运拼柜）
选填enum
(integer)
querydelivery_method_id送仓方式

可用值:
1: SPD
2: LTL
3: FTL
4: FCL		选填enum
(integer)
queryis_palletized是否打托

可用值:
0: NO
1: YES
选填enum
(integer)
querystatus发货单状态

可用值:
1:草稿（草稿）,
2:在途（在途）,
3:Open（开启）,
4:In Progress（处理中）,
5:Billing Audit（费用审核）,
6:Completed（已完成）		选填enum
(interger)
querycreated_at_from发货计划创建时间 开始 时区：太平洋标准时间选填datetime
querycreated_at_to发货计划创建时间 结束 时区：太平洋标准时间选填datetime
queryupdated_at_from发货计划更新时间 开始 时区：太平洋标准时间选填datetime
queryupdated_at_to发货计划更新时间 结束 时区：太平洋标准时间选填datetime
querynext_token下一页数据的秘钥选填string

返回#

键值
errcode0/4000
errmsgok/Error Info
dataData Properties
Data Properties#
名称描述数据结构
asn_id发货计划 IDinteger
title标题string
estimate_start_date预计最早到达日期datetime
estimate_end_date预计最晚到达日期datetime
warehouse_id收货仓库 IDinteger
warehouse_name收货仓库名称string
status发货单状态

可用值:
1:草稿（草稿）,
2:在途（在途）,
3:Open（开启）,
4:In Progress（处理中）,
5:Billing Audit（费用审核）,
6:Completed（已完成）		enum
(interger)
status_name发货单状态描述
handling_unit_id库存管理形态

可用值:
1:sku，2:箱子，3:托盘		enum
(interger)
fifo是否快进快出

可用值:
0:否, 1:是		enum
(interger)
tracking_info物流信息string
shipping_method_id运输方式

可用值:
1: By Express（快递）
2: By Air（空运）
3: By Sea(FCL)（海运整柜）
7: By Truck（陆运卡车）
8:By Sea (LCL)（海运拼柜）
enum
(interger)
delivery_method_id送仓方式

可用值:
1: SPD
2: LTL
3: FTL
4: FCL		enum
(integer)
shipping_method_name运输方式描述string
container_number货柜号string
ship_container_size集装箱尺寸

可用值:
3: Container 20 Palletized
4: Container 20 Floor Loaded
5: Container 40 Palletized
6: Container 40 Floor Loaded
7: Container 40' HQ Palletized
8: Container 40' HQ Floor Loaded
9: Container 45 Palletized
10: Container 45 Floor Loaded
11: Container 53 Palletized
12: Container 53 Floor Loaded
13: Container 20'HQ Palletized
14: Container 20'HQ Floor Loaded
15: Container 45'HQ Palletized
16: Container 45'HQ Floor Loaded
17: Container 53'HQ Palletized
18: Container 53'HQ Floor Loaded		enum
(integer)
is_palletized是否打托

可用值:
0: NO
1: YES
enum
(integer)
ship_container_size_desc货柜型号描述string
hbl提单号string
mbl主提单号string
create_time发货计划创建时间 时区：太平洋标准时间datetime
update_time发货计划最后更新时间 时区：太平洋标准时间datetime
manifest_items装箱单明细array
manifest_items.*.asn_id发货单 IDinteger
manifest_items.*.pallet_num托盘编号string
manifest_items.*.pallet_barcode托盘条码string
manifest_items.*.pallet_weight托盘重量 (kg)double
manifest_items.*.pallet_length托盘长度 (cm)double
manifest_items.*.pallet_width托盘宽度 (cm)double
manifest_items.*.pallet_height托盘高度 (cm)double
manifest_items.*.carton_num箱号string
manifest_items.*.carton_barcode箱子条码string
manifest_items.*.content箱子或托盘内的实物内容string
manifest_items.*.carton_weight箱子重量 (kg)double
manifest_items.*.carton_length箱子长度 (cm)double
manifest_items.*.carton_width箱子宽度 (cm)double
manifest_items.*.carton_height箱子高度 (cm)double
manifest_items.*.carton_tracking_number箱子上的跟踪号string
manifest_items.*.customer_sku客户的 sku 编码string
manifest_items.*.qty每箱的 sku 数量integer
manifest_items.*.purchase_order采购订单数量string
manifest_items.*.vendor_id供应商 IDinteger
manifest_items.*.lot_attr_01批次属性 1string
manifest_items.*.lot_attr_02批次属性 2string
manifest_items.*.lot_attr_03批次属性 3string
manifest_items.*.lot_attr_04批次属性 4string
manifest_items.*.lot_attr_05批次属性 5string
manifest_items.*.lot_attr_06批次属性 6string
manifest_items.*.lot_attr_07批次属性 7string
manifest_items.*.lot_attr_08批次属性 8string
manifest_items.*.lot_attr_09批次属性 9string
manifest_items.*.lot_attr_10批次属性 10string
manifest_items.*.lot_attr_11批次属性 11string
manifest_items.*.lot_attr_12批次属性 12string
manifest_items.*.lot_attr_13批次属性 13string
manifest_items.*.lot_attr_14批次属性 14string
manifest_items.*.lot_attr_15批次属性 15string
receiving_items发货计划的 sku 明细array
receiving_items.*.line_id收货明细 IDinteger
receiving_items.*.asn_id发货计划 IDinteger
receiving_items.*.status收货明细状态
1: Open, 2: Close		integer
receiving_items.*.skusku 编码integer
receiving_items.*.customer_sku客户的 sku 编码string
receiving_items.*.display_code产品展示码integer
receiving_items.*.qty发货数量integer
receiving_items.*.qty_defectiveThe defective qtyinteger
receiving_items.*.qty_inventory入库数量integer
receiving_items.*.lot_attr_01批次属性 1string
receiving_items.*.lot_attr_02批次属性 2string
receiving_items.*.lot_attr_03批次属性 3string
receiving_items.*.lot_attr_04批次属性 4string
receiving_items.*.lot_attr_05批次属性 5string
receiving_items.*.lot_attr_06批次属性 6string
receiving_items.*.lot_attr_07批次属性 7string
receiving_items.*.lot_attr_08批次属性 8string
receiving_items.*.lot_attr_09批次属性 9string
receiving_items.*.lot_attr_10批次属性 10string
receiving_items.*.lot_attr_11批次属性 11string
receiving_items.*.lot_attr_12批次属性 12string
receiving_items.*.lot_attr_13批次属性 13string
receiving_items.*.lot_attr_14批次属性 14string
receiving_items.*.lot_attr_15批次属性 15string
返回示例#
[
    {
        "asn_id": 17078,
        "title": "TSF-FBA-Partsam-PLN20220905 Southaven",
        "handling_unit_id": 1,
        "estimate_start_date": null,
        "estimate_end_date": "2022-09-28",
        "warehouse_id": 9,
        "warehouse_name": "Amazon-FBA_US",
        "status": 2,
        "status_name": "Shipped",
        "shipping_method_id": 1,
        "shipping_method_name": "By Express",
        "delivery_method_id": 1,
        "fifo": 0,
        "ship_container_size": null,
        "is_palletized": 0,
        "tracking_info": null,
        "container_number": null,
        "hbl": null,
        "mbl": null,
        "create_time": "2022-09-07 18:44:21",
        "update_time": "2022-09-07 18:44:21",
        "manifest_items": [],
        "receiving_items": [
          {
            "line_id": 705535,
            "asn_id": 17078,
            "status": 1,
            "customer_sku": "176085",
            "sku": 176085,
            "display_code": "",
            "qty": 19,
            "qty_defective": 0,
            "qty_inventory": null,
            "lot_attr_01": null,
            "lot_attr_02": null,
            "lot_attr_03": null,
            "lot_attr_04": null,
            "lot_attr_05": null,
            "lot_attr_06": null,
            "lot_attr_07": null,
            "lot_attr_08": null,
            "lot_attr_09": null,
            "lot_attr_10": null,
            "lot_attr_11": null,
            "lot_attr_12": null,
            "lot_attr_13": null,
            "lot_attr_14": null,
            "lot_attr_15": null
          }
        ]
      },
      {
        "asn_id": 17077,
        "title": "TSF-FBA-Partsam-PLN20220829 Tracy-2",
        "handling_unit_id": 1,
        "estimate_start_date": null,
        "estimate_end_date": "2022-09-28",
        "warehouse_id": 9,
        "warehouse_name": "Amazon-FBA_US",
        "status": 2,
        "status_name": "Shipped",
        "shipping_method_id": 1,
        "shipping_method_name": "By Express",
        "delivery_method_id": 1,
        "fifo": 0,
        "ship_container_size": null,
        "is_palletized": 0,
        "tracking_info": null,
        "container_number": null,
        "hbl": null,
        "mbl": null,
        "create_time": "2022-09-07 18:32:39",
        "update_time": "2022-09-07 18:32:39",
        "manifest_items": [],
        "receiving_items": [
          {
            "line_id": 705530,
            "asn_id": 17077,
            "status": 1,
            "customer_sku": "111880",
            "sku": 111880,
            "display_code": "",
            "qty": 7,
            "qty_defective": 0,
            "qty_inventory": null,
            "lot_attr_01": null,
            "lot_attr_02": null,
            "lot_attr_03": null,
            "lot_attr_04": null,
            "lot_attr_05": null,
            "lot_attr_06": null,
            "lot_attr_07": null,
            "lot_attr_08": null,
            "lot_attr_09": null,
            "lot_attr_10": null,
            "lot_attr_11": null,
            "lot_attr_12": null,
            "lot_attr_13": null,
            "lot_attr_14": null,
            "lot_attr_15": null
          },
          {
            "line_id": 705531,
            "asn_id": 17077,
            "status": 1,
            "customer_sku": "162259",
            "sku": 162259,
            "display_code": "",
            "qty": 12,
            "qty_defective": 0,
            "qty_inventory": null,
            "lot_attr_01": null,
            "lot_attr_02": null,
            "lot_attr_03": null,
            "lot_attr_04": null,
            "lot_attr_05": null,
            "lot_attr_06": null,
            "lot_attr_07": null,
            "lot_attr_08": null,
            "lot_attr_09": null,
            "lot_attr_10": null,
            "lot_attr_11": null,
            "lot_attr_12": null,
            "lot_attr_13": null,
            "lot_attr_14": null,
            "lot_attr_15": null
          },
          {
            "line_id": 705532,
            "asn_id": 17077,
            "status": 1,
            "customer_sku": "165903",
            "sku": 165903,
            "display_code": "",
            "qty": 89,
            "qty_defective": 0,
            "qty_inventory": null,
            "lot_attr_01": null,
            "lot_attr_02": null,
            "lot_attr_03": null,
            "lot_attr_04": null,
            "lot_attr_05": null,
            "lot_attr_06": null,
            "lot_attr_07": null,
            "lot_attr_08": null,
            "lot_attr_09": null,
            "lot_attr_10": null,
            "lot_attr_11": null,
            "lot_attr_12": null,
            "lot_attr_13": null,
            "lot_attr_14": null,
            "lot_attr_15": null
          },
          {
            "line_id": 705533,
            "asn_id": 17077,
            "status": 1,
            "customer_sku": "192087",
            "sku": 192087,
            "display_code": "",
            "qty": 4,
            "qty_defective": 0,
            "qty_inventory": null,
            "lot_attr_01": null,
            "lot_attr_02": null,
            "lot_attr_03": null,
            "lot_attr_04": null,
            "lot_attr_05": null,
            "lot_attr_06": null,
            "lot_attr_07": null,
            "lot_attr_08": null,
            "lot_attr_09": null,
            "lot_attr_10": null,
            "lot_attr_11": null,
            "lot_attr_12": null,
            "lot_attr_13": null,
            "lot_attr_14": null,
            "lot_attr_15": null
          },
          {
            "line_id": 705534,
            "asn_id": 17077,
            "status": 1,
            "customer_sku": "144139",
            "sku": 144139,
            "display_code": "",
            "qty": 9,
            "qty_defective": 0,
            "qty_inventory": null,
            "lot_attr_01": null,
            "lot_attr_02": null,
            "lot_attr_03": null,
            "lot_attr_04": null,
            "lot_attr_05": null,
            "lot_attr_06": null,
            "lot_attr_07": null,
            "lot_attr_08": null,
            "lot_attr_09": null,
            "lot_attr_10": null,
            "lot_attr_11": null,
            "lot_attr_12": null,
            "lot_attr_13": null,
            "lot_attr_14": null,
            "lot_attr_15": null
          }
        ]
      }
]

POST /api/v202206/asn/products#

请求#

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

可用值:
index.by-default		必填enum
bodyfifo是否快进快出

可用值:
0:否, 1:是		必填enum
bodywarehouse_idThe destination warehouse id

可用值:
100: SG-MDW1(Bolingbrook);
101: SG-SMF1(Tracy);
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		必填enum
(interger)
bodyestimate_start_date预计最早到达日期必填datetime
bodyestimate_end_date预计最晚到达日期必填datetime
bodystatus发货单状态 默认 1

可用值:
1:草稿
2:在途		选填enum
(interger)
bodymanifest_items装箱单明细必填array
bodymanifest_items.*.pallet_num托盘编号选填string
bodymanifest_items.*.pallet_weight托盘重量 (kg)选填double
bodymanifest_items.*.pallet_length托盘长度 (cm)选填double
bodymanifest_items.*.pallet_width托盘宽度 (cm)选填double
bodymanifest_items.*.pallet_height托盘高度 (cm)选填double
bodymanifest_items.*.carton_num箱号必填string
bodymanifest_items.*.carton_weight箱子重量 (kg)必填double
bodymanifest_items.*.carton_length箱子长度 (cm)必填double
bodymanifest_items.*.carton_width箱子宽度 (cm)必填double
bodymanifest_items.*.carton_height箱子高度 (cm)必填double
bodymanifest_items.*.carton_tracking_number箱子上的跟踪号选填string
bodymanifest_items.*.customer_sku客户的 sku 编码必填string
bodymanifest_items.*.packed_qty每箱的 sku 数量必填integer
bodymanifest_items.*.packing_standard_qty产品的标准包装数量，即产品有几件一个包装；只有系统保持标准包装标准才可以填写，否则请留空选填integer
bodymanifest_items.*.lot_attr_01批次属性 1选填string
bodymanifest_items.*.lot_attr_02批次属性 2选填string
bodymanifest_items.*.lot_attr_03批次属性 3选填string
bodymanifest_items.*.lot_attr_04批次属性 4选填string
bodymanifest_items.*.lot_attr_05批次属性 5选填string
bodymanifest_items.*.lot_attr_06批次属性 6选填string
bodymanifest_items.*.lot_attr_07批次属性 7选填string
bodymanifest_items.*.lot_attr_08批次属性 8选填string
bodymanifest_items.*.lot_attr_09批次属性 9选填string
bodymanifest_items.*.lot_attr_10批次属性 10选填string
bodymanifest_items.*.lot_attr_11批次属性 11选填string
bodymanifest_items.*.lot_attr_12批次属性 12选填string
bodymanifest_items.*.lot_attr_13批次属性 13选填string
bodymanifest_items.*.lot_attr_14批次属性 14选填string
bodymanifest_items.*.lot_attr_15批次属性 15选填string
状态为在途且shipping_method为By Express（快递）时的参数#
TypeName描述必填/选填数据结构
bodystatus发货单状态

可用值:
2:在途		必填enum
(interger)
bodyshipping_method_id运输方式 ID

可用值:
1: By Express（快递）
必填enum
(interger)
bodydelivery_method_id送仓方式 ID

可用值:
1: SPD（快递）
必填enum
(interger)
bodyis_palletized是否打托

可用值:
0: NO
必填enum
(integer)
bodytracking_info物流及跟踪号等信息必填string
状态为在途且运输方式为 By Sea(FCL)（海运整柜）时的参数#
TypeName描述必填/选填数据结构
bodystatus发货单状态

可用值:
2:在途		必填enum
(interger)
bodyshipping_method_id运输方式 ID

可用值:
3: By Sea(FCL)（海运整柜）
必填enum
(interger)
querydelivery_method_id送仓方式

可用值:
4: FCL		选填enum
(integer)
bodycontainer_number货柜号必填string
bodyship_container_size货柜型号

可用值:
3: Container 20 打托
4: Container 20 不打托
5: Container 40 打托
6: Container 40 不打托
7: Container 45 打托
8: Container 45 不打托
9: Container 40HQ 打托
10: Container 40HQ 不打托		必填enum
(interger)
bodyhbl提单号选填string
bodymbl主提单号选填string
状态为在途且运输方式为 By Truck（陆运卡车）时的参数#
TypeName描述必填/选填数据结构
bodystatus发货单状态

可用值:
2:在途		必填enum
(interger)
bodyshipping_method_id运输方式 ID

可用值:
7: By Truck（陆运卡车）
必填enum
(interger)
bodydelivery_method_id送仓方式 ID

可用值:

2:LTL（散货）
3: FTL（整车）		必填enum
(interger)
bodyis_palletized是否打托

可用值:
0: NO
1: YES
必填enum
(integer)
bodyhbl提单号， HBL 或者 MBL 或者 tracking_info 其中一个必填选填string
bodymbl主提单号 ，HBL 或者 MBL 或者 tracking_info 其中一个必填选填string
bodytracking_info物流及跟踪号等信息，HBL 或者 MBL 或者 tracking_info 其中一个必填选填string
状态为在途且shipping_method为Less Container（海运拼柜），By Air（空运）时的参数#
TypeName描述必填/选填数据结构
bodystatus发货单状态

可用值:
2:在途		必填enum
(interger)
bodyshipping_method_id运输方式 ID

可用值:
8:Less Container（海运拼柜）
2: By Air
必填enum
(interger)
bodydelivery_method_id送仓方式 ID

可用值:
1:SPD（快递）
2: LTL（散货）
必填enum
(interger)
bodyis_palletized是否打托

可用值:
0: NO
1: YES
必填enum
(integer)
bodyhbl提单号, HBL 或者 MBL 或者 tracking_info 其中一个必填， 如果是 LTL请填写选填string
bodymbl主提单号, HBL 或者 MBL 或者 tracking_info 其中一个必填，如果是 LTL请填写选填string
bodytracking_info物流及跟踪号等信息，如果是 SPD请填写选填string
请求示例#
{
  "warehouse_id": 101,
  "shipping_method_id": 3,
  "ship_container_size": 3,
  "delivery_method_id": 4,
  "estimate_start_date": "2022-08-01",
  "estimate_end_date": "2022-08-30",
  "tracking_info": "tracking info 0000",
  "fifo": 0,
  "status": 0,
  "container_number": "aaaa",
  "hbl": "",
  "mbl": "",
  "manifest_items": [
    {
      "pallet_num": 1,
      "pallet_weight": 100.5,
      "pallet_length": 20,
      "pallet_width": 20,
      "pallet_height": 20,
      "carton_num": 1,
      "carton_weight": 50,
      "carton_length": 14,
      "carton_width": 12,
      "carton_height": 10,
      "carton_tracking_number": "",
      "customer_sku": "PL-AF102-01W-VC",
      "packed_qty": 20,
      "packing_standard_qty": 0,
      "lot_attr_01": "attr01",
      "lot_attr_02": "attr02",
      "lot_attr_03": "attr03"
    },
    {
      "pallet_num": 1,
      "pallet_weight": 100.5,
      "pallet_length": 20,
      "pallet_width": 20,
      "pallet_height": 20,
      "carton_num": 2,
      "carton_weight": 50,
      "carton_length": 14,
      "carton_width": 12,
      "carton_height": 10,
      "carton_tracking_number": "",
      "customer_sku": "PL-AF102-01W-VC",
      "packed_qty": 20,
      "packing_standard_qty": 0,
      "lot_attr_01": "attr01",
      "lot_attr_02": "attr02",
      "lot_attr_03": "attr03"
    }
  ]
}

返回#

键值
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
Name描述数据结构
asn_id发货计划 IDinteger
返回示例#
{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "asn_id": 15216
  }
}

PUT /api/v202206/asn/products/{item_id}#

请求#

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

可用值:
index.by-default		必填enum
pathitem_id发货计划 ID必填integer
bodyfifo是否快进快出

可用值:
0:否, 1:是		选填enum
bodywarehouse_idThe destination warehouse id

可用值:
100: SG-MDW1(Bolingbrook);
101: SG-SMF1(Tracy);
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		选填enum
(interger)
bodyestimate_start_date预计最早到达日期选填datetime
bodyestimate_end_date预计最晚到达日期选填datetime
bodystatus状态只能从草稿状态更改为在途状态

可用值:
1:草稿
2:在途
选填enum
(interger)
bodymanifest_items装箱单明细选填array
bodymanifest_items.*.pallet_num托盘编号选填string
bodymanifest_items.*.pallet_weight托盘重量 (kg)选填double
bodymanifest_items.*.pallet_length托盘长度 (cm)选填double
bodymanifest_items.*.pallet_width托盘宽度 (cm)选填double
bodymanifest_items.*.pallet_height托盘高度 (cm)选填double
bodymanifest_items.*.carton_num箱号选填string
bodymanifest_items.*.carton_weight箱子重量 (kg)选填double
bodymanifest_items.*.carton_length箱子长度 (cm)选填double
bodymanifest_items.*.carton_width箱子宽度 (cm)选填double
bodymanifest_items.*.carton_height箱子高度 (cm)选填double
bodymanifest_items.*.carton_tracking_number箱子上的跟踪号选填string
bodymanifest_items.*.customer_sku客户的 sku 编码选填string
bodymanifest_items.*.packed_qty每箱的 sku 数量选填integer
bodymanifest_items.*.Packing_standard_qty产品的标准包装数量，即产品有几件一个包装；只有系统保持标准包装标准才可以填写，否则请留空选填integer
bodymanifest_items.*.lot_attr_01批次属性 1选填string
bodymanifest_items.*.lot_attr_02批次属性 2选填string
bodymanifest_items.*.lot_attr_03批次属性 3选填string
bodymanifest_items.*.lot_attr_04批次属性 4选填string
bodymanifest_items.*.lot_attr_05批次属性 5选填string
bodymanifest_items.*.lot_attr_06批次属性 6选填string
bodymanifest_items.*.lot_attr_07批次属性 7选填string
bodymanifest_items.*.lot_attr_08批次属性 8选填string
bodymanifest_items.*.lot_attr_09批次属性9选填string
bodymanifest_items.*.lot_attr_10批次属性 10选填string
bodymanifest_items.*.lot_attr_11批次属性 11选填string
bodymanifest_items.*.lot_attr_12批次属性 12选填string
bodymanifest_items.*.lot_attr_13批次属性 13选填string
bodymanifest_items.*.lot_attr_14批次属性 14选填string
bodymanifest_items.*.lot_attr_15批次属性 15选填string
状态为在途且shipping_method为By Express（快递）时的参数#
TypeName描述必填/选填数据结构
bodystatus发货单状态

可用值:
2:在途		必填enum
(interger)
bodyshipping_method_id运输方式 ID

可用值:
1: By Express（快递）
必填enum
(interger)
bodydelivery_method_id送仓方式 ID

可用值:
1: SPD（快递）
必填enum
(interger)
bodyis_palletized是否打托

可用值:
0: NO
必填enum
(integer)
bodytracking_info物流及跟踪号等信息必填string
状态为在途且运输方式为 By Sea(FCL)（海运整柜）时的参数#
TypeName描述必填/选填数据结构
bodystatus发货单状态

可用值:
2:在途		必填enum
(interger)
bodyshipping_method_id运输方式 ID

可用值:
3: By Sea(FCL)（海运整柜）
必填enum
(interger)
querydelivery_method_id送仓方式

可用值:
4: FCL		选填enum
(integer)
bodycontainer_number货柜号必填string
bodyship_container_size货柜型号

可用值:
3: Container 20 打托
4: Container 20 不打托
5: Container 40 打托
6: Container 40 不打托
7: Container 45 打托
8: Container 45 不打托
9: Container 40HQ 打托
10: Container 40HQ 不打托		必填enum
(interger)
bodyhbl提单号选填string
bodymbl主提单号选填string
状态为在途且运输方式为 By Truck（陆运卡车）时的参数#
TypeName描述必填/选填数据结构
bodystatus发货单状态

可用值:
2:在途		必填enum
(interger)
bodyshipping_method_id运输方式 ID

可用值:
7: By Truck（陆运卡车）
必填enum
(interger)
bodydelivery_method_id送仓方式 ID

可用值:

2:LTL（散货）
3: FTL（整车）		必填enum
(interger)
bodyis_palletized是否打托

可用值:
0: NO
1: YES
必填enum
(integer)
bodyhbl提单号， HBL 或者 MBL 或者 tracking_info 其中一个必填选填string
bodymbl主提单号 ，HBL 或者 MBL 或者 tracking_info 其中一个必填选填string
bodytracking_info物流及跟踪号等信息，HBL 或者 MBL 或者 tracking_info 其中一个必填选填string
状态为在途且shipping_method为Less Container（海运拼柜），By Air（空运）时的参数#
TypeName描述必填/选填数据结构
bodystatus发货单状态

可用值:
2:在途		必填enum
(interger)
bodyshipping_method_id运输方式 ID

可用值:
8:Less Container（海运拼柜）
2: By Air
必填enum
(interger)
bodydelivery_method_id送仓方式 ID

可用值:
1:SPD（快递）
2: LTL（散货）
必填enum
(interger)
bodyis_palletized是否打托

可用值:
0: NO
1: YES
必填enum
(integer)
bodyhbl提单号, HBL 或者 MBL 或者 tracking_info 其中一个必填， 如果是 LTL请填写选填string
bodymbl主提单号, HBL 或者 MBL 或者 tracking_info 其中一个必填，如果是 LTL请填写选填string
bodytracking_info物流及跟踪号等信息，如果是 SPD请填写选填string
请求示例#
{
  "warehouse_id": 101,
  "shipping_method_id": 2,
   "delivery_method_id": 1,
   "is_palletized": 0,
  "estimate_start_date": "2022-08-01",
  "estimate_end_date": "2022-08-30",
  "tracking_info": "tracking info 0000",
  "fifo": 0,
  "status": 0,
  "manifest_items": [
    {
      "pallet_num": "1",
      "pallet_weight": "100",
      "pallet_length": "20",
      "pallet_width": "20",
      "pallet_height": "20",
      "carton_num": "1",
      "carton_weight": "50",
      "carton_length": "14",
      "carton_width": "12",
      "carton_height": "10",
      "carton_tracking_number": "",
      "customer_sku": "PL-AF102-01W-VC",
      "packed_qty": "20",
      "packing_standard_qty": "",
      "lot_attr_01": "attr01",
      "lot_attr_02": "attr02",
      "lot_attr_03": "attr03"
    },
    {
      "pallet_num": "1",
      "pallet_weight": "100",
      "pallet_length": "20",
      "pallet_width": "20",
      "pallet_height": "20",
      "carton_num": 2,
      "carton_weight": "50",
      "carton_length": "14",
      "carton_width": "12",
      "carton_height": "10",
      "carton_tracking_number": "",
      "customer_sku": "PL-AF102-01W-VC",
      "packed_qty": "20",
      "packing_standard_qty": "",
      "lot_attr_01": "attr01",
      "lot_attr_02": "attr02",
      "lot_attr_03": "attr03"
    }
  ]
}

返回#

键值
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
Name描述数据结构
asn_id发货计划 IDinteger
返回示例#
{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "asn_id": 15216
  }
}
[新增] v202206 补丁（2026-09 新增）：
现有 GET /api/v202206/asns 响应新增 fees 字段（仅 Completed 状态有值）
新增 DELETE /api/v202206/asns/{itemId}：取消 ASN（仅 Draft 状态可取消）
新增 3 个附件接口：GET/POST/DELETE /api/v202206/asn-docs
以下为本次新增内容与说明。

GET /api/v202206/asns （获取 ASN 列表）#

本次响应新增 fees 字段，其他字段和请求参数与现有接口保持一致。

请求#

参数保持不变（asn_id / warehouse_id / handling_unit_id / shipping_method_id / status / 日期区间 / next_token 等）。
请求示例#
GET /api/v202206/asns?api=index.by-default&warehouse_id=100&status=6&create_time_from=2026-08-01%2000:00:00&create_time_to=2026-08-31%2023:59:59

返回#

新增字段#
名称描述数据结构
fees费用数组（仅 ASN 到达 Completed 状态时有值，否则为空数组）array
fees 子结构#
名称描述数据结构
fee_name费用名string
balance_type结算类型string
price单价decimal
qty数量decimal
total_fee总费用（price × qty）decimal
description描述string
返回示例（Completed 状态含 fees）#
{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "items": [
            {
                "asn_id": 88888,
                "title": "ASN-20260810-001",
                "handling_unit_id": 1,
                "estimate_start_date": "2026-08-01",
                "estimate_end_date": "2026-08-05",
                "warehouse_id": 100,
                "status": 6,
                "shipping_method_id": 1,
                "delivery_method_id": 1,
                "is_palletized": 0,
                "fifo": 1,
                "manifest_items": [ ],
                "receiving_items": [ ],
                "fees": [
                    { "fee_name": "Receiving Fee", "balance_type": "per_carton", "price": 1.50, "qty": 30, "total_fee": 45.00, "description": "Standard receiving" },
                    { "fee_name": "Putaway Fee", "balance_type": "per_sku", "price": 0.25, "qty": 120, "total_fee": 30.00, "description": "" }
                ],
                "create_time": "2026-07-30 12:00:00",
                "update_time": "2026-08-10 15:20:00"
            }
        ]
    }
}
返回示例（未完成状态 fees 为空）#
{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "items": [
            {
                "asn_id": 99999,
                "title": "ASN-20260812-002",
                "status": 1,
                "fees": []
            }
        ]
    }
}

DELETE /api/v202206/asns/{itemId} （取消 ASN）#

仅 Draft 状态可取消。取消后 ASN 从所有查询接口中消失（包括按 asn_id 直查）。取消会同时解除该 ASN 与 VAS / Transfer 的关联。
注意：ASN 取消行为与 Transfer / VAS 不同。Transfer 和 VAS 取消后会保留在 Cancelled 状态，仍可通过查询接口检索到；而 ASN 取消后无法再通过 API 检索。如需保留审计/历史记录，请在取消前先保存需要的数据。

请求#

参数#
类型名称描述必填/选填数据结构
pathitemId要取消的 ASN id必填integer
queryapiAPI 类型

可用值:
destroy.by-default		必填enum
请求示例#
DELETE /api/v202206/asns/88888?api=destroy.by-default
错误场景：
ASN 不存在 → ASN X not found
已经取消 → ASN X is already cancelled
非 Draft 状态 → Status <name> not allowed, only DRAFT can be cancelled

返回#

键值
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
名称描述数据结构
asn_idASN idinteger
cancelled_at取消时间戳
时区：太平洋标准时间		datetime
返回示例#
{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "asn_id": 88888,
        "cancelled_at": "2026-09-21 15:30:00"
    }
}

GET /api/v202206/asn-docs （获取 ASN 附件列表）#

asn_id 必带。任何状态（含已取消）的 ASN 都可读附件 —— 附件是记录已发生事项的凭据，取消 ASN 不会连同附件一起隐藏。ASN 完全不存在时返回 ASN X not found。

请求#

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

可用值:
index.by-default		必填enum
queryasn_id目标 ASN id必填integer
querytype_id按附件类型过滤
可用值:
1：Packing Slip（装箱单，随货附带的商品清单，供收货方核对）
2：BOL（提单 / 运单，Bill of Lading，LTL/FTL/FCL 承运凭证）
3：Carton Label（箱唛，贴在每箱外部）
4：Pallet Label（托盘标签）
5：Shipping Label（小包裹运输面单，SPD 用）
6：Other（其他）		选填integer
querynext_token下一页数据的秘钥选填string
请求示例#
GET /api/v202206/asn-docs?api=index.by-default&asn_id=88888&type_id=2

返回#

键值
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
名称描述数据结构
doc_id附件 idinteger
asn_id所属 ASN idinteger
type_id附件类型 id：
1：Packing Slip（装箱单，随货附带的商品清单，供收货方核对）
2：BOL（提单 / 运单，Bill of Lading，LTL/FTL/FCL 承运凭证）
3：Carton Label（箱唛，贴在每箱外部）
4：Pallet Label（托盘标签）
5：Shipping Label（小包裹运输面单，SPD 用）
6：Other（其他）
7：Pre-Receiving Scan（到货前扫描凭证，owner = ShipSage，仓库端上传）
8：Pre-Receiving Count（到货前点数凭证，owner = ShipSage，仓库端上传）		integer
doc_name文件名string
ext扩展名string
url附件的完整 URL：域名为 ShipSage 名下（*.shipsage.com / *.shipsage.cn / *.gaatu.com / *.jootop.com），路径以 /uploads/ 开头。
访问方式：owner = Merchant（客户上传，落在 company 0）的文件通过公共文件路由访问，任何持有 URL 者可直接下载（供仓库数天后打印）；owner = ShipSage（仓库上传，落在仓库公司目录）的文件需要携带 token 走 /api/common/files 认证路由。
有效期：长期有效，不会过期		string
owner上传方
可用值:
Merchant（客户上传）, ShipSage（仓库上传）		string
created_at上传时间
时区：太平洋标准时间		datetime
返回示例#
{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "items": [
            {
                "doc_id": 6001,
                "asn_id": 88888,
                "type_id": 2,
                "doc_name": "bol.pdf",
                "ext": "pdf",
                "url": "https://cdn.shipsage.com/asn/bol.pdf",
                "owner": "Merchant",
                "created_at": "2026-09-20 10:00:00"
            }
        ],
        "next_token": null
    }
}

POST /api/v202206/asn-docs （上传 ASN 附件）#

一次上传一个附件。ASN 已取消时不允许写；其他所有状态（含 Completed）都允许写 —— 签收 BOL / POD 常在完成后到达。上传的 URL 必须来自 ShipSage 的文件上传接口。

请求#

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

可用值:
store.by-default		必填enum
bodyasn_id目标 ASN id必填integer
bodytype_id附件类型 id。ASN 附件维度表内还有 7 (Pre-Receiving Scan) 与 8 (Pre-Receiving Count) 两类仓库端到货前上传的凭据，客户端不允许创建这两类（尝试上传会报 Invalid type_id ...）
可用值:
1：Packing Slip（装箱单，随货附带的商品清单，供收货方核对）
2：BOL（提单 / 运单，Bill of Lading，LTL/FTL/FCL 承运凭证）
3：Carton Label（箱唛，贴在每箱外部）
4：Pallet Label（托盘标签）
5：Shipping Label（小包裹运输面单，SPD 用）
6：Other（其他）		必填enum
bodyurl文件 URL——必须是先调用 ShipSage 文件上传接口 POST /api/v202206/files?api=store.by-upload 后拿到的返回 URL，不接受任何外部/第三方 URL
校验规则：
1. 域名须为 ShipSage 名下（shipsage.com / shipsage.cn / gaatu.com / jootop.com 及其子域）
2. 路径须以 /uploads/ 开头
3. 目标文件必须真实存在（系统会实时校验存储中该文件是否可达）
4. Query String 与 Fragment 会被服务端自动去掉（签名链接会过期，不允许持久化）
5. 存入库时按相对路径存储，长度上限 255 字符

背景：这些附件由仓库在数天后打印使用（打 BOL、贴箱唛）。若指向外部服务器，届时链接可能失效——因此强制要求所有附件必须先上传到 ShipSage 存储		必填string
bodydoc_name文件名（省略时自动从 URL basename 推导；最长 255 字符）选填string
错误场景：
ASN 不存在 → ASN X not found
ASN 已取消 → ASN X is cancelled, documents cannot be changed
未指定 type_id → type_id is required
未知类型 → Invalid type_id X, expected one of ...
说明：客户端上传的附件 owner 一律为 Merchant。
请求示例#
{
    "asn_id": 88888,
    "type_id": 2,
    "url": "https://cdn.shipsage.com/asn/bol.pdf",
    "doc_name": "bol.pdf"
}

返回#

键值
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
名称描述数据结构
doc_id新附件 idinteger
asn_idASN idinteger
type_id附件类型 id（值同上请求 body 的 type_id；客户端可删除的类型限 1–6，7/8 为仓库端凭证客户端不可删）integer
doc_name文件名string
url完整 URLstring
返回示例#
{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "doc_id": 6002,
        "asn_id": 88888,
        "type_id": 2,
        "doc_name": "bol.pdf",
        "url": "https://cdn.shipsage.com/asn/bol.pdf"
    }
}

DELETE /api/v202206/asn-docs/{itemId} （删除 ASN 附件）#

仅允许删除本公司上传的附件（owner = Merchant）；仓库端上传的附件不允许删除。ASN 已取消时也不允许操作附件。

请求#

参数#
类型名称描述必填/选填数据结构
pathitemId附件 id必填integer
queryapiAPI 类型

可用值:
destroy.by-default		必填enum
请求示例#
DELETE /api/v202206/asn-docs/6002?api=destroy.by-default
错误场景：
附件不存在 → ASN doc not found
试删非本公司上传的 → Only documents uploaded by the merchant can be deleted
ASN 已取消 → ASN X is cancelled, documents cannot be changed

返回#

键值
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
名称描述数据结构
doc_id附件 idinteger
asn_idASN idinteger
doc_name文件名string
返回示例#
{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "doc_id": 6002,
        "asn_id": 88888,
        "doc_name": "bol.pdf"
    }
}
Modified at 2026-09-22 12:16:05
Previous
物流跟踪
Next
转运
Built with