Skip to content
×
Copyright

This online publication is intellectual property of Apptus Technologies. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Apptus Technologies nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Apptus Technologies essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.

CLOSE

Product Selection Exports

Product lists in eSales can return up to 10 000 products. The product selection exports allows for extracting a filtered product list from eSales 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
  • HTTP response code

Responses

Response Description
200 The product selection export completed successfully.
403 Incorrect Api-Key.
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.
5xx Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Examples

Try out the API at the Apptus API Playground with your eSales Playground and API credentials.

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"
            ]
        }
    }
]

Last update: December 5, 2019