Skip to navigation
API ReferenceOrders

Get Completely Cancelled Orders

View as Markdown

Retrieve the IDs of orders and their associated shipments that have been fully cancelled, meaning all shipments within the order are in a cancelled state.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

PageintegerOptional1-2147483647
Page of orders to get
LimitintegerOptional1-250
Amount of orders per page to request
IsTrackingUploadedbooleanOptional

Indicates whether the Shipment was marked with tracking information uploaded to a third-party system where the order originated

Response

Success
idlongOptional
Unique id of the order
order_numberstring or nullOptional

User-friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used

shipment_idslist of longs or nullOptional
Shipments Ids affiliated with the order

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error