Attributes Reference

Id

A unique identifier for the product at the color level. It should not be reused.

Needs to match the identifiers passed from web tracking and transaction data.

Y

Y

VariantId

A unique identifier for a product at color and size level. It should not be reused.

Needs to match the identifiers passed from web tracking and transaction data.

Y

Name

A consumer-friendly name for the product

Do not include markup or formatting

Y

Description

A short description of the products and their attributes

Do not include markup or formatting

Y

Brand Name

The name of the brand of the item

Y (except single-brand retailers)

Size

The size of the variant, e.g., UK 12

Locale can be omitted if all sizes are from the same locale

Y

Availability

Whether that specific variant of the product is currently available

Either numeric (quantity) or in stock, low stock, out of stock

Y

SetId

An identifier grouping products that are part of a set (e.g., a bikini top and bottom)

N

GroupId

An identifier grouping products that are color/pattern variants of each other

Strongly recommended

N

Color

A color name for the item

N

Price

The current price for the item (this is the sale price)

Y

ListPrice

What is the list price/catalog price / RRP for the item (the price for this item before discounts and sales).

Y

IsDiscounted

A boolean indicating whether this item is in a sale/discounted

Y

Currency

3-letter currency code (e.g., GBP, USD)

Required if multi-locale

See Notes

Url

A URL to the product page for the item

It should be a direct link (i.e.,e. not via a tracking service). We can append tracking parameters (if required)

Y

ProductOnlyFrontImageUrl

an image URL of the product, on its own, viewed from the front

At least 200x300

See below

See below

ProductOnlyBackImageUrl

an image URL of the product, on its own, viewed from the back

At least 200x300

See below

See below

ProductOnlySideImageUrl

an image URL of the product, on its own, viewed from the side

At least 200x300

See below

See below

ModelFrontImageUrl

an image URL of the product on a model, viewed from the front

At least 200x300

See below

See below

ModelFrontCloseupImageUrl

an image URL of the product on a model, viewed from the front, cropped so that only the main product is visible (e.g., for a pair of trousers, this would be from the waist down)

At least 200x300

See below

See below

ModelBackCloseupImageUrl

an image URL of the product on a model, viewed from the back, cropped so that only the main product is visible (e.g., for a pair of trousers, this would be from the waist down)

At least 200x300

See below

See below

ModelSideImageUrl

an image URL of the product on a model, viewed from the side

At least 200x300

See below

See below

ModelBackImageUrl

an image URL of the product on a model, viewed from the back

At least 200x300

See below

See below

ColourSwatchImageUrl

An image URL of a close-up of the product that is representative of its overall color pattern (not just a solid block of color)

At least 200x300

N

Category

A short category description.

For example, "Women Dresses"

Y

Y

ExtraCategories

One of more alternative category names or IDs.

Enables features such as displaying one of your categories filtered/ordered according to the user’s preferences

N

GTIN/EAN

The GTIN, EAN, etc., present on barcodes

Y

Gender

The gender of the item (male, female)

Required if both types of products present

Y

Y

Composition

The material composition of the item

Y

Y

Attributes

Any structured data held about the item (e.g., fit, length, etc.)

N

Rating

Rating data about the item

average score, distribution of scores

N

Bundle

Whether the item is a bundle of related items

for example, a bikini set or a matching top and bottom

N

Multipack

Whether the item is a multipack

for example, three pairs of knickers

M