Product API Integrations
- Calum McDonald
How do I provide safety information?
Quick Links
For Product API integrations, safety information can be provided at SKU level by including the appropriate attribute name and value in the SKU description when creating or updating a product and SKU.
From 13th December 2024, if we are not able to display your product’s safety information it may be removed from sale
How to provide safety information via API
Providing your safety information via API can be done for existing and new products by creating or updating a product and SKU.
If you integrate via a Partner, and you are not able to use the below attribute names, you must provide safety information via CSV file upload until your Partner provides support.
Attribute Names
The following attribute names are available to provide safety information values:
Safety Warnings
CE Mark
Ingredients
Serial Number
Manufacturer Part Number
Model Number
Batch Number
Safety AttestationExpected Values
Please see below to understand what values are expected for each attribute name.
JSON incompatible values must be escaped. Click here to see an example API request.
Attribute Name | Value |
|---|---|
Safety Warnings | The applicable safety warnings for your SKU. Single safety warning: Not suitable for children under 36 monthsMultiple safety warnings: For example: ["Not suitable for children under 36 months","Choking Hazard","Adult supervision recommended"]Otherwise, please ensure that your list is readable as we display the values you upload on the product details page to the customer. We recommend using a character to separate list items, e.g. “.”, “/”, “-”, “•” |
CE Mark | A declaration that your SKU has a CE mark present. If applicable, please provide the value “1” as this corresponds to the following statement: This SKU has a CE mark present. 1Any value other than “1” will be ignored. If you provide a value other than “1” and your SKU is an a mandatory category, it may be removed from sale. |
Ingredients | A list of ingredients for your SKU, including quantity and unit if applicable. Single ingredient: Octinoxate 6.7%Multiple ingredients: If your integration supports it, we recommend using the below format to ensure that your list items are formatted correctly on the product details page. You can provide multiple safety warnings by enclosing the list in square brackets ([]), enclosing the list items in quotation marks (““) and separating list items with a comma (,). For example: ["Octinoxate 6.7%","Titanium Dioxide 1.6%","Butylene Glycol","Polymethylsilsesquioxane"]Otherwise, please ensure that your list is readable as we display the values you upload on the product details page to the customer. We recommend using a character to separate list items, e.g. “.”, “/”, “-”, “•” |
Serial Number | A unique identifier for your SKU if serial number is applicable. Optional |
Manufacturer Part Number | A unique identifier for your SKU if manufacturer part number is applicable. Optional |
Model Number | A unique identifier for your SKU if model number is applicable. Optional |
Batch Number | A unique identifier for your SKU if batch number is applicable. Optional |
Safety Attestation | An attestation that must be provided when safety information is not required for a SKU in an obligatory category path. If applicable, please provide the value “1” as this corresponds to the following statement: This SKU does not require safety information. 1Any value other than “1” will be ignored. If you provide a value other than “1” and your SKU is an a mandatory category, it may be removed from sale. |
Example
Please see below for an example:
...
"attributes": [
{
"name": "Safety Warnings",
"value": "[\"Not suitable for children under 36 months\",\"Choking Hazard\",\"Adult supervision recommended\"]"
},
{
"name": "CE Mark",
"value": "1"
}
]
...API Documentation
You can learn more about how to provide your product data via API by clicking the link below.