get https://your-url-here.com/erc/ecommerce/connections/customers/cart
Read the ERC e-commerce cart of customer by the one of customer_id and cart_id.
Scope
erc-ecommerce-connections-customers:read
Body Response - Schema
200 OK (The cart data found with the provided customer_id or cart_id)
Represents the customer resource
| Parameter | Type | Description | Required |
|---|---|---|---|
| cart_id | string | The ID of the cart. | yes |
| customer_id | string | The ID of the customer. | no |
| total_quantity | string | The total quantity in the cart. | no |
| currency | string | The currency of the cart. | no |
| cart_status | string | The status of the cart. | no |
| created_time | string | The time of creation of the cart. | no |
| updated_time | string | The time when the cart was last updated. | no |
| cost | object | "cost" subdivides into: 1 - "base_amount" (string) - the base amount. 2 - "discounts_amount" (string) - the discounts amount. 3 - "final_amount" (string) - the final amount. Required. 4 - "taxes_amount" (string) - the taxes amount. | |
| cart_discounts | array[object] | "cart_discounts" subdivides into: 1 - "discounted_amount" (string) - the discounts amount. Required. 2 - "type" (string) - the type of discount. Required. 3 - "discount_code" (string) - the final amount. Required. 4 - "discount_name" (string) - the taxes amount. 5- "discount_description" (string) - the description of the discount. | |
| cart_lines | array[object] | "cart_lines" subdivides into: 1 - "line_id" (string) - the ID of the line. Required. 2 - "variant_id" (string) - the ID of the of variant. Required. 3 - "variant_title" (string) - the title of the variant. Required. 4 - "product_id" (string) - the ID of the product. Required. 5 - "sku" (string) - the SKU. Required. 6 - "default_image" (string) - the URL of the default image. Required. 7 - "quantity_available" (string) - the available quantity. 8 - "quantity" (string) - the quantity. 9 - "url" (string) - the URL. 10 - "cost" (object) - required. "cost" subdivides into: 10.1 - "base_amount" (string) - the base amount. 10.2 - "discounts_amount" (string) - the discounts amount. 10.3 - "final_amount" (string) - the final amount. Required. 10.4 - "taxes_amount" (string) - the taxes amount. 11 - "cart_lines_discounts" (array[object]) - "cart_lines_discounts" subdivides into: 11.1 - "discounted_amount" (string) - the discounted amount. Required. 11.2 - "type" (string) - the type of discount. Required. 11.3 - "discount_code" (string) - the discount code. 11.4 - "discount_name" (string) - the discount name. Required. 11.5 - "discount_description" (string) - a description of the discount. | |
| custom_fields_type | string | The type of custom fields. | no |
| custom_fields | object | The custom fields associated with the provider. | no |
| _links | object | "_links" subdivides into: 1 - "self" (object) - required. 1.1 - "href" (string) - the link to the cart. | yes |
400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 405 (method not supported)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
API Availability
The Retail Experience Cloud - Retail Ecommerce Integration is only available for customers enrolled in Talkdesk's Early Access (EA) program. To enter the EA program, contact a Customer Success Manager.
The Retail Experience Cloud - Retail Ecommerce Integration has been in EA since March 2022.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.