1. APIs
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. APIs

ASN

Endpoints#

MethodEndpointDescription
GET/api/v202206/asnsRetrieves a list of ASNs
POST/api/v202206/asn/productsCreate a new ASN whose handling unit is skus
POST/api/v202206/asn/palletsCreate a new ASN whose handling unit is pallets
PUT/api/v202206/asn/products/{item_id}Update an ASN whose handling unit is skus
PUT/api/v202206/asn/pallets/{item_id}Update an ASN whose handling unit is pallets
DELETE/api/v202206/asns/{itemId}Cancel an ASN (only Draft status can be cancelled)
GET/api/v202206/asn-docsRetrieve ASN attachment list
POST/api/v202206/asn-docsUpload ASN attachment (single)
DELETE/api/v202206/asn-docs/{itemId}Delete ASN attachment (own uploads only)
[NEW] v202206 Patch (2026-09):
Existing GET /api/v202206/asns response now includes a new fees field (populated only when the ASN reaches Completed status).
New DELETE /api/v202206/asns/{itemId}: cancel ASN (Draft status only).
New 3 attachment endpoints: GET / POST / DELETE /api/v202206/asn-docs.
Details of the additions follow below.

GET /api/v202206/asns#

Request#

TypeNameDescriptionRequired/Optionalschema
queryapiThe API type

Available Values:
index.by-default		requiredenum
queryasn_idASN IDoptionalinteger
querywarehouse_idThe warehouse id
queryhandling_unit_idThe inventory management level

Availabel Values:
0:Legacy data, 1:sku，3:pallet		optionalenum
(integer)
queryshipping_method_idThe shipping method id

Available Values:
1: By Express
2: By Air
3: By Sea(FCL)
6: By Ground
7: By Truck
8:By Sea (LCL)
optionalenum
(integer)
querydelivery_method_idThe shipping method id

Available Values:
1: SPD
2: LTL
3: FTL
4: FCL
optionalenum
(integer)
queryis_palletizedIs it palletized?

Available Values:
0：No
1:Yes		optionalenum
(integer)
querystatusThe status

Available Values:
1:Draft, 2:In Transit, 3:Open, 4:In Progress,5:Billing Audit,6:Completed		optionalenum
(interger)
querycreated_at_fromThe shipsage order create time start timezone:PSToptionaldatetime
querycreated_at_toThe shipsage ASN create time end timezone:PSToptionaldatetime
queryupdated_at_fromThe shipsage ASN update time start timezone:PSToptionaldatetime
queryupdated_at_toThe shipsage ASN update time end timezone:PSToptionaldatetime
querynext_tokenShow next page dataoptionalstring

Response#

KeyValue
errcode0/4000
errmsgok/Error Info
dataData Properties
Data Properties#
NameDescriptionschema
asn_idThe shipsage asn idinteger
titleThe titlestring
estimate_start_dateThe estimate earliest arrival datedatetime
estimate_end_dateThe estimate latest arrival datedatetime
warehouse_idThe warehouse idinteger
warehouse_nameThe destination warehousestring
statusThe status

Available Values:
1:Draft, 2:In Transit, 3:Open, 4:In Progress,5:Billing Audit,6:Completed		enum
(interger)
status_nameThe sattus description
handling_unit_idThe inventory management level

Availabel Values:
0:Legacy data, 1:sku，3:pallet		enum
(interger)
fifoThe cross-docking

Availabel Values:
0:not fast in fast out, 1:fast in fast out		enum
(interger)
tracking_infoThe tracking informationstring
shipping_method_idThe shipping method id

Available Values:
1: By Express
2: By Air
3: By Sea(FCL)
6: By Ground
7: By Truck
8:By Sea (LCL)
enum
(interger)
shipping_method_nameThe shipping methodstring
delivery_method_idThe shipping method id

Available Values:
1: SPD
2: LTL
3: FTL
4: FCL
enum
(interger)
container_numberThe container numberstring
ship_container_sizeThe ship container size

Available Values:
3: Container 20 palletized
4: Container 20 no-palletized
5: Container 40 palletized
6: Container 40 no-palletized
7: Container 45 palletized
8: Container 45 no-palletized
9: Container 40HQ palletized
10: Container 40HQ no-palletized		enum
(interger)
ship_container_size_descThe description of ship container sizestring
is_palletizedIs it palletized?

Available Values:
0：No
1:Yes		enum
(interger)
hblThe house bill of loadingstring
mblThe master bill of ladingstring
create_timeThe ASN's create time timezone:PSTdatetime
update_timeThe ASN's last update time timezone:PSTdatetime
manifest_itemsThe Packing List itemsarray
manifest_items.*.asn_idThe asn idinteger
manifest_items.*.pallet_numThe pallet numberstring
manifest_items.*.pallet_barcodeThe pallet barcodestring
manifest_items.*.pallet_weightThe pallet weight (kg)double
manifest_items.*.pallet_lengthThe pallet length (cm)double
manifest_items.*.pallet_widthThe pallet width (cm)double
manifest_items.*.pallet_heightThe pallet height (cm)double
manifest_items.*.carton_numThe carton numstring
manifest_items.*.carton_barcodeThe carton barcodestring
manifest_items.*.contentThe physical content in the carton or in the palletstring
manifest_items.*.carton_weightThe carton weight (kg)double
manifest_items.*.carton_lengthThe carton length (cm)double
manifest_items.*.carton_widthThe carton width (cm)double
manifest_items.*.carton_heightThe carton height (cm)double
manifest_items.*.carton_tracking_numberThe carton tracking numberstring
manifest_items.*.contentThe physical content in the carton or in the palletstring
manifest_items.*.customer_skuThe customer skustring
manifest_items.*.qtyThe qty per carton of this customer skuinteger
manifest_items.*.purchase_orderThe purchase order numberstring
manifest_items.*.vendor_idThe vendor IDinteger
manifest_items.*.lot_attr_01The lot attributes 1string
manifest_items.*.lot_attr_02The lot attributes 2string
manifest_items.*.lot_attr_03The lot attributes 3string
manifest_items.*.lot_attr_04The lot attributes 4string
manifest_items.*.lot_attr_05The lot attributes 5string
manifest_items.*.lot_attr_06The lot attributes 6string
manifest_items.*.lot_attr_07The lot attributes 7string
manifest_items.*.lot_attr_08The lot attributes 8string
manifest_items.*.lot_attr_09The lot attributes 9string
manifest_items.*.lot_attr_10The lot attributes 10string
manifest_items.*.lot_attr_11The lot attributes 11string
manifest_items.*.lot_attr_12The lot attributes 12string
manifest_items.*.lot_attr_13The lot attributes 13string
manifest_items.*.lot_attr_14The lot attributes 14string
manifest_items.*.lot_attr_15The lot attributes 15string
receiving_itemsThe sku detail items of asnarray
receiving_items.*.line_idThe receiving item idinteger
receiving_items.*.asn_idThe shipsage asn idinteger
receiving_items.*.status1: Open, 2: Closeinteger
receiving_items.*.skuThe shipsage skuinteger
receiving_items.*.customer_skuThe customer skustring
receiving_items.*.display_codeThe received qtyinteger
receiving_items.*.qtyThe sku qtyinteger
receiving_items.*.qty_defectiveThe defective qtyinteger
receiving_items.*.qty_inventoryThe inbound qtyinteger
receiving_items.*.lot_attr_01The lot attributes 1string
receiving_items.*.lot_attr_02The lot attributes 2string
receiving_items.*.lot_attr_03The lot attributes 3string
receiving_items.*.lot_attr_04The lot attributes 4string
receiving_items.*.lot_attr_05The lot attributes 5string
receiving_items.*.lot_attr_06The lot attributes 6string
receiving_items.*.lot_attr_07The lot attributes 7string
receiving_items.*.lot_attr_08The lot attributes 8string
receiving_items.*.lot_attr_09The lot attributes 9string
receiving_items.*.lot_attr_10The lot attributes 10string
receiving_items.*.lot_attr_11The lot attributes 11string
receiving_items.*.lot_attr_12The lot attributes 12string
receiving_items.*.lot_attr_13The lot attributes 13string
receiving_items.*.lot_attr_14The lot attributes 14string
receiving_items.*.lot_attr_15The lot attributes 15string
Data Demo#
[
    {
        "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",
        "fifo": 0,
        "ship_container_size": null,
        "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#

Request#

General Parameters#
TypeNameDescriptionRequired/Optionalschema
queryapiThe API type

Available Values:
index.by-default		requiredenum
bodyfifoThe cross-docking

Availabel Values:
0:not fast in fast out, 1:fast in fast out		requiredenum
bodywarehouse_idThe destination warehouse id

Available Values:
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)		requiredenum
(interger)
bodyestimate_start_dateThe estimated earliest arrival daterequireddatetime
bodyestimate_end_dateThe estimated latest arrival daterequireddatetime
bodystatusThe status default 0

Available Values:
1:Draft
2:In Transit		optionalenum
(interger)
bodymanifest_itemsPacking List itemsrequiredarray
bodymanifest_items.*.pallet_numThe pallet numberoptionalstring
bodymanifest_items.*.pallet_weightThe pallet weight (kg)optionaldouble
bodymanifest_items.*.pallet_lengthThe pallet length (cm)optionaldouble
bodymanifest_items.*.pallet_widthThe pallet width (cm)optionaldouble
bodymanifest_items.*.pallet_heightThe pallet height (cm)optionaldouble
bodymanifest_items.*.carton_numThe carton numrequiredstring
bodymanifest_items.*.carton_weightThe carton weight (kg)requireddouble
bodymanifest_items.*.carton_lengthThe carton length (cm)requireddouble
bodymanifest_items.*.carton_widthThe carton width (cm)requireddouble
bodymanifest_items.*.carton_heightThe carton height (cm)requireddouble
bodymanifest_items.*.carton_tracking_numberThe carton tracking numberoptionalstring
bodymanifest_items.*.customer_skuThe customer skurequiredstring
bodymanifest_items.*.packed_qtyThe qty per carton of this customer skurequiredinteger
bodymanifest_items.*.packing_standard_qtyThe standard packaging quantity of the product, that is, the product is packed in several; it can only be filled in if the system maintains the standard packaging standard, otherwise please leave it blankoptionalinteger
bodymanifest_items.*.lot_attr_01The lot attributes 1optionalstring
bodymanifest_items.*.lot_attr_02The lot attributes 2optionalstring
bodymanifest_items.*.lot_attr_03The lot attributes 3optionalstring
bodymanifest_items.*.lot_attr_04The lot attributes 4optionalstring
bodymanifest_items.*.lot_attr_05The lot attributes 5optionalstring
bodymanifest_items.*.lot_attr_06The lot attributes 6optionalstring
bodymanifest_items.*.lot_attr_07The lot attributes 7optionalstring
bodymanifest_items.*.lot_attr_08The lot attributes 8optionalstring
bodymanifest_items.*.lot_attr_09The lot attributes 9optionalstring
bodymanifest_items.*.lot_attr_10The lot attributes 10optionalstring
bodymanifest_items.*.lot_attr_11The lot attributes 11optionalstring
bodymanifest_items.*.lot_attr_12The lot attributes 12optionalstring
bodymanifest_items.*.lot_attr_13The lot attributes 13optionalstring
bodymanifest_items.*.lot_attr_14The lot attributes 14optionalstring
bodymanifest_items.*.lot_attr_15The lot attributes 15optionalstring
Parameters when status is shipped and shipping_method is By Sea(FCL)#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
3: By Sea(FCL)
requiredenum
(interger)
bodydelivery_method_idThe shipping method id

Available Values:
4: FCL
requiredenum
(integer)
bodycontainer_numberThe container numberrequiredstring
bodyship_container_sizeThe ship container size

Available Values:
3: Container 20 palletized
4: Container 20 no-palletized
5: Container 40 palletized
6: Container 40 no-palletized
7: Container 45 palletized
8: Container 45 no-palletized
9: Container 40HQ palletized
10: Container 40HQ no-palletized		requiredenum
(interger)
bodyhblThe house bill of loadingoptionalstring
bodymblThe master bill of ladingoptionalstring
Parameters when status is shipped and shipping_method is By Sea (LCL)，By Air#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
8:By Sea (LCL)
2:By Air
requiredenum
(interger)
bodydelivery_method_idThe shipping method id

Available Values:
1: SPD
2：LTL
requiredenum
(integer)
bodyis_palletizedIs it palletized?

Available Values:
0：No
1:Yes		requiredenum
(integer)
bodyhblThe house bill of loading, HBL or MBL or tracking_info must have one is required，Please fill in this field if it is LTL.optionalstring
bodymblThe master bill of lading, HBL or MBL or tracking_info must have one is required，Please fill in this field if it is LTL.optionalstring
bodytracking_infoThe tracking information, HBL or MBL or tracking_info must have one is required，Please fill in this field if it is SPD.optionalstring
Parameters when status is shipped and shipping_method is By Express#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
1: By Express
requiredenum
(interger)
bodydelivery_method_idThe shipping method id

Available Values:
1: SPD
requiredenum
(integer)
bodyis_palletizedIs it palletized?

Available Values:
0：No
requiredenum
(integer)
bodytracking_infoThe tracking informationrequiredstring
Parameters when status is shipped and shipping_method is By Truck#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
7: By Truck
requiredenum
(interger)
bodydelivery_method_idThe shipping method id

Available Values:
2: LTL
3：FTL
requiredenum
(integer)
bodyis_palletizedIs it palletized?

Available Values:
0：No
1：Yes
requiredenum
(integer)
bodyhblThe house bill of loading，HBL or MBL or tracking_info must have one is requiredoptionalstring
bodymblThe master bill of lading, HBL or MBL or tracking_info must have one is requiredoptionalstring
bodytracking_infoThe tracking information, HBL or MBL or tracking_info must have one is requiredoptionalstring
Body Demo#
{
  "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"
    }
  ]
}

Response#

KeyValue
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
NameDescriptionSchema
asn_idThe sipesage asn idinteger
Data Demo#
{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "asn_id": 15216
  }
}

POST /api/v202206/asn/pallets#

Request#

General Parameters#
TypeNameDescriptionRequired/Optionalschema
queryapiThe API type

Available Values:
index.by-default		requiredenum
bodyfifoThe cross-docking

Availabel Values:
0:not fast in fast out, 1:fast in fast out		requiredenum
bodywarehouse_idThe destination warehouse id

Available Values:
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)		requiredenum
(interger)
bodyestimate_start_dateThe estimated earliest arrival daterequireddatetime
bodyestimate_end_dateThe estimated latest arrival daterequireddatetime
bodystatusThe status default 0

Available Values:
1:Draft
2:In Transit		optionalenum
(interger)
bodymanifest_itemsPacking List itemsrequiredarray
bodymanifest_items.*.pallet_numThe pallet numberrequiredstring
bodymanifest_items.*.pallet_barcodeThe pallet barcodeoptionalstring
bodymanifest_items.*.pallet_weightThe pallet weight (kg)requireddouble
bodymanifest_items.*.pallet_lengthThe pallet length (cm)requireddouble
bodymanifest_items.*.pallet_widthThe pallet width (cm)requireddouble
bodymanifest_items.*.pallet_heightThe pallet height (cm)requireddouble
bodymanifest_items.*.contentThe physical content in the palletrequiredstring
bodymanifest_items.*.lot_attr_01The lot attributes 1optionalstring
bodymanifest_items.*.lot_attr_02The lot attributes 2optionalstring
bodymanifest_items.*.lot_attr_03The lot attributes 3optionalstring
bodymanifest_items.*.lot_attr_04The lot attributes 4optionalstring
bodymanifest_items.*.lot_attr_05The lot attributes 5optionalstring
bodymanifest_items.*.lot_attr_06The lot attributes 6optionalstring
bodymanifest_items.*.lot_attr_07The lot attributes 7optionalstring
bodymanifest_items.*.lot_attr_08The lot attributes 8optionalstring
bodymanifest_items.*.lot_attr_09The lot attributes 9optionalstring
bodymanifest_items.*.lot_attr_10The lot attributes 10optionalstring
bodymanifest_items.*.lot_attr_11The lot attributes 11optionalstring
bodymanifest_items.*.lot_attr_12The lot attributes 12optionalstring
bodymanifest_items.*.lot_attr_13The lot attributes 13optionalstring
bodymanifest_items.*.lot_attr_14The lot attributes 14optionalstring
bodymanifest_items.*.lot_attr_15The lot attributes 15optionalstring
Parameters when status is shipped and shipping_method is By Sea(FCL)#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
3: By Sea(FCL)
requiredenum
(interger)
bodycontainer_numberThe container numberrequiredstring
bodyship_container_sizeThe ship container size

Available Values:
3: Container 20 palletized
4: Container 20 no-palletized
5: Container 40 palletized
6: Container 40 no-palletized
7: Container 45 palletized
8: Container 45 no-palletized
9: Container 40HQ palletized
10: Container 40HQ no-palletized		requiredenum
(interger)
bodyhblThe house bill of loadingoptionalstring
bodymblThe master bill of ladingoptionalstring
bodytracking_infoThe tracking informationoptionalstring
Parameters when status is shipped and shipping_method is By Sea(LCL)#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
8:By Sea (LCL)
requiredenum
(interger)
bodyhblThe house bill of loading, HBL or MBL or tracking_info must have one is requiredoptionalstring
bodymblThe master bill of lading, HBL or MBL or tracking_info must have one is requiredoptionalstring
bodytracking_infoThe tracking information, HBL or MBL or tracking_info must have one is requiredoptionalstring
Parameters when status is shipped and shipping_method is not in ( By Sea(FCL),By Sea(LCL) )#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
1: By Express
2: By Air
6: By Ground
7: By Truck
requiredenum
(interger)
bodycontainer_numberThe container number, container_number or HBL or MBL or tracking_info must have one is requiredoptionalstring
bodyship_container_sizeThe ship container size

Available Values:
3: Container 20 palletized
4: Container 20 no-palletized
5: Container 40 palletized
6: Container 40 no-palletized
7: Container 45 palletized
8: Container 45 no-palletized
9: Container 40HQ palletized
10: Container 40HQ no-palletized		optionalenum
(interger)
bodyhblThe house bill of loading, container_number or HBL or MBL or tracking_info must have one is requiredoptionalstring
bodymblThe master bill of lading, container_number or HBL or MBL or tracking_info must have one is requiredoptionalstring
bodytracking_infoThe tracking information, container_number or HBL or MBL or tracking_info must have one is requiredoptionalstring
Body Demo#
{
  "warehouse_id": 101,
  "shipping_method_id": 1,
  "ship_container_size": 3,
  "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_barcode": "",
      "pallet_weight": "100",
      "pallet_length": "100",
      "pallet_width": "100",
      "pallet_height": "100",
      "content": "content001",
      "lot_attr_01": "attr01",
      "lot_attr_02": "attr02",
      "lot_attr_03": "attr03"
    },
    {
      "pallet_num": "2",
      "pallet_barcode": "",
      "pallet_weight": "100",
      "pallet_length": "100",
      "pallet_width": "100",
      "pallet_height": "100",
      "content": "content002",
      "lot_attr_01": "attr01",
      "lot_attr_02": "attr02",
      "lot_attr_03": "attr03"
    }
  ]
}

Response#

KeyValue
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
NameDescriptionSchema
asn_idThe sipesage asn idinteger
Data Demo#
{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "asn_id": 15216
  }
}

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

Request#

General Parameters#
TypeNameDescriptionRequired/Optionalschema
queryapiThe API type

Available Values:
index.by-default		requiredenum
pathitem_idThe shipsage asn idrequiredinteger
bodyfifoThe cross-docking

Availabel Values:
0:not fast in fast out, 1:fast in fast out		optionalenum
bodywarehouse_idThe destination warehouse id

Available Values:
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)		optionalenum
(interger)
bodyestimate_start_dateThe estimated earliest arrival dateoptionaldatetime
bodyestimate_end_dateThe estimated latest arrival dateoptionaldatetime
bodystatusThe status Can only be changed from draft status to shipped status

Available Values:
1:Draft
2:In Transit
optionalenum
(interger)
bodymanifest_itemsPacking List itemsoptionalarray
bodymanifest_items.*.pallet_numThe pallet numberoptionalstring
bodymanifest_items.*.pallet_weightThe pallet weight (kg)optionaldouble
bodymanifest_items.*.pallet_lengthThe pallet length (cm)optionaldouble
bodymanifest_items.*.pallet_widthThe pallet width (cm)optionaldouble
bodymanifest_items.*.pallet_heightThe pallet height (cm)optionaldouble
bodymanifest_items.*.carton_numThe carton numoptionalstring
bodymanifest_items.*.carton_weightThe carton weight (kg)optionaldouble
bodymanifest_items.*.carton_lengthThe carton length (cm)optionaldouble
bodymanifest_items.*.carton_widthThe carton width (cm)optionaldouble
bodymanifest_items.*.carton_heightThe carton height (cm)optionaldouble
bodymanifest_items.*.carton_tracking_numberThe carton tracking numberoptionalstring
bodymanifest_items.*.customer_skuThe customer skuoptionalstring
bodymanifest_items.*.packed_qtyThe qty per carton of this customer skuoptionalinteger
bodymanifest_items.*.Packing_standard_qtyThe standard packaging quantity of the product, that is, the product is packed in several; it can only be filled in if the system maintains the standard packaging standard, otherwise please leave it blankoptionalinteger
bodymanifest_items.*.lot_attr_01The lot attributes 1optionalstring
bodymanifest_items.*.lot_attr_02The lot attributes 2optionalstring
bodymanifest_items.*.lot_attr_03The lot attributes 3optionalstring
bodymanifest_items.*.lot_attr_04The lot attributes 4optionalstring
bodymanifest_items.*.lot_attr_05The lot attributes 5optionalstring
bodymanifest_items.*.lot_attr_06The lot attributes 6optionalstring
bodymanifest_items.*.lot_attr_07The lot attributes 7optionalstring
bodymanifest_items.*.lot_attr_08The lot attributes 8optionalstring
bodymanifest_items.*.lot_attr_09The lot attributes9optionalstring
bodymanifest_items.*.lot_attr_10The lot attributes 10optionalstring
bodymanifest_items.*.lot_attr_11The lot attributes 11optionalstring
bodymanifest_items.*.lot_attr_12The lot attributes 12optionalstring
bodymanifest_items.*.lot_attr_13The lot attributes 13optionalstring
bodymanifest_items.*.lot_attr_14The lot attributes 14optionalstring
bodymanifest_items.*.lot_attr_15The lot attributes 15optionalstring
Parameters when status is shipped and shipping_method is By Sea(FCL)#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
3: By Sea(FCL)
requiredenum
(interger)
bodydelivery_method_idThe shipping method id

Available Values:
4: FCL
requiredenum
(integer)
bodycontainer_numberThe container numberrequiredstring
bodyship_container_sizeThe ship container size

Available Values:
3: Container 20 palletized
4: Container 20 no-palletized
5: Container 40 palletized
6: Container 40 no-palletized
7: Container 45 palletized
8: Container 45 no-palletized
9: Container 40HQ palletized
10: Container 40HQ no-palletized		requiredenum
(interger)
bodyhblThe house bill of loadingoptionalstring
bodymblThe master bill of ladingoptionalstring
Parameters when status is shipped and shipping_method is By Sea (LCL)，By Air#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
8:By Sea (LCL)
2:By Air
requiredenum
(interger)
bodydelivery_method_idThe shipping method id

Available Values:
1: SPD
2：LTL
requiredenum
(integer)
bodyis_palletizedIs it palletized?

Available Values:
0：No
1:Yes		requiredenum
(integer)
bodyhblThe house bill of loading, HBL or MBL or tracking_info must have one is required，Please fill in this field if it is LTL.optionalstring
bodymblThe master bill of lading, HBL or MBL or tracking_info must have one is required，Please fill in this field if it is LTL.optionalstring
bodytracking_infoThe tracking information, HBL or MBL or tracking_info must have one is required，Please fill in this field if it is SPD.optionalstring
Parameters when status is shipped and shipping_method is By Express#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
1: By Express
requiredenum
(interger)
bodydelivery_method_idThe shipping method id

Available Values:
1: SPD
requiredenum
(integer)
bodyis_palletizedIs it palletized?

Available Values:
0：No
requiredenum
(integer)
bodytracking_infoThe tracking informationrequiredstring
Parameters when status is shipped and shipping_method is By Truck#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
7: By Truck
requiredenum
(interger)
bodydelivery_method_idThe shipping method id

Available Values:
2: LTL
3：FTL
requiredenum
(integer)
bodyis_palletizedIs it palletized?

Available Values:
0：No
1：Yes
requiredenum
(integer)
bodyhblThe house bill of loading, container_number or HBL or MBL or tracking_info must have one is requiredoptionalstring
bodymblThe master bill of lading, container_number or HBL or MBL or tracking_info must have one is requiredoptionalstring
Body Demo#
{
  "warehouse_id": 101,
  "shipping_method_id": 1,
  "ship_container_size": 3,
  "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"
    }
  ]
}

Response#

KeyValue
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
NameDescriptionSchema
asn_idThe sipesage asn idinteger
Data Demo#
{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "asn_id": 15216
  }
}

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

Request#

General Parameters#
TypeNameDescriptionRequired/Optionalschema
queryapiThe API type

Available Values:
index.by-default		requiredenum
pathitem_idThe shipsage asn idrequiredinteger
bodyfifoThe cross-docking

Availabel Values:
0:not fast in fast out, 1:fast in fast out		optionalenum
bodywarehouse_idThe destination warehouse id

Available Values:
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)		optionalenum
(interger)
bodyexpected_dateThe estimated earliest arrival dateoptionaldatetime
bodyestimate_end_dateThe estimated latest arrival dateoptionaldatetime
bodystatusThe status Can only be changed from draft status to shipped status

Available Values:
1:Draft
2:In Transit
optionalenum
(interger)
bodymanifest_itemsPacking List itemsoptionalarray
bodymanifest_items.*.pallet_numThe pallet numberoptionalstring
bodymanifest_items.*.pallet_barcodeThe pallet barcodeoptionalstring
bodymanifest_items.*.pallet_weightThe pallet weight (kg)optionaldouble
bodymanifest_items.*.pallet_lengthThe pallet length (cm)optionaldouble
bodymanifest_items.*.pallet_widthThe pallet width (cm)optionaldouble
bodymanifest_items.*.pallet_heightThe pallet height (cm)optionaldouble
bodymanifest_items.*.contentThe physical content in the carton or in the palletoptionalstring
bodymanifest_items.*.lot_attr_01The lot attributes 1optionalstring
bodymanifest_items.*.lot_attr_02The lot attributes 2optionalstring
bodymanifest_items.*.lot_attr_03The lot attributes 3optionalstring
bodymanifest_items.*.lot_attr_04The lot attributes 4optionalstring
bodymanifest_items.*.lot_attr_05The lot attributes 5optionalstring
bodymanifest_items.*.lot_attr_06The lot attributes 6optionalstring
bodymanifest_items.*.lot_attr_07The lot attributes 7optionalstring
bodymanifest_items.*.lot_attr_08The lot attributes 8optionalstring
bodymanifest_items.*.lot_attr_09The lot attributes9optionalstring
bodymanifest_items.*.lot_attr_10The lot attributes 10optionalstring
bodymanifest_items.*.lot_attr_11The lot attributes 11optionalstring
bodymanifest_items.*.lot_attr_12The lot attributes 12optionalstring
bodymanifest_items.*.lot_attr_13The lot attributes 13optionalstring
bodymanifest_items.*.lot_attr_14The lot attributes 14optionalstring
bodymanifest_items.*.lot_attr_15The lot attributes 15optionalstring
Parameters when status is shipped and shipping_method is By Sea(FCL)#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
3: By Sea(FCL)
requiredenum
(interger)
bodycontainer_numberThe container numberrequiredstring
bodyship_container_sizeThe ship container size

Available Values:
3: Container 20 palletized
4: Container 20 no-palletized
5: Container 40 palletized
6: Container 40 no-palletized
7: Container 45 palletized
8: Container 45 no-palletized
9: Container 40HQ palletized
10: Container 40HQ no-palletized		requiredenum
(interger)
bodyhblThe house bill of loadingoptionalstring
bodymblThe master bill of ladingoptionalstring
bodytracking_infoThe tracking informationoptionalstring
Parameters when status is shipped and shipping_method is By Sea(LCL)#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
8:By Sea (LCL)
requiredenum
(interger)
bodyhblThe house bill of loading, HBL or MBL or tracking_info must have one is requiredoptionalstring
bodymblThe master bill of lading, HBL or MBL or tracking_info must have one is requiredoptionalstring
bodytracking_infoThe tracking information, HBL or MBL or tracking_info must have one is requiredoptionalstring
Parameters when status is shipped and shipping_method is not in ( By Sea(FCL),By Sea(LCL) )#
TypeNameDescriptionRequired/Optionalschema
bodystatusThe status default 0

Available Values:
2:In Transit		requiredenum
(interger)
bodyshipping_method_idThe shipping method id

Available Values:
1: By Express
2: By Air
6: By Ground
7: By Truck
requiredenum
(interger)
bodycontainer_numberThe container number, container_number or HBL or MBL or tracking_info must have one is requiredoptionalstring
bodyship_container_sizeThe ship container size

Available Values:
3: Container 20 palletized
4: Container 20 no-palletized
5: Container 40 palletized
6: Container 40 no-palletized
7: Container 45 palletized
8: Container 45 no-palletized
9: Container 40HQ palletized
10: Container 40HQ no-palletized		optionalenum
(interger)
bodyhblThe house bill of loading, container_number or HBL or MBL or tracking_info must have one is requiredoptionalstring
bodymblThe master bill of lading, container_number or HBL or MBL or tracking_info must have one is requiredoptionalstring
bodytracking_infoThe tracking information, container_number or HBL or MBL or tracking_info must have one is requiredoptionalstring
Body Demo#
{
  "warehouse_id": 101,
  "shipping_method_id": 1,
  "ship_container_size": 3,
  "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_barcode": "",
      "pallet_weight": "100",
      "pallet_length": "100",
      "pallet_width": "100",
      "pallet_height": "100",
      "content": "content001",
      "lot_attr_01": "attr01",
      "lot_attr_02": "attr02",
      "lot_attr_03": "attr03"
    },
    {
      "pallet_num": "2",
      "pallet_barcode": "",
      "pallet_weight": "100",
      "pallet_length": "100",
      "pallet_width": "100",
      "pallet_height": "100",
      "content": "content002",
      "lot_attr_01": "attr01",
      "lot_attr_02": "attr02",
      "lot_attr_03": "attr03"
    }
  ]
}

Response#

KeyValue
errcode0/4000
errmsgok/Error Info
dataData Properties
Data properties#
NameDescriptionSchema
asn_idThe ShipSage asn idinteger
Data Demo#
{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "asn_id": 15216
  }
}

v202206 Patch (2026-09) — New Additions#

GET /api/v202206/asns (Get ASN List)#

This release adds a new fees field to the response. Other fields and request parameters remain the same as the existing interface.

Request#

Parameters are unchanged (asn_id / warehouse_id / handling_unit_id / shipping_method_id / status / date range / next_token, etc.).
Request Example#
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

Response#

New Fields#
NameDescriptionSchema
feesFee array (only populated when the ASN reaches Completed status, otherwise an empty array)array
fees sub-structure#
NameDescriptionSchema
fee_nameFee namestring
balance_typeSettlement typestring
priceUnit pricedecimal
qtyQuantitydecimal
total_feeTotal fee (price × qty)decimal
descriptionDescriptionstring
Response Example (Completed status with 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"
            }
        ]
    }
}
Response Example (non-Completed status, fees is empty)#
{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "items": [
            {
                "asn_id": 99999,
                "title": "ASN-20260812-002",
                "status": 1,
                "fees": []
            }
        ]
    }
}

DELETE /api/v202206/asns/{itemId} (Cancel ASN)#

Only ASNs in Draft status can be cancelled. Once cancelled, the ASN disappears from all query endpoints (including direct lookup by asn_id). Cancellation also unlinks the ASN from any associated VAS / Transfer.
Note: ASN cancellation behaves differently from Transfer / VAS. Cancelled Transfers and VAS remain in the Cancelled state and can still be retrieved through the query endpoints; a cancelled ASN, however, cannot be retrieved via the API anymore. If you need to keep audit / historical records, save the required data before cancelling.

Request#

Params#
TypeNameDescriptionRequired/OptionalSchema
pathitemIdID of the ASN to be cancelledrequiredinteger
queryapiAPI type

Available Values:
destroy.by-default		requiredenum
Request Example#
DELETE /api/v202206/asns/88888?api=destroy.by-default
Error scenarios:
ASN does not exist → ASN X not found
Already cancelled → ASN X is already cancelled
Not in Draft status → Status <name> not allowed, only DRAFT can be cancelled

Response#

KeyValue
errcode0/4000
errmsgok/Error Info
dataData Properties
Data Properties#
NameDescriptionSchema
asn_idASN idinteger
cancelled_atCancellation timestamp
Timezone: Pacific Standard Time		datetime
Response Example#
{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "asn_id": 88888,
        "cancelled_at": "2026-09-21 15:30:00"
    }
}

GET /api/v202206/asn-docs (Get ASN Document List)#

asn_id is required. Documents can be read for ASNs in any status (including cancelled) — documents are records of events that have already happened, and cancelling an ASN does not hide them. If the ASN does not exist at all, ASN X not found is returned.

Request#

Params#
TypeNameDescriptionRequired/OptionalSchema
queryapiAPI type

Available Values:
index.by-default		requiredenum
queryasn_idTarget ASN idrequiredinteger
querytype_idFilter by document type
Available Values:
1: Packing Slip (packing list included with the goods for the receiver to verify against)
2: BOL (Bill of Lading, carrier document for LTL/FTL/FCL)
3: Carton Label (label affixed to the outside of each carton)
4: Pallet Label
5: Shipping Label (parcel shipping label used for SPD)
6: Other		optionalinteger
querynext_tokenToken for retrieving the next pageoptionalstring
Request Example#
GET /api/v202206/asn-docs?api=index.by-default&asn_id=88888&type_id=2

Response#

KeyValue
errcode0/4000
errmsgok/Error Info
dataData Properties
Data Properties#
NameDescriptionSchema
doc_idDocument idinteger
asn_idID of the ASN the document belongs tointeger
type_idDocument type id:
1: Packing Slip (packing list included with the goods for the receiver to verify against)
2: BOL (Bill of Lading, carrier document for LTL/FTL/FCL)
3: Carton Label (label affixed to the outside of each carton)
4: Pallet Label
5: Shipping Label (parcel shipping label used for SPD)
6: Other
7: Pre-Receiving Scan (pre-arrival scan proof, owner = ShipSage, uploaded by the warehouse)
8: Pre-Receiving Count (pre-arrival count proof, owner = ShipSage, uploaded by the warehouse)		integer
doc_nameFile namestring
extFile extensionstring
urlFull URL of the document: the domain is one of ShipSage's own (*.shipsage.com / *.shipsage.cn / *.gaatu.com / *.jootop.com), and the path starts with /uploads/.
Access: files with owner = Merchant (uploaded by the customer, stored under company 0) are served via the public file route and anyone holding the URL can download directly (so the warehouse can print them days later); files with owner = ShipSage (uploaded by the warehouse, stored under the warehouse company directory) require a token and must be fetched through the authenticated /api/common/files route.
Validity: long-term valid, does not expire		string
ownerUploader
Available Values:
Merchant (uploaded by the customer), ShipSage (uploaded by the warehouse)		string
created_atUpload time
Timezone: Pacific Standard Time		datetime
Response Example#
{
    "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 (Upload ASN Document)#

Upload one document per call. Writing is not allowed when the ASN has been cancelled; writing is allowed in every other status (including Completed) — signed BOL / POD documents often arrive after the ASN is completed. The uploaded URL must come from ShipSage's file upload endpoint.

Request#

Params#
TypeNameDescriptionRequired/OptionalSchema
queryapiAPI type

Available Values:
store.by-default		requiredenum
bodyasn_idTarget ASN idrequiredinteger
bodytype_idDocument type id. The ASN document dictionary also contains 7 (Pre-Receiving Scan) and 8 (Pre-Receiving Count), which are pre-arrival proofs uploaded by the warehouse side. Clients are not allowed to create these two types (attempting to upload will return Invalid type_id ...).
Available Values:
1: Packing Slip (packing list included with the goods for the receiver to verify against)
2: BOL (Bill of Lading, carrier document for LTL/FTL/FCL)
3: Carton Label (label affixed to the outside of each carton)
4: Pallet Label
5: Shipping Label (parcel shipping label used for SPD)
6: Other		requiredenum
bodyurlFile URL — must be the URL returned by first calling the ShipSage file upload endpoint POST /api/v202206/files?api=store.by-upload. External / third-party URLs are not accepted.
Validation rules:
1. The domain must be one of ShipSage's own (shipsage.com / shipsage.cn / gaatu.com / jootop.com and their subdomains)
2. The path must start with /uploads/
3. The target file must actually exist (the system verifies in real time that the file is reachable in storage)
4. Query string and fragment are automatically stripped by the server (signed links would expire, so they are not persisted)
5. Only the relative path is stored in the database, with a maximum length of 255 characters

Background: these documents are printed by the warehouse days later (printing BOLs, affixing carton labels). If they pointed to an external server, the link might be broken by then — this is why every document must first be uploaded to ShipSage storage.		requiredstring
bodydoc_nameFile name (if omitted, it is derived from the URL basename; max 255 characters)optionalstring
Error scenarios:
ASN does not exist → ASN X not found
ASN already cancelled → ASN X is cancelled, documents cannot be changed
type_id not specified → type_id is required
Unknown type → Invalid type_id X, expected one of ...
Note: for documents uploaded by the client, owner is always Merchant.
Request Example#
{
    "asn_id": 88888,
    "type_id": 2,
    "url": "https://cdn.shipsage.com/asn/bol.pdf",
    "doc_name": "bol.pdf"
}

Response#

KeyValue
errcode0/4000
errmsgok/Error Info
dataData Properties
Data Properties#
NameDescriptionSchema
doc_idNew document idinteger
asn_idASN idinteger
type_idDocument type id (same values as the type_id in the request body; only types 1–6 can be deleted by the client — types 7/8 are warehouse-side proofs and cannot be deleted by the client)integer
doc_nameFile namestring
urlFull URLstring
Response Example#
{
    "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} (Delete ASN Document)#

Only documents uploaded by your own company (owner = Merchant) may be deleted; documents uploaded by the warehouse side cannot be deleted. Documents also cannot be modified when the ASN has been cancelled.

Request#

Params#
TypeNameDescriptionRequired/OptionalSchema
pathitemIdDocument idrequiredinteger
queryapiAPI type

Available Values:
destroy.by-default		requiredenum
Request Example#
DELETE /api/v202206/asn-docs/6002?api=destroy.by-default
Error scenarios:
Document does not exist → ASN doc not found
Attempting to delete a document not uploaded by your own company → Only documents uploaded by the merchant can be deleted
ASN already cancelled → ASN X is cancelled, documents cannot be changed

Response#

KeyValue
errcode0/4000
errmsgok/Error Info
dataData Properties
Data Properties#
NameDescriptionSchema
doc_idDocument idinteger
asn_idASN idinteger
doc_nameFile namestring
Response Example#
{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "doc_id": 6002,
        "asn_id": 88888,
        "doc_name": "bol.pdf"
    }
}
Modified at 2026-09-23 03:18:10
Previous
Tracking
Next
Transfer
Built with