Order

Endpoints

Method	Endpoint	Description
GET	/api/v202105/orders	Retrieves a list of orders
POST	/api/v202105/orders	Create a new order
POST	/api/v202105/orders	Cancel an order

Header

Key	Value
Authorization	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi ...

GET /api/v202105/orders

Request

Params

Type	Name	Description	Required/Optional	Schema
query	api	The API type Available Values: index.by-default	required	enum
query	next_token	The next page data	optional	string
query	platform_order_id	The platform order number	optional	string
query	customer_order_id	The customer order number	optional	string
query	account_id	The sales account ID	optional	integer
query	account_name	The sales account name	optional	string
query	create_time_start	The shipsage order create time start timezone:PST	optional	datetime
query	create_time_end	The shipsage order create time end timezone:PST	optional	datetime
query	update_time_start	The shipsage order update time start timezone:PST	optional	datetime
query	update_time_end	The shipsage order update time end timezone:PST	optional	datetime
query	status	The shipsage order status Available Values: Synced, To Be Confirmed, Confirmed, Processing, Cancelled, Fulfillment, Shipped	optional（If the status parameter is filled,the create_time_start parameter is required ）	enum

Response

Key	Value
errcode	0/4000
errmsg	ok/Error Info
data	Data Properties

Data properties

Name	Description	Schema
trx_id	The shipsage order number	string
platform_order_id	The platform order number	string
customer_order_id	The customer order number	string
account_name	The sales account name	string
order_time	The customer order created time timezone:PST	datetime
paid_time	The customer order paid time timezone:PST	datetime
shipped_time	The customer order shipped time timezone:PST If an order contains multiple packages, the shipping time of the earliest package will be taken	datetime
ship_to_name	The recipient's name	string
ship_to_address1	The recipient's address one	string
ship_to_address2	The recipient's address two	string
ship_to_phone	The recipient's phone	string
ship_to_city	The recipient's address city	string
ship_to_state	The recipient's address state	string
ship_to_country	The recipient's address country	string
ship_to_postal_code	The recipient's address postal code	string
selling_sku	The selling sku	string
customer_sku	The customer sku	string
item_id	The shipsage listing id	string
title	The order title	string
quantity	The selling sku quantity	integer
status	The shipsage order status Available Values: Synced, To Be Confirmed, Confirmed, Processing, Cancelled, Fulfillment, Shipped	enum
create_time	The shipsage order create time timezone:PST	datetime
update_time	The shipsage order update time timezone:PST	datetime

Data Demo

[
    {
        "trx_id": "33693018972994",
        "platform_order_id": null,
        "customer_order_id": null,
        "account_name": "DemoSeller",
        "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_name": "John Doe",
        "ship_to_address1": "123 Main Street",
        "ship_to_address2": "Suite 100",
        "ship_to_phone": null,
        "ship_to_city": "Springfield",
        "ship_to_state": "CA",
        "ship_to_country": "US",
        "ship_to_postal_code": "90001"
        "seller_sku": "123456",
        "customer_sku": "130798",
        "item_id": "1234QSWZBYK",
        "title": "Sample Product",
        "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_name": "DemoSeller",
        "created_date": "2022-03-02 20:31:36",
        "paid_time": "2022-03-03 07:09:43",
        "ship_to_name": "John Doe",
        "ship_to_address1": "123 Main Street",
        "ship_to_address2": "Suite 100",
        "ship_to_phone": null,
        "ship_to_city": "Springfield",
        "ship_to_state": "CA",
        "ship_to_country": "US",
        "ship_to_postal_code": "90001"
        "seller_sku": "123456",
        "customer_sku": "130798",
        "item_id": "1234QSWZBYK",
        "title": "Sample Product",
        "quantity": 1,
        "status": "Synced",
        "create_time": "2022-03-03 01:00:28",
        "update_time": "2022-03-03 02:00:33"
    }
]

POST /api/v202105/orders

Request

Params

Type	Name	Description	Required/Optional	Schema
query	api	The API type Available Values: *index.by-default*	required	enum
body	account_name	The sales account name	required	string
body	platform_order_id	The platform order number	required	string
body	customer_order_id	The customer order number	optional	string
body	order_time	The customer order created time timezone:PST	required	datetime
body	paid_time	The customer order paid time timezone:PST	required	datetime
body	ship_to_name	The recipient's name	required	string
body	ship_to_address1	The recipient's address one	required	string
body	ship_to_address2	The recipient's address two	optional	string
body	ship_to_phone	The recipient's phone	required	string
body	ship_to_city	The recipient's address city	required	string
body	ship_to_state	The recipient's address state	required	string
body	ship_to_country	The recipient's address country	required	string
body	ship_to_postal_code	The recipient's address postal code	required	string
body	platform	The order platform	optional	string
body	warehouse_id	The order’s assigned 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)	optional	string
body	latest_ship_date	the latest ship date ship out from warehouse	optional	date
body	carrier	carrier The order ’s shipping carrier; such as: UPS, USPS, DHL, FedEx...etc.	optional	string
body	carrier_service	carrier service such as UPS Ground, UPS Sure Post, Fedex Ground Home Delivery, Fedex Ground...etc.	optional	string
body	prime	prime: 0 or 1	optional	integer
body	shipping_items	The order ’s shipping carrier; such as: UPS, USPS, DHL, FedEx...etc.	optional	shipping_items
body	product_items	The order product items	required	array
body	product_items.*.selling_sku	The selling sku	required	string
body	product_items.*.quantity	The selling sku quantity	required	integer
body	product_items.*.unit_price	The selling sku unit_price	optional	double
body	product_items.*.order_item_id	The order item id	optional	string

shipping_items

Type	Name	Description	Required/Optional	Schema
body	packing_slip	The order’s shipping packing slip attachment	optional	array
body	bol	The order’s shipping bol attachment	optional	array
body	labels	The order’s shipping label data	required	array
body	labels.*.tracking_number	shipping label ‘s tracking number	required	string
body	labels.*.shipping_carrier	shipping carrier, like UPS/FedEx/DHL/USPS…etc. "If provided, this value takes priority. If omitted, the system auto-detects from tracking_number. If auto-detection fails, the top-level carrier is used as fallback."	optional	string
body	labels.*.shipping_method	Shipping method, like UPS Ground, UPS Sure Post…etc. "If provided, this value takes priority. If omitted, the system auto-detects from tracking_number. If auto-detection fails, the top-level carrier_service is used as fallback."	optional	string
body	labels.*.with_packing_slip	Indicates whether labels.*.url is a merged multi-page PDF containing the shipping label, packing slip, and (optionally) BOL. When true, the system splits the PDF by physical page: Page 1 → shipping label, Page 2 → packing slip, Page 3 → BOL. In this mode, do not submit packing_slip.url. Defaults to false.	required	string
body	labels.*.url	Shipping item’s shipping label url. url or base64 must be provided	optional	string
body	labels.*.base64	Shipping item’s shipping label file base64. url or base64 must be provided.	optional	base64
body	labels.*.details	label shipping items.	required	array
body	labels.*.details.selling_sku	label shipping item’s product.	required	string
body	labels.*.details.quantity	label shipping item’s product quantity.	required	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":"CityName",
    "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"
        }
    ]
}

Response

Key	Value
errcode	0/4000
errmsg	ok/Error Info
data	Data Properties

Data properties

Name	Description	Schema
account_name	The sales account name	string
platform_order_id	The platform order number	string
customer_order_id	The customer order number	string
order_time	The customer order created time timezone:PST	datetime
paid_time	The customer order paid time timezone:PST	datetime
ship_to_name	The recipient's name	string
ship_to_address1	The recipient's address one	string
ship_to_address2	The recipient's address two	string
ship_to_phone	The recipient's phone	string
ship_to_city	The recipient's address city	string
ship_to_state	The recipient's address state	string
ship_to_country	The recipient's address country	string
ship_to_postal_code	The recipient's address postal code	string
trx_items	The shipsage order detail	array
trx_items.*.trx_id	The shipsage order number	string
trx_items.*.item_id	The shipsage lisnting id	string
trx_items.*.order_id	The platform order number	string
trx_items.*.account_name	The sales account name	string
trx_items.*.selling_sku	The selling sku	string
trx_items.*.product_name	The selling sku name	string
trx_items.*.quantity	The selling sku quantity	integer
trx_items.*.unit_price	The selling sku unit_price	double

Data Demo

{
    "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

Request

Params

Type	Name	Description	Required/Optional	Schema
query	api	The API type Available Values: store.by-cancel-order	required	enum
body	platform_order_id	The platform order number,platform_order_id and customer_order_id must fill in one	optional	string
body	customer_order_id	The customer order number,platform_order_id and customer_order_id must fill in one	optional	string

Body Demo

{
  
      "platform_order_id": "PON-01"
}

Response

Key	Value
errcode	0/4000
errmsg	ok/Error Info
data	Data Properties

Data properties

Name	Description	Schema
trx_id	The shipsage order number	string
account_name	The sales account name	string
platform_order_id	The platform order number	string
customer_order_id	The customer order number	string

Data Demo

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "trx_id": "YC-PON-01-310001",
      "account_name": "ShipSageTest",
      "platform_order_id": "PON-01",
      "customer_order_id": "CON-01"
    },
    {
      "trx_id": "YC-PON-01-310002",
      "account_name": "ShipSageTest",
      "platform_order_id": "PON-01",
      "customer_order_id": "CON-01"
    }
  ]
}

Endpoints#

Header#

GET /api/v202105/orders#

Request#

Params#

Response#

Data properties#

Data Demo#

POST /api/v202105/orders#

Request#

Params#

Body Demo#

Response#

Data properties#

Data Demo#

POST /api/v202105/orders#

Request#

Params#

Body Demo#

Response#

Data properties#

Data Demo#

#

Endpoints

Header

GET /api/v202105/orders

Request

Params

Response

Data properties

Data Demo

POST /api/v202105/orders

Request

Params

Body Demo

Response

Data properties

Data Demo

POST /api/v202105/orders

Request

Params

Body Demo

Response

Data properties

Data Demo