get https://your-url-here.com/erc/ecommerce/connections/customers//orders//
Get the ERC e-commerce customer order for the provided customer and order ID
Scope
erc-ecommerce-customers: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 id. Example: order123 | yes |
| order_number | string | The number of the order (usually the order identifier that the customer knows). Example: #Y34DHR | yes |
| customer_id | string | The ID of the customer that created this order. Example: customer123 | no |
| purchase_datetime | string | The timestamp date when the order was created. Example: 2021-09-14T12:16:50.078Z | no |
| delivery_type | string | The type of delivery associated with the order. Allowed values: UNKNOWN, LOCAL_DELIVERY, LOCAL_PICKUP, SHIPPING Example: SHIPPING | no |
| shipping_address | object | The address to which the order will be/was shipped. "shipping_address" subdivides into: 1 - "id" (string) - The address identifier. Example: address1234 2 - "first_name" (string) - the first name of the person associated with the address. Example: John 3 - "last_name" (string) - the last name of the person associated with the address. Example: Doe 4 - "phone_number" (string) - the phone number of the person associated with the address. Example: +351910000000 5 - "address" (string) - the first line of the address. Example: Lisbon 6 - "zip_code" (string) - the zip-code of the address. Example: 20000000 7 - "city" (string) - the city of the address. Example: Lisbon 8 - "region_code" (string) - the region (country subdivision) code according to ISO 3166-2 standard. Example: PT-11 9 - "country_code" (string) - the country code of the address, according the ISO 3166-1 alpha-2 codes. Example: PT 10 - "default" (boolean) - define if address is default. Example: true | no |
| billing_address | object | The billing address associated with the order. "billing_address" subdivides into: 1 - "id" (string) - The address identifier. Example: address1234 2 - "first_name" (string) - the first name of the person associated with the address. Example: John 3 - "last_name" (string) - the last name of the person associated with the address. Example: Doe 4 - "phone_number" (string) - the phone number of the person associated with the address. Example: +351910000000 5 - "address" (string) - the first line of the address. Example: Lisbon 6 - "zip_code" (string) - the zip-code of the address. Example: 20000000 7 - "city" (string) - the city of the address. Example: Lisbon 8 - "region_code" (string) - the region (country subdivision) code according to ISO 3166-2 standard. Example: PT-11 9 - "country_code" (string) - the country code of the address, according the ISO 3166-1 alpha-2 codes. Example: PT 10 - "default" (boolean) - define if address is default. Example: true | |
| items_number | integer | The number of order items. Example: 3 | no |
| price_summary | object | The summary of the order prices. "price_summary" (required) subdivides into: 1 - "original_total_amount" (object) - the original total amount of the order, i.e. before applying discounts, shipping and taxes. Required. 1.1 - "value" (number ) - the amount of money. Example: 10.5. Required. 1.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. 2 - "discounts_amount" (object) - the amount of the order discounts. 2.1 - "value" (number ) - the amount of money. Example: 10.5. Required. 2.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. 3 - "shipping_amount" (object) - the amount of the order shipping costs. Required. 3.1 - "value" (number ) - the amount of money. Example: 10.5. Required. 3.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. 4 - "taxes_amount" (object) - the amount of the order taxes. Required. 4.1 - "value" (number) - the amount of money. Example: 10.5. Required. 4.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. 5 - "final_total_amount" (object) - the final total amount of the order, i.e. after applying discounts, shipping and taxes. Required. 5.1 - "value" (number) - the amount of money. Example: 10.5. Required. 5.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. | no |
| payment_details | object | The payment details of the order. "payment_details" subdivides into: 1 - "card_brand" (string) - the payment card brand of the order. Example: Visa 2 - "card_brand_image_url" (string) - the icon of payment card brand. Example: https://external-integration.url.com/payment_card_brand_icon.svg 3 - "card_number" (string) - the number of payment card. Example: ** ** ** *567 4 - "is_refunded" (boolean)** - the flag to indicate if the order is refunded. Example: false | no |
| order_extra_info | object | The extra info of the order. "order_extra_info" subdivides into: 1 - "highlighted_item_image_url" (string) - the image of most expensive item. Example: https://external-integration.url.com/payment_card_brand_icon.jpg 2 - "latest_status_info" (object) - the status of the order. 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. 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 2.3 - "status_date_time" (string) - The timestamp date when the status info state/step was 'reached'. Example: 2021-10-23T12:16:50.078Z | no |
| cancellation_status | string | The cancellation status of the order. Filled when the order cancellation is requested and/or when the order is canceled. Allowed values: UNKNOWN, CANCELED Example: CANCELED | no |
| _links | object | "_links" subdivides into: 1 - "self" (object) - required. 1.1 - "href" (string ) - http://api-docs.talkdesk.org/erc/ecommerce/customers/customer123/orders/order123 | 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) |
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.