Product selection exports¶

Product lists in Elevate can return up to 10 000 products. The product selection exports allows for extracting a filtered product list from Elevate that includes more than 10 000 products.

When exporting product selections via the Web API, an Api-Key header is required for authentication.

Method¶

GET

URL format¶

/api/v2/export/product-selection

Parameters¶

Name	Type	Description	Example
`filter`	string	An expression defining the product and variant set. Defaults to `UNIVERSE` if omitted.	`in_stock:'true'`
`presentationAttributes`	string	A comma-separated list of the attributes from the product data to present. Default presentation attributes are used if omitted.	`title,author`
`limit`	int	The maximum number of products to include in the result. No maximum limit.	`10`

Request body¶

N/A

Request content-type¶

N/A

Response content-type¶

application/json

Responses¶

Response	Description
200	The product selection export completed successfully.
403	`Api-Key` could not be validated.
404	Cluster not found.
4xx	The request made by the client was invalid. This may mean that the `filter` is invalid or the `limit` is negative. The response body may contain more information about the error.
503	The server in the cluster that received the request is currently unavailable. It is recommended to retry the request. The time between request attempts should be increasing.
5xx	Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Example¶

Request¶

cURL¶

#!/bin/bash
curl \
-X GET \
-H "Api-Key: {PRIVATE-KEY}" \
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/export/product-selection?presentationAttributes=title,genre&limit=2"

Response¶

JSON

[
    {
        "key": "P11230512",
        "variants": [],
        "attributes": {
            "genre": [
               "Pop Rock"
            ],
            "title": [
                "Happiness"
            ]
        }
    },
    {
        "key": "P120524",
        "variants": [],
        "attributes": {
            "genre": [
                "Blues"
            ],
            "title": [
                "Bluesbreakers Special Edition"
            ]
        }
    }
]