Orders
Get an order
The full order by its ID.
GET/stores/{storeId}/v1/orders/{id}
Path parameters
- idstringrequired
Response
- dataobjectrequired
- idstringrequired
- Stable order ID.
- numberintegerrequired
- Order number shown to the merchant and the customer.
- statusstringrequired
- Order status as the merchant sees it. Any refund makes it returned.
pendingprocessingcompletedcancelledreturned - payment_statusstringrequired
unpaidpaidrefunded- currencystringrequired
- totalsobjectrequired
- subtotalstring
- Items total before discount and shipping.
- discountstring
- Discount.
- shippingstring
- Shipping fee.
- totalstringrequired
- Amount paid by the customer.
- itemsarray<object>required
- product_idstringrequired
- namestringrequired
- Product name at the time of the order.
- kindstring
- Product kind.
digitalphysicalservice - quantityintegerrequired
- unit_pricestringrequired
- Unit price in SAR.
- totalstringrequired
- Unit price × quantity.
- order_urlstring | null (uri)
- The customer's orders page in the store (<store origin>/orders), the same link as the order email. It is not a link to one order and carries no sign-in token. null when the store has no https domain.
- created_atstring (date-time)required
- updated_atstring (date-time)required
- paid_atstring | null (date-time)
- refunded_atstring | null (date-time)
- customerobject
- Included only with the customers:read scope.Returned with
customers:readRead customer contact details - idstring | null
- The customer's account ID in the store, or null for a guest order.
- namestring | null
- The customer's name as entered.
- phonestring | null
- Phone number in E.164 format, such as +966512345678, or null if it is not a valid number.
- emailstring | null (email)
- shipping_addressobject | null
- Shipping address as entered by the customer, or null when the order has no address. Included only with customers:read.Returned with
customers:readRead customer contact details - namestring | null
- phonestring | null
- E.164 format, or null.
- countrystring | null
- Always SA.
- citystring | null
- districtstring | null
- streetstring | null
- postal_codestring | null
- short_address_codestring | null
- building_numberstring | null
- secondary_numberstring | null
- notesstring | null
- resource_versioninteger
- Always 0 for orders. Order the events of one order by resource.version in the webhook envelope.
- metaobjectrequired
- request_idstring (uuid)
- The request ID; include it in any support request.
Errors
| HTTP | Code | Meaning |
|---|---|---|
| 404 | RESOURCE_NOT_FOUND | The ID does not exist in this store. |
| 403 | SCOPE_REQUIRED | The token does not carry the required scope. |
| 503 | APPS_SCOPE_RUNTIME_NOT_READY | The resource is not enabled on this merchant's store yet. |
Shared codes are listed in Errors.