Product Information¶
https://{cluster-id}.elevate-api.cloud/api/storefront/v3/utilities/product-information
GET¶
An export of the product data in Elevate 4 as a json object.
Request¶
Header parameters¶
| Name | Description | Example |
|---|---|---|
| Api-Key Required | Api-key that was supplied during on-boarding | pkA123456789AB1BE.. |
| Accept-Encoding Required | Allows responses to be compressed using Gzip. | gzip |
Query parameters¶
| Name | Description | Example |
|---|---|---|
| locale Required | The visitor locale. Must match an available locale identifier on the current market in the data feed. | en-UK |
| market Required | The visitor market identifier. Must match the corresponding market identifier in the data feed. | UK |
| limit | The number of product groups to include. If parameter is omitted, all product groups will be returned. | 10 |
| pageReference | A reference to the page, either Page ID or the localized path, uniquely identifying this page. For more information about page references, see Page IDs. | /women/shoes/loafers |
| productRules | Filter which products should be returned. | rule incl product_key {"pk1" "pk2"} |
| templateId | A template to apply to exported products. | template1 |
curl -i \
-X GET \
-H 'Api-Key: pkA123456789AB1BE..' \
-H 'Accept-Encoding: gzip' \
"https://{cluster-id}.elevate-api.cloud/api/storefront/v3/utilities/product-information?locale=en-UK&market=UK&limit=10&pageReference=%2Fwomen%2Fshoes%2Floafers&productRules=rule+incl+product_key+%7B%22pk1%22+%22pk2%22%7D&templateId=template1"
Response¶
Response codes¶
| Status | Description |
|---|---|
| 200 | Query accepted. The data will be returned as an application/json-object. |
| 400 | Incorrect query parameters. |
| 403 | Incorrect cluster credentials. |
| 404 | Cluster not found. |
| 406 | No acceptable encoding found in Accept-Encoding header. |
| 500 | Server error such as cluster unavailable, busy or internal error. If 5xx errors persist, contact support and attach any information found in the response body. |