Developers

Abandoned carts

Markdown

Get an abandoned cart

A single cart by its ID.

GET/stores/{storeId}/v1/abandoned-carts/{id}

Path parameters

idstringrequired

Response

dataobjectrequired
idstringrequired
currencystringrequired
totalstringrequired
Cart total.
itemsarray<object>required
product_idstringrequired
namestringrequired
Product name at the time of the order.
kindstring
Product kind.digital physical service
quantityintegerrequired
unit_pricestringrequired
Unit price in SAR.
totalstringrequired
Unit price × quantity.
checkout_urlstring (uri)required
The same checkout link the store sends in its abandoned-cart reminder.
created_atstring (date-time)required
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)
metaobjectrequired
request_idstring (uuid)
The request ID; include it in any support request.

Errors

HTTPCodeMeaning
404RESOURCE_NOT_FOUNDThe ID does not exist in this store.
403SCOPE_REQUIREDThe token does not carry the required scope.
503APPS_SCOPE_RUNTIME_NOT_READYThe resource is not enabled on this merchant's store yet.

Shared codes are listed in Errors.

    ↑↓ moveEnter openEsc close