Abandoned carts
List abandoned carts
Unpaid carts the store treats as abandoned, newest first, with a checkout link.
GET/stores/{storeId}/v1/abandoned-carts
Query parameters
- limitinteger = 25
- Number of items per page.
- cursorstring
- The meta.next_cursor value from the previous page. Valid for 15 minutes and bound to the same filters.
- created_afterstring (date-time)
- Carts created after this time.
Response
- dataarray<object>required
- idstringrequired
- currencystringrequired
- totalstringrequired
- Cart total.
- 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.
- 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
- next_cursorstring | null
- Cursor for the next page, or null on the last page.
- request_idstring (uuid)
Errors
| HTTP | Code | Meaning |
|---|---|---|
| 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.