/orders/

get

http://app.shippingtree.co/api/orders/

Retrieve order list including search & filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

status

number

Unworkable:

STATUS_CANCELLED = 10

Project Orders / VAS:

STATUS_PROJECT_ORDER = 40

Unfulfilled:

STATUS_PAUSED = 70
STATUS_BACKORDERED = 80
STATUS_RECEIVED = 90

In Fulfillment:

STATUS_PROCESSING = 100
STATUS_PICKED = 110
STATUS_PACKED = 120
STATUS_LABEL_PURCHASE_FAIL = 145
STATUS_RATE_LIMIT_EXCEEDED = 150
STATUS_LABEL_PURCHASED = 160

Fulfilled:

STATUS_SHIPPED = 200
STATUS_DELIVERED = 300

warehouse

number

Filter by Warehouse

originator_number

string

Filter by Originator Number

b_to_b

boolean

Filter by B2B orders

after_id

string

Cursor-based forward pagination. Returns only records with id strictly greater than the given value. Use the id of the last record in the previous page to fetch the next page.

before_id

string

Cursor-based backward pagination. Returns only records with id strictly less than the given value. Use the id of the first record in the current page to fetch the previous page.

created_after

string

Return records created on or after this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T00:00:00Z).

created_before

string

Return records created on or before this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T23:59:59Z).

updated_after

string

Return records updated on or after this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T00:00:00Z).

updated_before

string

Return records updated on or before this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T23:59:59Z).

shipped_after

string

Return orders shipped on or after this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T00:00:00Z).

shipped_before

string

Return orders shipped on or before this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T23:59:59Z).

delivered_after

string

Return orders delivered on or after this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T00:00:00Z).

delivered_before

string

Return orders delivered on or before this datetime. Accepts ISO 8601 format (e.g. 2024-01-15T23:59:59Z).

originator_id

string

Filter by Originator Id

string

Search from the following fields: sku, barcode

ordering

string

Sort results by one or more fields. Allowed fields: created, updated, id, status, shipped, delivered. Prefix with - for descending order (e.g. -created). Default: -created.

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

Responses

400

Bad Request

200