Abandoned checkouts
Update an abandoned checkout
Fixes the shopper's contact or address before confirming, like editing it on the Abandoned page. Same phone and address rules as an order.
Path parameters
- checkout_idstringRequired
starts with chk_
Body
- customerobject
3 child fields
- namestring
1–160 characters
- phonestring
6–20 characters
- emailstring or null
email · up to 160 characters
- shipping_addressobject
3 child fields
- regionstring
1–10 characters
- citystring
1–160 characters
- address1string
1–500 characters
- notestring or null
up to 1000 characters
Returns
200 OK · The abandoned checkout. AbandonedCheckout
- 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:
