Skip to main content
GET
Retrieve orders

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Scopes

shop.readonly

Read products and orders

shop

Read and write products and orders

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

categoryRef
string

Filter by the shop categories of the products in the order. Use none for products without a category. Comma-separated, one or more UUIDs or "none".

createDate[gte]
string

Filter orders created on or after this date (ISO 8601). Use with createDate[lte] for a range.

createDate[lte]
string

Filter orders created on or before this date (ISO 8601). Use with createDate[gte] for a range.

customerRef
string<uuid>

UUID of the customer whose orders to list.

limit
integer

Maximum number of orders per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

Required range: 1 <= x <= 100
locationRef
string<uuid>

UUID of the location whose orders to list. Omit locationRef, customerRef and userRef to list orders across every location of the network, newest first.

nextPageToken
string

Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

productRef
string

Filter by the products in the order. Comma-separated, one or more UUIDs.

status
string

Filter by order status: 'pending' placed, payment still processing; 'new' placed and paid, awaiting fulfillment; 'inProgress' being fulfilled; 'completed' fulfilled; 'canceled' canceled by the customer or an admin. Defaults to new, inProgress and completed. Comma-separated, one or more of: canceled, completed, inProgress, new, pending.

userRef
string<uuid>

UUID of the user whose orders to list.

Response

OK

orders
object[]
required

List of orders.

nextPageToken
string

Pagination token to fetch the next page of results.

searchQueryNext
string

Search query parameters for the next page of results. Includes all filters used to fetch the current page.