Abandoned checkouts
List abandoned checkouts
Shoppers who left their details at checkout without ordering (the Abandoned page). Newest first; with updated_since, oldest change first.
Query parameters
- limitinteger
How many objects to return, 1–100. Default 25.
1–100
- cursorstring
The
next_cursorfrom the previous page. Repeat the same filters with it.up to 512 characters
- updated_sincestring
Only objects changed at or after this moment (ISO-8601). Switches the order to oldest change first, so you can store the last
updated_atyou saw and resume from it. Objects changed in the same second may be returned again — de-duplicate byid.ISO 8601 date-time, UTC
- created_sincestring
Only objects created at or after this moment (ISO-8601).
ISO 8601 date-time, UTC
- statusstring
One of
open,confirmed,recovered,deleted - phonestring
The shopper's phone, E.164 or national.
6–20 characters
Returns
200 OK · A page of abandoned checkouts. AbandonedCheckoutList
- objectstringRequired
always "list"
- has_morebooleanRequired
- next_cursorstring or nullRequired
Pass as
cursorto get the next page.nullon the last page. - dataarray of AbandonedCheckoutsRequired
17 child fields
- idstring
starts with chk_
- objectstring
always "abandoned_checkout"
- statusstring
open: still abandoned. confirmed / recovered: the team turned it into an order (order_id). deleted: removed by the team, or closed after 30 days without activity. A checkout the shopper finished themselves is deleted outright (see abandoned_checkout.updated).
One of
open,confirmed,recovered,deleted - customerobject
3 child fields
- namestring or null
- phonestring
- emailstring or null
- shipping_addressobject
4 child fields
- countrystring
- regionobject or null
2 child fields
- codestring
- namestring or null
- cityobject or null
2 child fields
- codeany or null
- namestring
- address1string or null
- notestring or null
- line_itemsarray of objects
7 child fields
- product_idstring or null
- variant_idstring or null
- titlestring
- variant_titlestring or null
- image_urlstring or null
- quantityinteger
- unit_priceMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- subtotalMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- totalMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- deliveryobject
2 child fields
- modestring or null
One of
home,pickup_point - labelstring or null
- order_idstring or null
The order it became
- assigned_toobject or null
2 child fields
- idstring
- namestring
- sourcestring or null
Where the shopper came from (an ad
- recovered_atstring or null
ISO 8601 date-time, UTC
- created_atstring
ISO 8601 date-time, UTC
- updated_atstring
ISO 8601 date-time, UTC
- livemodeboolean
Errors
Every error has the same shape. This endpoint can answer with:
