get https://your-url-here.com/erc/ecommerce/products
Get/search the products of the store Talkdesk is integrated with
Scope
erc-ecommerce-connections-products:read
Body Response - Schema
200 OK (the list of found products)
Represents the paginated list of customer orders
| Parameter | Type | Description | Required |
|---|---|---|---|
| _embedded | object | "_embedded" subdivides into: 1 - "products" (array[object]) - the list of products in the current page. 1.1 - "id" (string) - the ID of the product. Example: product123. Required. 1.2 - "title" (string) - The default title of the product. It is only displayed if the selected product variant doesn't have a title defined. Example: Linen dress 1.3 - "description" (string) - the product description. 1.4 - "default_variant_id" (string) - the ID of the product variant to be presented by default. Example: productVariant123 1.5 - "default_image_id" (string) - the ID of the product image to be displayed by default. Example: productImage123 1.6 - "images" (array[object]) - the list of product images. 1.6.1 - "id" (string) - The ID of the product image. Example: productImage123. Required. 1.6.2 - "image_url" (string) - The URL of the product image. Example: https://external-integration.url.com/product_image.png. Required. 1.7 - "options" (array[object]) - the list of product options. 1.7.1 - "name" (string) - the name of the product option. Example: Color Required. 1.7.2 - "values" (array[string]) - the list of possible values for the product option. Example: ["White","Black","Red","Purple"]. Required. 1.8 - "variants" (array[object]) - the list of product variants. The maximum number of product variants is the amount of possible option values combinations. There may be some combinations that are not manufactured/sold, and so there may be some variants missing from the list. 1.8.1 - "id" (string) - the ID of the product variant. Example: productVariant123. Required. 1.8.2 - "sku" (string) - the SKU of the product variant. Example: productVariant123Sku 1.8.3 - "price" (object) - the price of the product variant. 18.3.1 - "value" (number ) - the amount of money. Example: 10.5. Required. 18.3.2 - "currency" (string) - the currency of the money amount. Example: EUR. Required. 1.8.4 - "images_ids" (array[string]) - the list of IDs of the images associated with the product variant. Example: ["productImage123","productImage456"] 1.8.5 - "options" (dictionary[string, string]) - the map of option values that correspond to this product variant. A variant can only have a single value for each option, and all options must be present (have a value). Example: {"Color":"White","Size":"XS"} 1.8.6 - "available_quantity" (integer) - the product's variant quantity available in stock. Default:0. Example: 1000 | 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/products?limit=2 2 - "next" (object) - required. 2.1 - "href" (string ) - http://api-docs.talkdesk.org/erc/ecommerce/products?limit=2&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) |
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.