additionalImageUrls | String[] | no | Additional images associated with the variant |
additionalVideoUrls | String[] | no | Additional videos associated with the variant |
ageGroup | String | no | One of ADULTS , ALL_AGES , INFANT , KIDS , NEWBORN , or TODDLER |
brand | String | no | Ignored if another variant exists with the same itemId |
categoryId | Integer | yes | Google category ID |
description | String | yes | A short description of the variant |
gender | String | no | One of FEMALE , MALE , or UNISEX |
id | String | yes | The ID of the variant. This must match the item_variant_id in your pixel. |
isAvailable | Boolean | yes | Whether the variant is available or out of stock |
isBundle | Boolean | yes | Whether the variant is a collection of multiple items sold together |
itemId | String | yes | The ID that is shared across variants of an item. This must match the item_id in your pixel. |
multipackQuantity | Number | no | The number of identical items in a single pack |
name | String | yes | The name of the variant |
numberOfReviews | Number | no | The total number of reviews of the variant |
price | Decimal | yes | The price of the variant |
primaryImageUrl | String | yes | The primary image associated with the variant, which by default is shown when the variant is displayed |
primaryVideoUrl | String | no | The primary video associated with the variant, which by default is shown when the variant is displayed |
rating | Decimal | no | The rating of the variant, on a scale from 0 to 5 |
rewardEndDate | DateTime | no | The time when the rewardPercent validity ends. Format this as a UTC time according to ISO-8601, without a time zone offset. If rewardStartDate and rewardEndDate are both null , the rewardPercent is not active. If only rewardEndDate is null , the rewardPercent is active beginning at the rewardStartDate . |
rewardPercent | Number | no | The percent-reward that a customer receives for purchasing the variant, expressed as a number between 0 and 100 |
rewardStartDate | DateTime | no | The time when the rewardPercent begins to be valid. Format this as a UTC time according to ISO-8601, without a time zone offset. If rewardStartDate and rewardEndDate are both null , the rewardPercent is not active. If only rewardEndDate is null , the rewardPercent is active beginning at the rewardStartDate . |
salePrice | Decimal | no | The on-sale price of the variant |
salePriceEndDate | DateTime | no | The time when the salePrice validity ends. Format this as a UTC time according to ISO-8601, without a time zone offset. If salePriceStartDate and salePriceEndDate are both null , the salePrice is not active. If only salePriceEndDate is null , the salePrice is active beginning at the salePriceStartDate . |
salePriceStartDate | DateTime | no | The time when the salePrice begins to be valid. Format this as a UTC time according to ISO-8601, without a time zone offset. If salePriceStartDate and salePriceEndDate are both null , the salePrice is not active. If only salePriceStartDate is null , the salePrice is active until the salePriceEndDate . |
webUrl | String | yes | The product landing page URL. This page must have the pixel running and fire a View Item event. |