Get Orders

View as Markdown
All parameters are AND filters

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Headers

shipbob_channel_idstringOptionalformat: "int32"
Channel Id for Operation

Query parameters

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

order ids to filter by, comma separated
Example: ?IDs=1,2

ReferenceIdsstringOptional

Reference ids to filter by, comma separated
Example: ?ReferenceIds=Ref1,Ref2

StartDatedatetimeOptional
Start date to filter orders inserted later than
EndDatedatetimeOptional
End date to filter orders inserted earlier than
SortOrderstringOptional
Order to sort results in
HasTrackingbooleanOptional
Has any portion of this order been assigned a tracking number
LastUpdateStartDatedatetimeOptional
Start date to filter orders updated later than
LastUpdateEndDatedatetimeOptional
End date to filter orders updated later than
IsTrackingUploadedbooleanOptional
Filter orders that their tracking information was fully uploaded
LastTrackingUpdateStartDatedatetimeOptional
Start date to filter orders with tracking updates later than the supplied date. Will only return orders that have tracking information
LastTrackingUpdateEndDatedatetimeOptional
End date to filter orders updated later than the supplied date. Will only return orders that have tracking information

Response

Success

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error