This document outlines the data requirements for supporting variants in our Searchspring Predictive Bundling.
General Guidelines:
- Include a column called ‘variants’ that contains the relevant variant data in the form of a json string
- The variant data provided will give us the attributes detailed in this document
- Ensure that the data is properly escaped for csv formatting
As an example if a product has color variants and the variants available are Black, Yellow, Cyan and Magenta
The data in the variants column will provide the necessary data for each of those color options
- The example provided uses "color". If a variant is using an alternate option you would follow the same structure for other options
- If a given variant is available in combination of multiple options ( ie color, size ) that would need to be expressed in the structure like this:
"options": {
"color": {
"value": "Yellow"
}, "size": {
"value": "26"
}
Required Format
We require, at a minimum, the fields listed below to construct the necessary data to enable the variant bundles
Format:
Core fields required:
UID
MSRP
PRICE
SKU
URL ( for each variation )
Attributes:
QUANTITY ( any generic stock quantity )
Title ( or name of the product for display )
AVAILABLE ( or any in/out of stock indicator )
OPTIONS:
These fields are subject to change and are/can be very different per customer depending on what data they want to utilize.
Example:
[
{
"id": 1,
"sku": "SKU0001",
"title": "product Cartridge - Yellow",
"price": 120.99,
"sale_price": 99.99,
"stock_information": "In Stock",
"quantity": 15,
"url": "https://example.com/product/cartridge-yellow",
"attributes": {
"color": {
"attribute_id": 1001,
"attribute_code": "color",
"attribute_label": "Color",
"value_id": "2001",
"value_label": "Yellow",
"swatch_value": "#FFFF00"
}
},
"image_url": "https://example.com/images/product-yellow.png",
"additional_images": null
},
{
"id": 2,
"sku": "SKU0002",
"title": "product Cartridge - Magenta",
"price": 130.99,
"sale_price": 110.99,
"stock_information": "In Stock",
"quantity": 20,
"url": "https://example.com/product/cartridge-magenta",
"attributes": {
"color": {
"attribute_id": 1002,
"attribute_code": "color",
"attribute_label": "Color",
"value_id": "2002",
"value_label": "Magenta",
"swatch_value": "#FF00FF"
}
},
"image_url": "https://example.com/images/product-magenta.png",
"additional_images": null
},
{
"id": 3,
"sku": "SKU0003",
"carepack": null,
"title": "product Cartridge - Cyan",
"price": 125.49,
"sale_price": 105.49,
"stock_information": "In Stock",
"quantity": 10,
"url": "https://example.com/product/cartridge-cyan",
"attributes": {
"color": {
"attribute_id": 1003,
"attribute_code": "color",
"attribute_label": "Color",
"value_id": "2003",
"value_label": "Cyan",
"swatch_value": "#007AC6"
}
},
"image_url": "https://example.com/images/product-cyan.png",
"additional_images": null
},
{
"id": 4,
"sku": "SKU0004",
"title": "product Cartridge - Black",
"price": 140.99,
"sale_price": 120.99,
"stock_information": "In Stock",
"quantity": 8,
"url": "https://example.com/product/cartridge-black",
"attributes": {
"color": {
"attribute_id": 1004,
"attribute_code": "color",
"attribute_label": "Color",
"value_id": "2004",
"value_label": "Black",
"swatch_value": "#000000"
}
},
"image_url": "https://example.com/images/product-black.png",
"additional_images": null
}
]
Included below is an example entry for a product with multiple options (Color and Size)
{
"id": 10189,
"sku": "1977B001",
"carepack": null,
"title": "Product Variant - Yellow - Large",
"price": 120.99,
"sale_price": "",
"stock_information": "In Stock",
"quantity": 10,
"url": "https:\/\/domain\/en_ca\/p\/pdp",
"attributes": {
"size": {
"attribute_id": 5256,
"attribute_code": "size",
"attribute_label": "Size",
"value_id": "2197",
"value_label": "Large",
"swatch_value": null
},
"color": {
"attribute_id": 5023,
"attribute_code": "color",
"attribute_label": "Color",
"value_id": "2196",
"value_label": "Yellow",
"swatch_value": "#ffff00"
}
},
"image_url": "https:\/\/domain.com\/is\/image\/someimage.jpg",
"additional_images": null
},
Supplemental Feed Guidelines
As mentioned in the guideline here.
Some key callouts when constructing a supplemental feed are the following:
- Must be a csv
- Must be hosted
- Must be accessible to Searchspring IPs
- Each Row contains a Unique Identifier matching an assignment found in your main Product Feed
Comments
0 comments
Please sign in to leave a comment.