See also: Request
Response Format
The response consists of an array of profile objects, even if only one was requested.
Profile Object Format
Name | Description |
---|---|
profile | If a profile was applied to the results, this object will be returned. It contains a "tag" item which identifies which profile has been applied. |
results | An array of product results. (See below) |
Result Object Format
Name | Description |
---|---|
id | The Unique ID of this product. This is the feed field that is mapped to "Unique ID" on the Core Mappings page in the Management Console. |
mappings | Searchspring field mappings that are universal to any Searchspring-powered product index. This contains a "core" object which contains values for the Core Mapping fields: brand, imageUrl, name, popularity, price, sku, thumbnailImageUrl, and url. |
attributes | An array of fields for the product. A field must be marked as "Display" in the Field Settings page in order to be returned. |
Response Example
[
{
"profile": {
"tag": "also-viewed"
},
"results": [
{
"attributes": {
"days_since_published": 78,
"ga_unique_purchases": 2
},
"id": "2109895311427",
"mappings": {
"core": {
"brand": "Nice",
"imageUrl": "https://i.imgur.com/El1W9kS.png",
"name": "Kitten T-Shirt",
"popularity": 78,
"price": 28,
"sku": "123ABC",
"thumbnailImageUrl": "https://i.imgur.com/El1W9kS.png",
"url": "https://en.wikipedia.org/wiki/Kitten"
}
}
},
{
"attributes": {
"days_since_published": 49,
"ga_unique_purchases": 42
},
"id": "2009427968067",
"mappings": {
"core": {
"brand": "The Good Brand",
"imageUrl": "https://i.imgur.com/El1W9kS.png",
"name": "Cat Shirt",
"popularity": 49,
"price": 28,
"sku": "DEF456",
"thumbnailImageUrl": "https://i.imgur.com/El1W9kS.png",
"url": "https://en.wikipedia.org/wiki/Cat"
}
}
}
]
}
]
Comments
0 comments
Please sign in to leave a comment.