Product Feed guide
preezie uses information from your product database to match and display product recommendations. To do this, we require access to your product information via a feed, API or a hosted file.
It is then filtered in the CMS to match only products that are referenced in your CMS journey logic. The data available here can be used to both match products and display their attributes on the preezie results page.
Supported formats
Below are our supported data feed formats, security credentials can be added directly into the CMS.
NOTE: We cannot accept compressed files including .zip .rar .gz etc…
Shopify API
Via a dedicated Private App. To find out how to create a Private App in Shopify see Shopify APIXML standard
Hosted on a publicly available URL eg: https://preezieclientassets.blob.core.windows.net/images/feeds/example.xmlJSON format
Needs to contain a list of productsCSV
Hosted on a publicly available URLTXT
Tab-delimited .txt file, hosted on a publicly available URLFlat file import of product database
Suitable for databases that don’t update often, CMS users can manage a static product catalogue
Data field requirements
The more information your data feeds include the better. Below are examples of desirable fields in order for your preezie journeys to serve product recommendations.
Each product ID/SKU should be included at the child/variant level, this allows us to match and display the exact item that matches a shopper’s needs, for example an individual size or colour.
We recommend that data fields should be formatted without spaces or special characters with 32 character limit. See examples in table below
Field type | Mandatory | Info | Example Field Name | Example Data |
---|---|---|---|---|
Unique Identifier | * | A unique identifier like a SKU or Product ID | sku | GMSD1234 |
Product Name | * | The display title for your product | product_name | Green Maxi Summer Dress |
Product URL | * | A link to your product | url | www.yourstore.com.au/green-maxi |
Product Image | * | A link to your main product image. Note, we only support single images | image_url | www.yourstore.com.au/green-maxi-image.png |
Product Price | * | The selling price of your product. Data should be uniform throughout. Either to two decimal places or as a integer value including cents/pence/etc. | price | 2 decimal places → 123.00 Integer Value → 12300 |
Discounted Price |
| The discounted price for your product if it is on sale. Data should be in the same format as price field. | discount_price | 2 decimal places → 103.00 Integer Value → 10300 |
In Stock |
| This will ensure preezie only recommends in stock products | in_stock | Yes / No Available / Unavailable 1 / 0 |
Category |
| The category or type of product | category | Knitwear |
Sub-category |
| The sub-category underneath the category | sub_category | Scarfs |
Description |
| The product description | description |
|
Size / Colour / Weight |
| Any useful datapoints that can leveraged in order to add logic to your recommendations or display on the results screen | size | XS |
Tags |
| Any tags or meta data related to the product | tags | organic |
Star rating |
| Rating count of the product. This can be a decimal number, preezie rounds up and shows the correct stars on the results | rating | Integer → 4.3 |
You can include as many additional fields as you like. The more information you include, the more nuanced you will be able to make your product recommendations!
Example format in xml
<?xml version="1.0" encoding="utf-8"?>
<products name="MyShop_preezie" extractDate="2022-08-29T11:04:03+10:00">
<product>
<productCode>SKU001</productCode>
<productType>Running shoes</productType>
<productName>Light blue running trainers women's size 10</productName>
<productDescription>
<altDescription>Running Trainers Women's size 10</altDescription>
</productDescription>
<countryCode>AU</countryCode>
<departmentDetails>
<referenceName>Excercise</referenceName>
</departmentDetails>
<subDepartmentDetails>
<referenceName>Running</referenceName>
</subDepartmentDetails>
<subSubDepartmentDetails>
<referenceName>Womens</referenceName>
</subSubDepartmentDetails>
<seasonDetails>
<referenceName>AW 2022</referenceName>
</seasonDetails>
<attributeFlags>
<availability>
<inStock>true</inStock>
</availability>
<visibility>
<web>true</web>
<store>true</store>
</visibility>
<price>139.00</price>
<salePrice>109.00</salePrice>
<quantity>224</quantity>
<width>standard</width>
<weight>220g</weight>
<description>This advanced running shoe offers impact protection for middle or long distance training. This design features reflective details to improve visibility in low-light settings and a soft engineered mesh to be more comfortable during longer runs.</description>
<detail>
<support>Neutral</support>
<cushioning>Hi-foam</cushioning>
</detail>
<variant>
<colour>Blue</colour>
<colourVariant>Light Blue</colourVariant>
<materials>leather, cotton, polyester, rubber</materials>
<rating>4.65</rating>
</variant>
<fulfilment>
<Delivery>true</Delivery>
<clickCollect>true</clickCollect>
<eBay>true</eBay>
<dropShip>false</dropShip>
</fulfilment>
<highlights>
<newProduct>false</newProduct>
<exclusive>false</exclusive>
<sale>true</sale>
<freeDelivery>false</freeDelivery>
<assortedColours>true</assortedColours>
</highlights>
</attributeFlags>
<productIdentification>
<parentSKU>SKU0020</parentSKU>
</productIdentification>
<webProductPageDetails>
<websiteCode>AU</websiteCode>
<url>https://www.myshop.com.au/exercise/running/light-blue-running-trainers-womens-size-10</url>
<imageUrl>https://www.myshop.com.au/exercise/running/images/light-blue-running-trainers-womens-size-10_Medium.png</imageUrl>
</webProductPageDetails>
</product>
</products>
Example format in JSON
{
"products": {
"product": {
"productCode": "SKU001",
"productType": "Running shoes",
"productName": "Light blue running trainers women's size 10",
"productDescription": {
"altDescription": "Running Trainers Women's size 10"
},
"countryCode": "AU",
"departmentDetails": {
"referenceName": "Excercise"
},
"subDepartmentDetails": {
"referenceName": "Running"
},
"subSubDepartmentDetails": {
"referenceName": "Womens"
},
"seasonDetails": {
"referenceName": "AW 2022"
},
"attributeFlags": {
"availability": {
"inStock": true
},
"visibility": {
"web": true,
"store": true
},
"price": 139,
"salePrice": 109,
"quantity": 224,
"width": "standard",
"weight": "220g",
"description": "This advanced running shoe offers impact protection for middle or long distance training. This design features reflective details to improve visibility in low-light settings and a soft engineered mesh to be more comfortable during longer runs.",
"detail": {
"support": "Neutral",
"cushioning": "Hi-foam"
},
"variant": {
"colour": "Blue",
"colourVariant": "Light Blue",
"materials": "leather, cotton, polyester, rubber",
"rating": 4.65
},
"fulfilment": {
"Delivery": true,
"clickCollect": true,
"eBay": true,
"dropShip": false
},
"highlights": {
"newProduct": false,
"exclusive": false,
"sale": true,
"freeDelivery": false,
"assortedColours": true
}
},
"productIdentification": {
"parentSKU": "SKU0020"
},
"webProductPageDetails": {
"websiteCode": "AU",
"url": "https://www.myshop.com.au/exercise/running/light-blue-running-trainers-womens-size-10",
"imageUrl": "https://www.myshop.com.au/exercise/running/images/light-blue-running-trainers-womens-size-10_Medium.png"
}
}
}
}
After you have imported your products into your preezie database you can now see and test the products available using the Product catalogue tester .