Product Feed
For the widget to work, all the product data present in the online store has to be synchronized with the Garderobo AI database. To do this, we need access the product feed.
Google Product Feed (the specifications of this format are described in detail at the link) is the most conveient product feed format for the integration.
If you use a different format, please find the requirements for filling in the data below (the parameter names may be different from those presented in the list):
id
required
Your product’s unique identifier
Use a unique value for each product. Use the product's SKU where possible.
Keep the ID the same when updating your data
title
required
Your product’s name
Example: Mens Pique Polo Shirt
Accurately describe your product and match the title from your landing page
Don’t include promotional text like "free shipping," all capital letters, or gimmicky foreign characters
link
required
Your product’s landing page
Example:
http://www.example.com/asp/sp.asp?cat=12&id=1030
Use your verified domain name
Start with http or https
image_link
required
The URL of your product’s main image
Example:
http://www.example.com/image1.jpg
Link to the main image of your product
Start with http or https
model_image_link
optional
If you need image recognition functionality on the model, you must additionally transmit a full-length photo of the model.
availability
required
Accurately submit the product's availability and match the availability from your landing page and checkout pages.
Supported values:
In stock
Out of stock
True
False
price
required
Your product’s price
Example: 15.00 USD
sale_price
required
Your product's sale price
Example: 10.00 USD
product_category
required
Google-defined product category for your product
Example: Apparel & Accessories > Clothing > Outerwear > Coats & Jackets
Include only 1 category
Include the most relevant category
Include the full path of the category
brand
optional
Your product’s brand name
Example: Garderobo
Provide the brand name of the product generally recognized by consumers
Providing the correct brand for a product will result in the best model performance and ensure the best user experience.
item_group_id
required
ID for a group of products that come in different versions (variants)
Use a unique value for each group of variants. Use the parent SKU where possible
Keep this value the same when updating your product data
Use only valid unicode characters
Use an item group ID for a set of products that differ by one or more of these attributes:
— Color [color]
— Size [size]
— Pattern [pattern]
— Material [material]
— Age group [age_group]
— Gender [gender]
Include the same attributes for each product in the item group. For example, if a product varies by size and color, submit size [size] and color [color] for every product that shares the same value for the item group ID [item_group_id]
If your products differ by design elements that are not represented by the attributes above, don't use the same item group ID for these items.
size
required
Your product’s size
Example: XL
color
optional
Your product’s color(s)
Example: Black
Don’t use numbers, such as "0", "2", or "4"
Don’t use characters that aren’t alphanumeric, such as "#fff000"
Don’t use only 1 letter, such as R (For Chinese, Japanese, or Korean languages, you can include a single character such as 红).
Don’t reference the product or image, such as “see image”
Don't combine several color names into 1 word, such as "RedPinkBlue". Instead, separate them with a /, such as "Red/Pink/Blue". Don’t use a value that isn’t a color, such as "multicolor", "various", "variety", "men's", "women's", or "N/A".
If your product features multiple colors, list the primary color first.
gender
required
The gender for which your product is intended
Example: Unisex
Supported values:
Male
Female
Unisex
age_group
optional
The demographic for which your product is intended
Example: Adult
Supported values:
Toddler
Kids
Teenagers
Adult
season
required
The season for which the clothes are designed
Example: spring-summer
Supported values:
spring-summer
fall-winter
basic (without season)
To update products amount or price in real time, use the API:
curl \
--location "https://api.modatech.ru/api/v3/products/update/" \
-X POST \
-H "Content-Type: application/json" \
-H "X-Api-Key: xxx" \
--data '{
"api_token": "yyy",
"offers": [
{
"available": 0,
"id": "281029",
"old_price": "",
"price": "4599.00",
"cities": ["Allcities"]
}
]
}'
Last updated