Product Sets¶

https://{cluster-id}.elevate-api.cloud/api/admin/v4/export/product-sets

GET¶

An export of all product sets in Elevate

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`

curl -i \
-X GET \
-H 'Api-Key: pkA123456789AB1BE..' \
-H 'Accept-Encoding: gzip' \
"https://{cluster-id}.elevate-api.cloud/api/admin/v4/export/product-sets"

Response¶

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.
503	The server in the cluster that received the request is currently unavailable or busy. It is recommended to retry the request. The time between request attempts should be increasing.

Response body¶

Example

application/json;charset=UTF-8

{
  "WINTER" : {
    "name" : "Winter sale",
    "rule" : "rule incl custom.season { \"winter\" }"
  },
  "STRIPED" : {
    "name" : "All striped items",
    "rule" : "rule incl pattern { \"striped\" }"
  }
}

Schema

ProductSetBody¶

Product set definitions.

Keys following pattern: [\p{L}\p{N}_\-()<>.:,&+%\[\]|?#�']{1,200} and with the value: ProductSet Max: 1000 keys

Inner Schemas¶

ProductSet¶

Name	Type	Description
name Required	string	The name of the product set, displayed in the Elevate application. Min length: `1`. Max length: `80`.
rules	string	A product rule expression restricting the products that the product set may contain.