Skip to main content
GET
/
v1
/
abandoned_checkouts
List
curl --request GET \
  --url https://{defaultHost}/v1/abandoned_checkouts \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/abandoned_checkouts"
  },
  "data": [
    {
      "id": "8f5eaf4f-a570-4a89-a5d5-1558402731c2",
      "object": "abandoned_checkout",
      "notifications_enabled": true,
      "notification_status": "not_scheduled",
      "notifications_scheduled_at": [],
      "portal_url": "http://app.example.com/portal_redirect/abandoned_checkouts/8f5eaf4f-a570-4a89-a5d5-1558402731c2",
      "recovery_status": "abandoned",
      "recovered_at": null,
      "checkout": "ec79677a-4f64-449c-8290-1937c966d329",
      "customer": "0add6b46-419c-423f-a200-da9692e54fef",
      "promotion": null,
      "recovered_checkout": null,
      "created_at": 1771427743,
      "updated_at": 1771429843
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_ids[]
string[]

Only return objects that belong to the given customers.

ids[]
string[]

Only return objects with the given IDs.

limit
integer

A limit on the number of items to be returned, between 1 and 100.

live_mode
boolean

Only return objects that are live mode or test mode.

notification_status[]
string[]

Only return objects with the given notification_status.

page
integer

The page of items you want returned.

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.