Debenhams Taxonomy
Summary of Changes: (The purpose of this table is to keep traceability and Product team to highlight the things that were changed into the scope, based on comments or discussions)
Date | Version | Created / Updated | Notes |
---|---|---|---|
12/07/2023 | 1.0 | Hristiyan | First publish |
The purpose of this page is to give detailed explanations of how we will download the taxonomy for MIRAKL.
The taxonomy must be stored in classes, which should be available for exports from the UI in Export Taxonomy table. The taxonomy is used for internal validation and we will need to map the values and push the codes to MIRAKL.
Every time we send products for creation we have to do internal check if all required attributes are part of the the product as Item Specifics or Variation Specifics according to their taxonomy which we download and store on the instance.
To download the taxonomy, we should follow the steps:
- GET H11 - List Catalog categories
Using this call, we are able to get all available categories for MIRAKL.
API Call:/api/hierarchies
API Docs: https://help.mirakl.net/help/api-doc/seller/mmp.html#H11
{
"hierarchies": [
{
"code": "5911111",
"label": "Suncare",
"label_translations": [
{
"locale": "en",
"value": "Suncare"
},
{
"locale": "fr",
"value": "Protection solaire"
}
],
"level": 2,
"parent_code": "59"
},
{
"code": "5911112",
"label": "Toiletries",
"label_translations": [
{
"locale": "en",
"value": "Toiletries"
},
{
"locale": "fr",
"value": "Articles de toilette"
}
],
"level": 2,
"parent_code": "59"
},
{
"code": "5911113",
"label": "Womens Hair Removal",
"label_translations": [
{
"locale": "en",
"value": "Womens Hair Removal"
},
{
"locale": "fr",
"value": "Épilation Femmes"
}
],
"level": 2,
"parent_code": "59"
}
]
}
- GET PM11 - Get the product attribute configuration
Via this call, we are able to obtain the attributes for the categories.
API Call: /api/products/attributes
API Docs: https://help.mirakl.net/help/api-doc/seller/mmp.html#PM11
{
"attributes": [
{
"channels": [
{
"code": "WEBSITE_EN"
}
],
"code": "washingInstructions3",
"default_value": null,
"description": "How do you wash the product",
"description_translations": [
{
"locale": "en",
"value": "How do you wash the product"
}
],
"example": null,
"hierarchy_code": "3012",
"label": "Washing Instructions",
"label_translations": [
{
"locale": "en",
"value": "Washing Instructions"
}
],
"locale": "en_US",
"requirement_level": "OPTIONAL",
"roles": [],
"transformations": "CAMEL_CASE",
"type": "TEXT",
"type_parameter": null,
"validations": "MIN_LENGTH|10",
"variant": false
},
{
"channels": [
{
"code": "WEBSITE_FR"
},
{
"code": "WEBSITE_EN"
}
],
"code": "toolsIncluded3",
"default_value": null,
"description": "Are tools included for the assembly of this product",
"description_translations": [
{
"locale": "en",
"value": "Are tools included for the assembly of this product"
}
],
"example": null,
"hierarchy_code": "5610102",
"label": "Tools Included",
"label_translations": [
{
"locale": "en",
"value": "Tools Included"
}
],
"requirement_level": "OPTIONAL",
"roles": [],
"type": "LIST",
"type_parameter": "Boolean",
"variant": false
}
]
}
- GET VL11 - Get information about operator's value lists
With this API call, we get all available values for each attribute.
API Call: /api/values_lists
API Docs: https://help.mirakl.net/help/api-doc/seller/mmp.html#VL11
{
"values_lists": [
{
"code": "Jewellery",
"label": "Bijoux",
"label_translations": [
{
"locale": "en",
"value": "Jewellery"
},
{
"locale": "fr",
"value": "Bijoux"
}
],
"values": [
{
"code": "Accessories",
"label": "Accessoires",
"label_translations": [
{
"locale": "en",
"value": "Accessories"
},
{
"locale": "fr",
"value": "Accessoires"
}
]
},
{
"code": "Bracelets",
"label": "Bracelets",
"label_translations": [
{
"locale": "en",
"value": "Bracelets"
},
{
"locale": "fr",
"value": "Bracelets"
}
]
},
{
"code": "Necklaces",
"label": "Colliers",
"label_translations": [
{
"locale": "en",
"value": "Necklaces"
},
{
"locale": "fr",
"value": "Colliers"
}
]
},
{
"code": "Rings",
"label": "Anneaux",
"label_translations": [
{
"locale": "en",
"value": "Rings"
},
{
"locale": "fr",
"value": "Anneaux"
}
]
}
]
}
]
}
Taxonomy export file
In order to generate the taxonomy file we will need to create a new record in Taxonomy export with: Marketplace = Debenhams Status = pending Category for Export = all (or we can specify which exact categories) Email = email to which the file will be send
Please find more details on the file structure how it should look like after exported here - Taxonomy General requirements .
There are some root attributes which we would like to include in the taxonomy export for every category.
Attribute Name | Attribute Code | Comment |
---|---|---|
swatch |
Swatch - required size 120 x 120 pixels (this is like a thumbnail photo) | |
returns |
||
gender |
||
collection |
||
details_and_care |
||
colour |
||
colourfacet |
||
fabrication_type |
Column | Column | Column | Column | Column | Column | Column | Column | ||||
---|---|---|---|---|---|---|---|---|---|---|---|
PrimaryCatID | PrimaryCatName | Category Path | Is Leaf | Item Specifics | Required | Enumeration | Values | ||||
123 | Shoes | Yes | Color | Yes | No | ||||||
123 | Shoes | Yes | Size | Yes | No | ||||||
123 | Shoes | Yes | Material | No | Yes | Red | White | Black | |||
123 | Shoes | Yes | Type | No | Yes | 40 | 41 | 42 | 43 | 44 | |
1234 | Gloves | Yes | Color | Yes | No | ||||||
1234 | Gloves | Yes | Size | Yes | No |