get https://your-url-here.com/erc/ecommerce/orders
Scope
erc-ecommerce-customers:read
Body Response - Schema
200 OK (The list of orders found with the provided account 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 - "customer_id" (string) - the number of the order (usually the order identifier that the customer knows). Example: #Y34DHR 1.3 - "order_number" (string) - the ID of the customer that created this order. Example: customer123. Required. 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_address" (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 1.6.3 - "last_name" (string) - the last name of the person associated with the address. Example: Doe 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 1.6.6 - "zip_code" (string) - the zip-code of the address. Example: 20000000 1.6.7 - "city" (string) - the city of the address. Example: Lisbon 1.6.8 - "region_code" (string) - the region (country subdivision) code according to ISO 3166-2 standard. Example: PT-11 1.6.9 - "country_code" (string) - the country code of the address, according the ISO 3166-1 alpha-2 codes. Example: PT 1.6.10 - "default" (boolean) - define if address is default. Example: true 1.7 - "billing_address" (object) - the billing address associated with the order. 1.7.1 - "id" (string) - the address identifier. Example: address1234 1.7.2 - "first_name" (string) - the first name of the person associated with the address. Example: John 1.7.3 - "last_name" (string) - the last name of the person associated with the address. Example: Doe 1.7.4 - "phone_number" (string) - the phone number of the person associated with the address. Example: +351910000000 1.7.5 - "address" (string) - the first line of the address. Example: Lisbon 1.7.6 - "zip_code" (string) - the zip-code of the address. Example: 20000000 1.7.7 - "city" (string) - the city of the address. Example: Lisbon 1.7.8 - "region_code" (string) - the region (country subdivision) code according to ISO 3166-2 standard. Example: PT-11 1.7.9 - "country_code" (string) - the country code of the address, according the ISO 3166-1 alpha-2 codes. Example: PT 1.7.10 - "default" (boolean) - define if address is default. Example: true 1.8 - "items_number" (integer) - the number of order items. Example: 3 1.9 - "price_summary" (object) - the summary of the order prices. 1.9.1 - "original_total_amount" (object) - the original total amount of the order, i.e. before applying discounts, shipping and taxes. Required. 1.9.1.1 - "value" (number ) - the amount of money. Example: 10.5. Required. 1.9.1.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. 1.10 - "payment_details" (object) - the payment details of the order. 1.10.1 - "card_brand" (string) - The payment card brand of the order. Example: Visa 1.10.2 - "card_brand_image_url" (string) - the icon of payment card brand. Example: https://external-integration.url.com/payment_card_brand_icon.svg 1.10.3 - "card_number" (string) - the number of payment card. Example: ** ** ** *567 1.10.4 - "is_refunded" (boolean)** - the flag to indicate if the order is refunded. Example: false 1.11 - "order_extra_info" (object) - the extra info of the order. 1.11.1 - "highlighted_item_image_url" (string) - the image of most expensive item. Example: https://external-integration.url.com/payment_card_brand_icon.jpg 1.11.2 - "latest_status_info" (object) - the status of the order. 1.11.2.1 - "generic_type" (string) - the generic type of the state/step. Allowed values: UNKNOWN, CONFIRMED ON_ITS_WAY, OUT_FOR_DELIVERY, DELIVERED. Example: IN_TRANSIT. Required. 1.11.2.2 - "detailed_type" (string) - the detailed type of the state/step. Allowed values: UNKNOWN, ATTEMPTED_DELIVERY, READY_FOR_PICKUP, PICKED_UP, CONFIRMED IN_TRANSIT, OUT_FOR_DELIVERY, DELIVERED, FAILURE. Example: IN_TRANSIT 1.11.2.3 - "status_date_time" (string) - The timestamp date when the status info state/step was 'reached'. Example: 2021-10-23T12:16:50.078Z | yes |
| _links | object | "_links" subdivides into: 1 - "self" (object) - required. 1.1 - "href" (string ) - http://api-docs.talkdesk.org/erc/ecommerce/orders?limit=2&order_by=purchase_datetime:desc 2 - "next" (object) - required. 2.1 - "href" (string ) - http://api-docs.talkdesk.org/erc/ecommerce/orders?limit=2&order_by=purchase_datetime:desc&cursor=eyJsYXN0X2lkIjoxMjQ4MzU4NTYzODYyLCJsYXN0X3ZhbHVlIjoiMjAxOS0wNi0xNyAwMjoyMzo0Mi4wMDAwMDAifQ== | no |
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.