List Abandoned Carts

This endpoint allows you to list abandoned carts that contain all the needed data that you can use to help customers continue the purchasing process.

An abandoned cart occurs when a customer adds an item to their cart and does not complete the purchase.

Scopes

carts.read- Carts Read Only

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

page

integer

optional

The Pagination page number

offset

integer

optional

Returns all the carts created within or before an offset time. EX: 15 minutes

per_page

number

optional

The number of abandoned carts to show in one query

<= 65

Responses

🟢200Success

application/json

Body

status

string

optional

success

string

optional

data

array[object (AbandonedCart) {11}]

optional

number

required

A unique identifier associated with a shopping cart. List of abandond carts can be found here.

total

object

required

subtotal

object

required

total_discount

object

required

checkout_url

string

required

A web link that directs a user to a specific page where they can proceed with the final steps of a purchase.

age_in_minutes

number

required

The age of cart, aka the time difference between cart's created_at and time now in minutes.

created_at

object

required

updated_at

object

required

customer

object

required

coupon

object

required

items

array [object {6}]

required

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

Example

{
  "status": "string",
  "success": "string",
  "data": [
    {
      "id": 0,
      "total": {
        "amount": 0,
        "currency": "string"
      },
      "subtotal": {
        "amount": 0,
        "currency": "string"
      },
      "total_discount": {
        "amount": 0,
        "currency": "string"
      },
      "checkout_url": "string",
      "age_in_minutes": 0,
      "created_at": {
        "date": "string",
        "timezone_type": 0,
        "timezone": "string"
      },
      "updated_at": {
        "date": "string",
        "timezone_type": 0,
        "timezone": "string"
      },
      "customer": {
        "id": 0,
        "name": "string",
        "mobile": "string",
        "email": "string",
        "avatar": "string",
        "country": "string",
        "city": "string"
      },
      "coupon": {
        "id": 0,
        "code": "string",
        "status": "expired",
        "type": "string",
        "amount": {
          "amount": 0,
          "currency": "string"
        },
        "minimum_amount": {
          "amount": 0,
          "currency": "string"
        },
        "expiry_date": "string",
        "created_at": {
          "date": "string",
          "timezone_type": 0,
          "timezone": "string"
        }
      },
      "items": [
        {
          "id": 0,
          "product_id": 0,
          "quantity": 0,
          "weight": 0,
          "amounts": {
            "price_without_tax": {
              "amount": 0,
              "currency": "string"
            },
            "total_discount": {
              "amount": 0,
              "currency": "string"
            },
            "tax": {
              "percent": "string",
              "amount": {
                "amount": 0,
                "currency": "string"
              }
            },
            "total": {
              "amount": 0,
              "currency": "string"
            }
          },
          "notes": "string"
        }
      ]
    }
  ],
  "pagination": {
    "count": 0,
    "total": 0,
    "perPage": 65,
    "currentPage": 0,
    "totalPages": 0,
    "links": {
      "next": "string",
      "previous": "string"
    }
  }
}

🟠401Unauthorized

Request

Request samples

Responses