Get Shopper Carts

GET 
/v2/carts

You can retrieve the carts that are associated with an account or a customer.

When a shopper retrieves their latest carts, the carts are sorted in descending order by the updated_date. For more information, see Pagination.

note

Requires an implicit token with only one of Account Management Authentication Token or customer token.

Request

Header Parameters

EP-Account-Management-Authentication-Token string

An Account Management Authentication token to access a specific account's carts.

x-moltin-customer-token string

A customer token to access a specific customer's carts.

Responses

200

Response Headers

application/json

Schema

Schema

data object[]
Array [
id string
The unique identifier for the cart. Use SDK or create it yourself.
type string
The type of object being returned.
name string
The name of this cart.
description string
A description of the cart.
discount_settings object
custom_discounts_enabled boolean
This parameter enables custom discounts for a cart. When set to true, Elastic Path promotions will not be applied to the new carts. Default is set from cart discount settings for the store. See Cart Settings.
use_rule_promotions boolean
When set to true, this parameter allows the cart to use rule promotions.
payment_intent_id string
Stripe-assigned unique identifier for the linked Payment Intent
links object
self string
A link to that specific resource.
meta object
display_price object
with_tax object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
without_tax object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
tax object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
discount object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
without_discount object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
shipping object
amount number
The raw total of this cart.
currency string
The currency set for this cart.
formatted string
The tax inclusive formatted total based on the currency.
timestamps object
created_at string
The date this was created.
updated_at
The date this was last updated.
relationships object
customers object
data object
type string
The type of related object.
id uuid
The ID of the customer.
items object
data object
type string
The type of related object.
id uuid
The unique identifier for the cart item
]
links object

current string

Always the current page.

first string

Always the first page.

last string

If there is only one page, it is null.

next string

If there is only one page, it is null.

prev string

if the user is on the first page, it is null.

meta object

page object

current integer

The current page.

limit integer

The maximum number of records per page for this response. You can set this value up to 100.

offset integer

The current offset by number of records, not pages. Offset is zero-based.

total integer

The total page count.

results object

total integer

The total page count.

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "type": "string",
      "name": "string",
      "description": "string",
      "discount_settings": {
        "custom_discounts_enabled": true,
        "use_rule_promotions": true
      },
      "payment_intent_id": "string",
      "links": {
        "self": "string"
      },
      "meta": {
        "display_price": {
          "with_tax": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "without_tax": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "tax": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "discount": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "without_discount": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "shipping": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          }
        },
        "timestamps": {
          "created_at": "string"
        }
      },
      "relationships": {
        "customers": {
          "data": {
            "type": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        },
        "items": {
          "data": {
            "type": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        }
      }
    }
  ],
  "links": {
    "current": "string",
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string"
  },
  "meta": {
    "page": {
      "current": 0,
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "results": {
      "total": 0
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

Loading...