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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

1-based page number to return. Defaults to 1.

pageSize

integer

1 to 100

Defaults to 100

Number of results per page. Defaults to a server-configured value; check the response metadata for the effective size.

sortOrder

string

enum

Defaults to ASC

Sort direction by internal order id: DESC (newest first) or ASC (oldest first).

Allowed:

orderKeys

array of strings | null

Defaults to null

Filter to orders whose order_key matches any value in this list.

orderKeys

orderNumbers

array of strings | null

Defaults to null

Filter to orders whose order_number matches any value in this list.

orderNumbers

orderStatus

Order Status | null

Defaults to null

Filter by current order status (see PublicApiOrderStatus enum); omit to return all statuses.

orderType

Order Type | null

Defaults to null

Filter by order type (see OrderType enum); omit to return all types.

updatedAtStart

date-time

Defaults to null

Lower bound (inclusive) on updated_at as an ISO 8601 timestamp; returns orders updated at or after this time.

updatedAtEnd

date-time

Defaults to null

Upper bound (inclusive) on updated_at as an ISO 8601 timestamp; returns orders updated at or before this time.

shippedAtStart

date-time

Defaults to null

Lower bound (inclusive) on shipped_at as an ISO 8601 timestamp; returns orders shipped at or after this time.

shippedAtEnd

date-time

Defaults to null

Upper bound (inclusive) on shipped_at as an ISO 8601 timestamp; returns orders shipped at or before this time.

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success