API Reference

Retrieve List of Orders

get
https://api.shipmonk.com/v1/integrations/orders-list

When no filters are specified, the endpoint will return up to the first 1,000,000 orders, based on selected ordering. If filters are used, this endpoint will return a maximum of 10,000 orders.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1

Current pagination page number.

integer
1 to 100
Defaults to 100

Number of results per page.

string
enum
Defaults to ASC

Sort direction for the results. Results are sorted by internal order id.

Allowed:
orderKeys
array of strings | null
Defaults to null

Filter by order keys.

orderKeys
orderNumbers
array of strings | null
Defaults to null

Filter by order numbers.

orderNumbers
enum

Filter by current order state.

enum

Filter by order type.

date-time
Defaults to null

Filter orders updated after this ISO 8601 timestamp.

date-time
Defaults to null

Filter orders updated before this ISO 8601 timestamp.

date-time
Defaults to null

Filter only orders shipped after this timestamp

date-time
Defaults to null

Filter only orders shipped before this timestamp

Response

Updated 7 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago