Skip to content

Reference / Orders

Get order

GET/api/v1/stores/{store_id}/orders/{order_id}

An order with lines.

Revenue per campaign →

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.
order_idstringrequired
The order's ID in your shop.

Response

200 The order.

idstringrequired
customerobject | nullrequired
null when the customer has been erased: the order still counts towards the campaign's revenue.
customer.idstringrequired
customer.emailstringrequired
campaign_idstring | nullrequired
financial_statusstringrequired
pendingpaidrefundedcancelled
currencystringrequired
order_totalnumberrequired
tax_totalnumber | nullrequired
shipping_totalnumber | nullrequired
discount_totalnumber | nullrequired
processed_atstring (time, ISO 8601)required
When the order was placed.
linesarray<object>required
lines[].idstringrequired
lines[].product_idstringrequired
lines[].variant_idstring | nullrequired
lines[].titlestring | nullrequired
lines[].quantityintegerrequired
lines[].pricenumberrequired
lines[].discountnumber | nullrequired
created_atstring (time, ISO 8601)required
When the order was first sent in.
updated_atstring (time, ISO 8601)required
When the order was last changed.

Errors