Additional
PropertiesAdditional niches properties of products allow studying user preferences and calculating recommendations more accurately. This section describes allowing filling the product feed with niche features of cosmetics and perfumes.
Case Sensitivity
Warning |
---|
All parameter names are case-sensitive and should follow the spelling used in this documentation. |
Cosmetics
The "cosmetics" element must be inside the "offer" element.
Code Block |
---|
|
<offer ...>
...
<cosmetics>
...
</cosmetics>
</offer> |
Gender
The "gender" element must be inside the "cosmetics" element and can have one of the following values:
Value | Description |
---|
m | For men's products |
f | For women's products |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<gender>f</gender>
</cosmetic>
</offer> |
Tip |
---|
If the product is equally suitable for either gender, there is no need to add this element. |
Hypoallergenic
The "hypoallergenic" element must be inside the "cosmetics" element and can have the following values:
Value | Description |
---|
1 | Product is hypoallergenic |
0 | Product is non-hypoallergenic. The default value. |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<hypoallergenic>1</hypoallergenic>
</cosmetic>
</offer> |
Skin
Skin
The "skin" element must be inside the "cosmetics" element.
Code Block |
---|
|
<offer ...>
<cosmetics>
...
<skin>
...
</skin>
</cosmetics>
</offer> |
Type (skin)
The "type" elements must be inside the "skin" element of the "cosmetics" element and can have one of the following values:
Value | Description |
---|
dry | Products related to dry skin |
normal | Products related to normal skin |
oily | Products related to oily skin |
comby | Products related to combination skin |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<skin>
<type>normal</type>
<type>dry</type>
</skin>
</cosmetic>
</offer> |
Condition (skin)
Anchor |
---|
| skin_condition |
---|
| skin_condition |
---|
|
The "condition" elements must be inside the "skin" element of the "cosmetics" element and can have one of the following values:
Value | Description |
---|
dehydrated | Products related to dehydrated skin |
sensitive | Products related to sensitive skin |
problem | Products related to problematic skin |
fading | Products related to aging skin |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<skin>
<condition>sensitive</condition>
<condition>fading</condition>
</skin>
</cosmetic>
</offer> |
Part
The "part" elements must be inside the "skin" element of the "cosmetics" element and can have one of the following values:
Value | Description |
---|
face | Products related to facial care, makeup, oral hygiene, etc. |
body | Products related to body care, perfume, etc. |
intim | Products related to personal hygiene |
hand | Products related to hand and nail care |
leg | Products related to foot care |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<skin>
<part>face</part>
<part>body</part>
</skin>
</cosmetic>
</offer> |
Hair
The "hair" element must be inside the "cosmetics" element.
Code Block |
---|
|
<offer ...>
<cosmetics>
...
<hair>
...
</hair>
</cosmetics>
</offer> |
Type (hair)
The "type" elements must be inside the "hair" element of the "cosmetics" element and can have one of the following values:
Value | Description |
---|
dry | Products related to dry hair |
normal | Products related to normal hair |
oily | Products related to oily hair |
comby | Products related to combination hair |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<hair>
<type>normal</type>
<type>oily</type>
</hair>
</cosmetic>
</offer> |
Condition (hair)
Anchor |
---|
| hair_condition |
---|
| hair_condition |
---|
|
The "condition" elements must be inside the "hair" element of the "cosmetics" element and can have one of the following values:
Value | Description |
---|
colored | Products related to dyed hair |
damaged | Products related to damaged hair |
waved | Products related to curly hair |
seborea | Products related to dandruff |
akne | Products related to aсne, others head skin conditions |
loss | Products related to hair loss treatment |
grow | Products related to hair growth helping |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<hair>
<condition>colored</condition>
<condition>damaged</condition>
</hair>
</cosmetic>
</offer> |
Nail
The "nail" element must be inside the "cosmetics" element.
Code Block |
---|
|
<offer ...>
...
<cosmetics>
<nail>
...
</nail>
<cosmetics>
</offer> |
Type (nail)
The "type" elements must be inside the "nail" element of the "cosmetics" element and can have one of the following values:
Value | Description |
---|
tool | Products related to nail care tool |
polish | Products related to nail polish |
gel | Products related to gel polish |
oil | Products related to nail oil |
cleaner | Products related to nail cleaner |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<nail>
<type>tool</type>
</nail>
</cosmetic>
</offer> |
Polish Color
The "polish_color" element must be inside the "nail" element of the "cosmetics" element and can have any value describing the color of the nail polish.
Note |
---|
This element can only be used in combination with the "polish" type. See above. |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<nail>
<type>polish</type>
<polish_color>red</polish_color>
</nail>
</cosmetic>
</offer> |
Perfume
Perfume
The "perfume" element must be inside the "cosmetics" element.
Code Block |
---|
|
<offer ...>
...
<cosmetics>
<perfume>
...
</perfume>
<cosmetics>
</offer> |
Family
The "family" element must be inside the "perfume" element of the "cosmetics" element and can have one of the following values:
Value | Description |
---|
floral | Perfume products of the floral note family |
oriental | Perfume products of the oriental note family |
woody | Perfume products of the woody note family |
fresh | Perfume products of the fresh note family |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<perfume>
<family>woody</family>
</perfume>
</cosmetic>
</offer> |
Aroma
The "aroma" element must be inside the "perfume" element of the "cosmetics" element and can have one of the following values:
Value | Relations | Description | Commentary |
---|
fruity_floral | Floral Family
| Fruity Floral (Fruity + Floral Notes) | Main notes include fruits and floral notes |
floral | Floral (Floral + Fresh Notes) | Main notes include fresh-cut flowers |
soft_floral | Soft Floral (Floral Notes) | Main notes include aldehydes and powdery notes |
floral_oriental | Oriental Family | Floral Oriental (Floral + Oriental Notes) | Main notes include white flowers (such as orange blossom) and sweet spices |
soft_oriental | Soft Oriental (Oriental + Floral Notes) | Main notes include incense and amber |
oriental | Oriental (Oriental Notes) | Main notes include oriental resins such as frankincense, and vanilla |
woody_oriental | Woody Oriental (Oriental + Woody Notes) | Main notes include sandalwood and patchouli. |
woods | Woody Family | Woods | Main notes include aromatic woods and vetiver |
mossy_woods | Mossy Woods (Woody + Oriental Notes) | Main notes include oakmoss and amber |
dry_woods | Dry Woods (Woody Notes) | Main notes include dry woods and leather |
aromatic | Fresh Family | Aromatic Fougère (Fresh Notes) | Main notes include lavender and aromatic herbs. This universal fragrance group includes elements from different families: the freshness from the Citrus family, floral notes of lavender, the spicy-sweetness of a Floral Oriental, the ambery depth of an Oriental and the Mossy Woods warmth of sandalwood and oakmoss. |
citrus | Citrus (Woody + Fresh Notes) | Main notes include bergamot and other citrus oils |
water | Water (Fresh + Floral Notes) | Main notes include marine and aquatic notes, generally from the chemical calone |
green | Green (Fresh + Floral Notes) | Main notes include galbanum and green notes. |
fruity | Fruity (Fresh + Floral Notes) | Main notes include berries and other non-citrus fruits |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<perfume>
<family>woody</family>
<aroma>mossy_woods</aroma>
</perfume>
</cosmetic>
</offer> |
Volume
The "volume" elements must be inside the "volumes" element of the "cosmetics" element. Each "volume" element must contain the "value" and "price" elements:
Name | Type | Description |
---|
value | number | Volume in milliliters |
price | number | Price for each volume |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<volumes>
<volume>
<value>200</value>
<price>1000</price>
</volume>
<volume>
<value>400</value>
<price>2000</price>
</volume>
</volumes>
</cosmetic>
</offer> |
Periodic
The "periodic" element must be inside the "cosmetics" element and can have the following values:
Value | Description |
---|
1 | Product is purchased frequently |
0 | Product is purchased occasionally. The default value. |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<periodic>1</periodic>
</cosmetic>
</offer> |
Professional
The "professional" element must be inside the "cosmetics" element and can have the following values:
Value | Description |
---|
1 | Product is purchased for professional use (by professionals) |
0 | Product is purchased for everyday use (by ordinary customers). The default value. |
Code Block |
---|
|
<offer ...>
...
<cosmetic>
<professional>1</professional>
</cosmetic>
</offer> |