TAtalkdesk
Retail Experience Cloud Bridge

Get Customer Cart

Read the cart of the customer by customer_id, cart_id, or interaction_id.

Required fields:

  • At least one of customer_id, cart_id, or interaction_id must be provided.

A successful request returns the cart data including delivery address and selected delivery option when available.

get/erc/ecommerce/customers/cart

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/erc/ecommerce/customers/cart
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: erc-ecommerce-customers:read

Query parameters

customer_idstring

The id of customer

cart_idstring
Example:f251d341-b9ac-4b5c-a586-9534469dc2e7

The id of customer cart

interaction_idstring

The ID of the interaction (conversation) associated with this cart.

brandstring
Example:Brand A

The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.

Response

The cart data found for the provided customer_id, cart_id, or interaction_id.

cart_idstring required

The ID of the cart

customer_idstring

The ID of the customer

total_quantitystring

The total quantity in the cart

currencystring

The currency of the cart

cart_statusstring

The status of the cart

created_timestring date-time

The time when the cart was created

updated_timestring date-time

The time when the cart was last updated

brandstring

The brand of the provider

custom_fields_typestring

The type of custom fields

custom_fieldsobject

The custom fields associated with the provider

Example response

{
  "checkout": {
    "url": "https://api.talkdesk.com/erc/ecommerce/cart/Z2NwLXVzLWNlbnRyYWwxOjAxSk%7C123123fff/checkout?token=a3f1c2d4e5b6&brand=my-store",
    "expires_at": "2026-06-27T10:00:00+00:00"
  },
  "delivery_address": {
    "first_name": "Neo",
    "last_name": "Shi",
    "phone_number": "+8613800138000",
    "address": "Rua Cidade de Nampula 3148",
    "zip_code": "1800-105",
    "city": "Lisboa",
    "region_code": "PT-11",
    "country_code": "PT"
  },
  "selected_delivery_option": {
    "handle": "postal-7a2d1d-1",
    "title": "Standard Shipping",
    "estimated_cost": {
      "amount": "50.0",
      "currency_code": "EUR"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.