Skip to main content
POST
commerce.orders.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
locationIds
string[]
required

Search 1 to 10 locations in your connected account.

Required array length: 1 - 10 elements

Location from local.locations.list.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9_-]+$
states
enum<string>[]

Only these order states.

Required array length: 1 - 4 elements
Available options:
open,
completed,
canceled,
draft
customerIds
string[]

Only orders for these customers.

Required array length: 1 - 10 elements

Customer in your connected account.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9_-]+$
sourceNames
string[]

Only these source applications.

Required array length: 1 - 10 elements

Source application name.

Required string length: 1 - 255
createdAfter
string<date-time>

Inclusive creation-time start, ISO 8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
createdBefore
string<date-time>

Exclusive creation-time end, ISO 8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
sortOrder
enum<string>
default:desc

Sort by creation time, newest first by default.

Available options:
asc,
desc
includeFulfillment
boolean
default:false

Return recipient contact details and shipping address.

limit
number

How many orders to return, 1 to 50; default 10.

Required range: x >= 1
cursor
string

nextCursor from the previous page with the same filters.

Required string length: 1 - 512

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.