/stores/:store_api_key/orders

get

https://api.shippingeasy.com/api/stores/:store_api_key/orders

Search and filter orders for a specific store on an account

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

Defaults to 1

The page to return in the paginated result set

per_page

int32

Defaults to 50

The number of result to include per pagein the paginated result set. The maximum number of results returned per page is 200.

last_updated_at

date

Defaults to 1 week ago

Filters the results by the orders' last updated at timestamp and only returns results with a timestamp newer than or equal to the specified value. The maximum time this value can be set to is 3 months ago. Note that "1 week ago" is the default, but cannot be used literally - you must specify a timestamp, for example: last_updated_at=2017-05-24T19:38:25.000-00:00

status

array of strings

Filters the results by the orders' ShippingEasy order status. Possible values are "shipped", "cleared", "pending_shipment", and "ready_for_shipment". It is possible to pass an array of statuses, e.g. ["shipped", "ready_for_shipment"]

status

includes

string

Adds information to the response. Specifying includes=products will deliver additional information (if available) about each product in the order.

order_number

string

The external_order_identifier to search for

Responses

200200

400400