GET https://{cluster-id}.elevate-api.cloud/api/admin/v3/export/product-groups
Request
Request header parameters
Request header parameters
| Name | Description | Example |
|---|---|---|
Api-Key* | API key supplied during onboarding. | 123456789.. |
Accept-Encoding* | Allows responses to be compressed using Gzip. | gzip |
Request query parameters
Request query parameters
| Name | Description | Example |
|---|---|---|
market* | 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 |
locale | The visitor locale. Must match an available locale identifier on the current market in the data feed. | en-GB |
productRules | Filter which products should be returned. | rule incl product_key {"pk1" "pk2"} |
Example request
Example request
bash
curl -i \
-X GET \
-H 'Api-Key: 123456789..' \
-H 'Accept-Encoding: null' \
"https://{cluster-id}.elevate-api.cloud/api/admin/v3/export/product-groups?market=market&limit=limit&locale=locale&productRules=productRules"
Response
Response codes
Response codes
| Status | Description |
|---|---|
200 | Query accepted. The data will be returned as an application/json-object. |
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. |
Example response
Example response
{
"market" : "se",
"locale" : "sv-SE",
"productGroups" : [ {
"key" : "pg1",
"brand" : "Box Boss",
"department" : "Home",
"suppressDuplicates" : false,
"products" : [ {
"key" : "1",
"title" : "Basic storage box",
"url" : "/home/storage/products/1",
"description" : "A box for storing smaller items",
"images" : [ {
"typeOverride" : "misc",
"tags" : [ "First" ],
"custom" : [ {
"monochrome" : "false"
} ],
"urls" : [ {
"url" : "https://path/to/image",
"width" : 800,
"height" : 600
} ]
} ],
"custom" : {
"dimension" : [ {
"id" : "30x20x20",
"label" : "30x20x20"
} ]
},
"variants" : [ {
"key" : "1_0",
"cost" : 50.0,
"listPrice" : 100.0,
"sellingPrice" : 75.0,
"sizes" : [ {
"size" : "30x20x20"
} ],
"stockNumber" : 5,
"stores" : [ {
"key" : "Store",
"stockNumber" : 3
} ],
"customPrices" : [ {
"id" : "EUR",
"listPrice" : "10.0",
"sellingPrice" : "10.0"
} ],
"custom" : {
"rim_material" : [ {
"id" : "a1",
"label" : "plastic"
} ]
}
} ]
} ]
} ]
}