get https://your-url-here.com/erc/ecommerce/customers//orders//items
Get the ERC e-commerce customer order items for the provided customer ID and order ID
Scope
erc-ecommerce-connections-orders:read
Body Response - Schema
200 OK (the list of customer order items found for the provided customer ID and order ID)
Represents the paginated list of customer orders
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | The order item id. Example: orderItem123 | |
| _embedded | object | "_embedded" subdivides into: 1 - "items" (array[object]) - the list of order items in the current page. 1.1 - "id" (string) - the ID of the item. Example:orderItem789. Required. 1.2 - "name" (string) - the name of the item. Example: Order Item 789. Required. 1.3 - "description" (string) - the description of the item. Example: description of order Item 789 1.4 - "brand" (string) - the brand of the item. Example: Brand 123 1.5 - "price" (object) - the price of the item. Required. 1.5.1 - "value" (number ) - the amount of money. Example:10.5. Required. 1.5.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. 1.6 - "image_url" (string ) - the URL of the item image/picture. Example: https://external-integration.url.com/order_item_icon.png 1.7 - "quantity" (integer) - the quantity of the item. > = 1 <= 100 Example: 10 1.8 - "sku" (string) - the sku of the item. Example: Sku 123 1.9 - "deliverable_quantity" (integer) - the quantity of order items that are yet to be delivered/processed. > = 1 <= 100 Example: 10 1.10 - "deliveries" (array[object]) - list of deliveries where the item is inserted. 1.10.1 - "id" (string) - the ID of the order delivery. Example: orderDelivery123. Required. 1.10.2 - "delivery_quantity" (integer) - the quantity of items associated with the delivery. Example: 10 1.10.3 - "latest_status_info" (object) - the latest delivery status information. 1.10.3.1 - "type" (string) - the 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. Required. 1.10.3.2 - "status_date_time" (string) - the timestamp date when the status info state/step was 'reached'. Example: 2021-10-23T12:16:50.078Z 1.10.4 - "tracking_info" (object) - the tracking information associated with the order delivery. 1.10.4.1 - "tracking_number" (string) - the tracking number associated with the order delivery. Example: #USPS 123456789. Required. 1.10.4.2 - "external_url" (string) - the URL of the external system where we can get more tracking details (ex: the URL of the carrier). Example: https://external.url.com/ 1.10.5 - "last_update" (string) - the timestamp date when the order delivery was last updated. Example: 2021-09-14T12:16:50.078Z | yes |
| custom_fields | object | The custom fields associated with the provider. | |
| _links | object | "_links" subdivides into: 1 - "self" (object) - required. 1.1 - "href" (string ) - http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/orders/order789/items?limit=2&order_by=price:desc 2 - "next" (object) 2.1 - "href" (string ) - http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/orders/order789/items?limit=2&order_by=price: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.