Skip to content
AzimeaDocs
Dashboard
GET
/commerce/orders
curl --request GET \
--url 'https://api.azimea.com/v1/commerce/orders?storeId=null&search=null&status=null&view=Paid&days=30&page=1&pageSize=50' \
--header 'Authorization: Bearer <token>'

The orders of your connected stores, newest first, in pages (page from 1, pageSize 1–200, default 50). Statuses are the same for every platform: Pending, Paid, Completed, Cancelled, Refunded, Failed, Draft. Filter by storeId, by status, by view (All, Paid = paid or completed, Pending, Abandoned = orders left at checkout, Refunded), by the last days (1–3660, by placement date), or with search over the order number, email and name (at most 100 characters). Needs the orders:read permission.

storeId
string format: guid
nullable
Example
null
search
string
nullable
Example
null
status
string
nullable
Allowed values: Pending Paid Completed Cancelled Refunded Failed Draft
Example
null
view
required
string
Allowed values: All Paid Pending Abandoned Refunded
Example
Paid
days
integer format: int32
nullable
Example
30
page
required
integer format: int32
Example
1
pageSize
required
integer format: int32
Example
50

One page of orders

Media typeapplication/json
object
isSuccess

true when the call worked, false when errors say why it did not.

boolean
value

The answer itself; null when the call failed.

object
items

The orders on this page, newest first.

Array<object>
object
id

Azimea’s id for the order.

string format: guid
storeId

The connected store the order came from.

string format: guid
number

The order number as the buyer sees it; it can differ from the store’s internal id.

string
nullable
status

Where the order stands. See the order statuses catalog.

string
Allowed values: Pending Paid Completed Cancelled Refunded Failed Draft
currency

The three-letter currency code of total.

string
nullable
total

The order’s total, in currency.

number format: decimal
email

The buyer’s email address.

string
nullable
customerName

The buyer’s name.

string
nullable
placedAt

When the order was placed.

string format: date-time
nullable
paidAt

When it was paid; null while it is not.

string format: date-time
nullable
lineCount

How many lines (products) the order has.

integer format: int32
page

The page number, starting at 1.

integer format: int32
pageSize

How many orders a full page holds.

integer format: int32
totalCount

How many orders match in all, across every page.

integer format: int32
status

An internal result number. Rely on the HTTP status code instead.

integer format: int32
errors

What went wrong, one entry per problem; empty when the call worked.

Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
fieldErrors

The same problems grouped by the request field they belong to; null when none is tied to a field.

object
key
additional properties
Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
Example
{
"isSuccess": true,
"value": {
"items": [
{
"id": "01a10900-0000-7000-8000-000000000101",
"storeId": "01a10900-0000-7000-8000-000000000201",
"number": "1042",
"status": "Paid",
"currency": "EUR",
"total": 129.9,
"email": "emma@example.com",
"customerName": "Emma Clarke",
"placedAt": "2026-10-04T18:12:00+00:00",
"paidAt": "2026-10-04T18:13:00+00:00",
"lineCount": 2
}
],
"page": 1,
"pageSize": 50,
"totalCount": 1
},
"status": 0,
"errors": [],
"fieldErrors": null
}

Validation failed: see errors[].code and fieldErrors

Media typeapplication/json
object
isSuccess

true when the call worked, false when errors say why it did not.

boolean
value

The answer itself; null when the call failed.

nullable
status

An internal result number. Rely on the HTTP status code instead.

integer format: int32
errors

What went wrong, one entry per problem; empty when the call worked.

Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
fieldErrors

The same problems grouped by the request field they belong to; null when none is tied to a field.

object
key
additional properties
Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
Example
{
"isSuccess": false,
"value": null,
"status": 5,
"errors": [
{
"code": "validation.required",
"message": "Fill in this field.",
"params": null
}
],
"fieldErrors": {
"email": [
{
"code": "validation.required",
"message": "Fill in this field.",
"params": null
}
]
}
}

Missing or invalid API key

The key lacks the orders:read permission

Too many requests for this key