List orders

Scope

• ecommerce:read Read e-commerce – the person behind the key must be all members.

Path parameters

store_idstringrequired

The store's ID, which you choose.

Query parameters

limitinteger

The maximum number of items in the response (1–250, default 100).at least 1 · at most 250 · default 100

cursorstring

next_cursor from the previous response, for the next page. Omit for the first page.

customer_idstring

Only the customer's orders (the store's customer ID).

campaign_idstring

Only orders from the campaign.

financial_statusstring

Only orders with that status.pendingpaidrefundedcancelled

updated_sincestring

Only what has changed since then (ISO 8601).

Response

200 A page of orders.

dataarray<object>required

data[].idstringrequired

data[].customerobject | nullrequired

null when the customer has been erased: the order still counts towards the campaign's revenue.

data[].customer.idstringrequired

data[].customer.emailstringrequired

data[].campaign_idstring | nullrequired

data[].financial_statusstringrequired

pendingpaidrefundedcancelled

data[].currencystringrequired

data[].order_totalnumberrequired

data[].tax_totalnumber | nullrequired

data[].shipping_totalnumber | nullrequired

data[].discount_totalnumber | nullrequired

data[].processed_atstring (time, ISO 8601)required

When the order was placed.

data[].linesarray<object>required

data[].lines[].idstringrequired

data[].lines[].product_idstringrequired

data[].lines[].variant_idstring | nullrequired

data[].lines[].titlestring | nullrequired

data[].lines[].quantityintegerrequired

data[].lines[].pricenumberrequired

data[].lines[].discountnumber | nullrequired

data[].created_atstring (time, ISO 8601)required

When the order was first sent in.

data[].updated_atstring (time, ISO 8601)required

When the order was last changed.

has_morebooleanrequired

There are more: fetch the next page with cursor=next_cursor.

next_cursorstring | nullrequired

Send as cursor for the next page. null on the last page.

Errors

401

unauthenticatedinvalid_keykey_revokedkey_expiredkey_inactive

402

payment_required

403

insufficient_scopeforbiddenworkspace_suspended

404

not_found

422

validation_failed

429

rate_limited

500

internal_error