Panel Query¶
Panel queries are the main way of fetching results, such as products or ads from eSales Enterprise. Panels can be queried through the Web API when the panel hierarchy for a site has been published. A successful query returns the panel content in flattened and serialised JSON format.
Parameters that have not been set in panel configuration or have a default value in predefined panels has to be sent as arguments.
Empty panels
Empty panels will always be included in the response unless they are contained in a panel that has a limit.
Method¶
GET
URL format¶
/api/v2/panels/{panelPath}?{parameter_name}={parameter_value}
Required parameters¶
Required parameters in the query-string needs to be prepended with esales.
.
Name | Type | Description | Example |
---|---|---|---|
esales.market | string | Visitor Market | Sweden |
esales.customerKey | string | Visitor id. UUID / GUID. | 5G7HJ...R77T1 |
esales.sessionKey | string | A unique id. UUID / GUID. | 2F75A...EAFA6 |
panelPath | string | Panel path | /product-page |
Other parameters¶
Additional arguments are panel dependent and may be required, read more about filter variables. See Panels for parameters for panel specific arguments.
/api/v2/panels/{panelPath}?{required_parameter_name}={required_parameter_value}&{additional_parameter_name}={additional_parameter_value}
Request body¶
Not applicable
Request content-type¶
Not applicable
Response content-type¶
application/json
Responses¶
Response | Description |
---|---|
200 | Panel content flattened and serialised to JSON, see Response. |
400 | Invalid or missing arguments for this panel. |
404 | Panel not found or not public. |
503 | Service unavailable, no products found in cluster. |
5xx | Server error such as cluster unavailable or busy. The response body may contain more information about the error. |
Example¶
Try out the API at the Apptus API Playground with your eSales Playground and API credentials.
Request¶
cURL¶
#!/bin/bash
curl -i \
"https://{cluster-id}.api.esales.apptus.cloud/api/v2/panels/product-list?esales.market=UK&esales.customerKey=d9528030-509c-4e0f-b585-7168f1e9feca&esales.sessionKey=b106299c-eac0-4f6f-96d2-93e57c255784&window_first=1&window_last=10"
Response¶
JSON
{
"productList": [
{
"name": "product-list",
"ticket": "Oy9wcm9kdWN0LWxpc3Q7IzsjOyM7IzsjOyM7Izs",
"path": "/product-list",
"description": "Displays a list of products and is intended to be used for static searches.",
"displayName": "Product List",
"attributes": {},
"resultType": "products",
"products": [
{
"key": "P10136986",
"ticket": "Oy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTAxMzY5ODY7IztPQkpFQ1RJVkUkO05PTkU6Tk9ORTs2MTs",
"variants": [],
"attributes": {
"price": [
"54900"
]
},
"categoryReferenceAttributes": {
"category": [
{
"key": "game/unknown",
"parentKey": "game",
"displayName": "unknown",
"attributes": {
"department": [
"game"
]
}
}
]
}
},
{
"key": "P10137049",
"ticket": "Oy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTAxMzcwNDk7IztPQkpFQ1RJVkUkO05PTkU6Tk9ORTs2MTs",
"variants": [],
"attributes": {
"price": [
"16900"
]
},
"categoryReferenceAttributes": {
"category": [
{
"key": "music/heavy-metal",
"parentKey": "music",
"displayName": "Heavy Metal",
"attributes": {
"department": [
"music"
]
}
}
]
}
},
{
"key": "P10137050",
"ticket": "Oy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTAxMzcwNTA7IztPQkpFQ1RJVkUkO05PTkU6Tk9ORTs2MTs",
"variants": [],
"attributes": {
"price": [
"14900"
]
},
"categoryReferenceAttributes": {
"category": [
{
"key": "music/unknown",
"parentKey": "music",
"displayName": "unknown",
"attributes": {
"department": [
"music"
]
}
}
]
}
},
{
"key": "P10137051",
"ticket": "Oy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTAxMzcwNTE7IztPQkpFQ1RJVkUkO05PTkU6Tk9ORTs2MTs",
"variants": [],
"attributes": {
"price": [
"14900"
]
},
"categoryReferenceAttributes": {
"category": [
{
"key": "music/unknown",
"parentKey": "music",
"displayName": "unknown",
"attributes": {
"department": [
"music"
]
}
}
]
}
},
{
"key": "P10137052",
"ticket": "Oy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTAxMzcwNTI7IztPQkpFQ1RJVkUkO05PTkU6Tk9ORTs2MTs",
"variants": [],
"attributes": {
"price": [
"9900"
]
},
"categoryReferenceAttributes": {
"category": [
{
"key": "music/unknown",
"parentKey": "music",
"displayName": "unknown",
"attributes": {
"department": [
"music"
]
}
}
]
}
},
{
"key": "P10137526",
"ticket": "Oy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTAxMzc1MjY7IztPQkpFQ1RJVkUkO05PTkU6Tk9ORTs2MTs",
"variants": [],
"attributes": {
"authors": [
"Lindwall, Johan T."
],
"price": [
"3900"
]
},
"categoryReferenceAttributes": {
"category": [
{
"key": "book/memoarer",
"parentKey": "book",
"displayName": "Memoarer ",
"attributes": {
"department": [
"book"
]
}
}
]
}
},
{
"key": "P10137660",
"ticket": "Oy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTAxMzc2NjA7IztPQkpFQ1RJVkUkO05PTkU6Tk9ORTs2MTs",
"variants": [],
"attributes": {
"price": [
"16900"
]
},
"categoryReferenceAttributes": {
"category": [
{
"key": "music/blues",
"parentKey": "music",
"displayName": "Blues",
"attributes": {
"department": [
"music"
]
}
}
]
}
},
{
"key": "P10137674",
"ticket": "Oy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTAxMzc2NzQ7IztPQkpFQ1RJVkUkO05PTkU6Tk9ORTs2MTs",
"variants": [],
"attributes": {
"price": [
"2900"
]
},
"categoryReferenceAttributes": {
"category": [
{
"key": "music/pop-rock",
"parentKey": "music",
"displayName": "Pop Rock",
"attributes": {
"department": [
"music"
]
}
}
]
}
},
{
"key": "P10137692",
"ticket": "Oy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTAxMzc2OTI7IztPQkpFQ1RJVkUkO05PTkU6Tk9ORTs2MTs",
"variants": [],
"attributes": {
"price": [
"7900"
]
},
"categoryReferenceAttributes": {
"category": [
{
"key": "music/pop-rock",
"parentKey": "music",
"displayName": "Pop Rock",
"attributes": {
"department": [
"music"
]
}
}
]
}
},
{
"key": "P10137751",
"ticket": "Oy9wcm9kdWN0LWxpc3Q7Iztwcm9kdWN0X2tleTtQMTAxMzc3NTE7IztPQkpFQ1RJVkUkO05PTkU6Tk9ORTs2MTs",
"variants": [],
"attributes": {
"price": [
"49900"
]
},
"categoryReferenceAttributes": {
"category": [
{
"key": "electronics/cellphone-portable-handsfree",
"parentKey": "electronics",
"displayName": "Cellphone Portable handsfree",
"attributes": {
"department": [
"electronics"
]
}
}
]
}
}
]
}
]
}