Shipping

Endpoints

Method	Endpoint	Description
GET	/api/v202105/shippings	Retrieves a list of shippings

Header

Key	Value
Authorization	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi ...

GET /api/v202105/shippings

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	trx_id	Shipsage Transaction ID	optional	string
query	platform_order_id	Platform Order Number	optional	string
query	customer_order_id	Customer Order Number	optional	string
query	account_id	Sales Account ID	optional	integer
query	account_name	Sales Account Name	optional	string
query	create_time_start	Create Time Start timezone:PST	optional	datetime
query	create_time_end	Create Time End timezone:PST	optional	datetime
query	update_time_start	Update Time Start timezone:PST	optional	datetime
query	update_time_end	Update Time End timezone:PST	optional	datetime

Response

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

Data Properties

Name	Description
shipping_id	The shipsage shipping id	integer
carrier	The transport company	string
service_type_name	The carrier service type name	string
warehouse_name	The warehouse name	string
tracking_number	The tracking number	string
is_reship	Whether reship Available Values: 0:not reship, 1:reship	enum
length	The box length (inch)	double
width	The box width (inch)	double
height	The box height (inch)	double
weight_lb	The box weight in pounds	integer
weight_oz	The box weight in ounces	integer
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
status	The shipping status Available Values: CREATED, PICKED, PACKED, FINAL SCANNED，UNFULFILLABLE，VOIDED，PENDING，SYNCED	enum
final_scan_time	The warehouse final scan time timezone:PST	datetime
shipping_fee _estimated	The estimated shipping fee	double
shipping_fee	The shipping fee	double
handling_fee	The handling fee	double
packing_material_fee	The packing material fee	double
create_time	The shipping create time timezone:PST	datetime
update_time	The shipping update time timezone:PST	datetime
detail_items	Shipping detail items	array
detail_items.*.shipping_id	The shipsage shipping id	integer
detail_items.*.trx_id	The shipsage order number	string
detail_items.*.platform_order_id	The platform order number	string
detail_items.*.customer_order_id	The customer order number	string
detail_items.*.account_id	The sales account id	string
detail_items.*.account_name	The sales account name	string
detail_items.*.product_id	The shipsage product id	integer
detail_items.*.sku	The shipsage sku	integer
detail_items.*.customer_sku	The customer sku	string
detail_items.*.product_name	The product name	string
detail_items.*.qty	The shipping qty	integer

Data Demo

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

Endpoints#

Header#

GET /api/v202105/shippings#

Request#

Params#

Response#

Data Properties#

Data Demo#

Endpoints

Header

GET /api/v202105/shippings

Request

Params

Response

Data Properties

Data Demo