get https://your-url-here.com/erc/ecommerce/connections/customers//orders
Get the ERC e-commerce customer orders provided by the customer ID
Scope
erc-ecommerce-connections-orders:read- Read e-commerce connections orders info.
Body Response - Schema
200 OK (the list of customer orders found with the provided customer ID)
Represents the paginated list of customer orders
| Parameter | Type | Description | Required |
|---|---|---|---|
| _embedded | object | "_embedded" subdivides into: 1 - "orders" (array[object]) - the list of orders in the current page. 1.1 - "id" (string) - the ID of the order. Example: order456. Required. 1.2 - "order_number" (string) - The number of the order (usually the order identifier that the customer knows). Example: Example: #Y34DHR 1.3. - "customer_id" (string) - The ID of the customer that created this order. Example: customer123 1.4 - "purchase_datetime" (string) - the timestamp date when the order was created. Example: 2021-09-14T12:16:50.078Z 1.5 - "delivery_type" (string) - the type of delivery associated with the order. Allowed values: UNKNOWN, LOCAL_DELIVERY, LOCAL_PICKUP, SHIPPING. Example: SHIPPING. 1.6 - "shipping_addresses" (array[object]) - the address to which the order will be/was shipped. 1.6.1 - "id" (string) - the address identifier. Example: address1234 1.6.2 - "first_name" (string) - the first name of the person associated with the address. Example: John. Required. 1.6.3 - "last_name" (string) - the last name of the person associated with the address. Example: Doe. Required. 1.6.4 - "phone_number" (string) - the phone number of the person associated with the address. Example: +351910000000 1.6.5 - "address" (string) - the first line of the address. Example: Lisbon. Required. 1.6.6 - "zip_code" (string) - the zip-code of the address. Example: 20000000. Required. 1.6.7 - "city" (string) - the city of the address. Example: Lisbon. Required. 1.6.8 - "region_code" (string) - the region (country subdivision) code according to ISO 3166-2 standard. Example: PT-11. Required. 1.6.9 - "country_code" (string) - the country code of the address, according to the ISO 3166-1 alpha-2 codes. Example: PT. Required. 1.6.10 - "default" (boolean) - define if address is default. Example: true 1.7 - "items_number" (integer) - the number of order items. > = 1 <= 100 Example: 3 1.8 - "price_summary" (object) - the summary of the order prices. 1.8.1 - "original_total_amount" (object) - the original total amount of the order, i.e. before applying discount, shipping, and taxes. Required. 1.8.1.1 - "value" (number) - the amount of money. Example: 10.5. Required. 1.8.1.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. 1.8.2 - "discounts_amount" (object) - the amount of the order discounts. 1.8.2.1 - "value" (number) - the amount of money. Example: 10.5. Required. 1.8.2.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. 1.8.3 - "shipping_amount" (object) - the amount of the order shipping costs. Required. 1.8.3.1 - "value" (number) - the amount of money. Example: 10.5. Required. 1.8.3.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. 1.8.4 - "taxes_amount" (object) - the amount of the order taxes. Required. 1.8.4.1 - "value" (number) - the amount of money. Example: 10.5. Required. 1.8.4.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. 1.8.5 - "final_total_amount" (object) - the final total amount of the order, i.e. after applying discounts, shipping and taxes. Required. 1.8.5.1 - "value" (number) - the amount of money. Example: 10.5. Required. 1.8.5.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. 1.9 - "order_extra_info" (object) - the extra info of the order. 1.9.1 - "highlighted_item_image_url" (string) - the image of the most expensive item. Example: https://external-integration.url.com/payment_card_brand_icon.jpg 1.10 - "status" (string) - The status of the order. Each integration has its own set of possible status values Example: CONFIRMED 1.11 - "custom_fields" (object) - The custom fields associated with the provider. | yes |
| _links | object | "_links" subdivides into: 1 - "self" (object) - Required. 1.1 - "href" (string ) - http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/orders?limit=2&order_by=purchase_datetime:desc 2 - "next" (object) 2.1 - "href" (string ) - http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/orders?limit=2&order_by=purchase_datetime:desc&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ== | 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.