Description
Extended information on product and variant descriptions.
Overview
Use the description field to tell customers about your product. List product features, technical specifications and visual attributes. A detailed description will help us show your product to the right customers.
When to use
Optional for each product and variant
Format
Follow these formatting guidelines to make sure that Axiom understands the data that you're submitting.
Type | String (Unicode characters. Recommended: ASCII only) |
---|---|
Limits | 1–2000 characters |
Variant inherits | Yes |
*Malformed HTML (for example, non-closed tags) and unsafe features (such as javascript) are not allowed.
HTML Tags
Status | Examples |
---|---|
Supported (non-exhaustive list) | strong , em , ul , ol , li , br , sub , sup , div , span , dl , dt , dd |
Not supported | - Attributes of all tags - Unsafe tags, for example, style or canvas |
Guidelines
Follow these guidelines to make sure that you submit high-quality data for your products.
Minimum requirements
These are the requirements that you'll need to meet to show your product. If you don't follow these requirements, we could reject your product.
- Describe only the product itself. Don't describe other aspects like details about compatible products, accessories or other similar products available. Don't provide your business's history or policies.
- Use professional and grammatically correct language. Correct grammar is easier to understand and gives you a more professional appearance, which can lead to more clicks. Also avoid gimmicky ways of drawing attention, such as all caps, symbols and promotional text.
- Don't use words from foreign languages, unless they're well understood such as a product with a foreign name or title.
- For example, 'sushi' is a word well understood outside of Japan.
- Write foreign words using the alphabet of your target language. For example, avoid Japanese characters when targeting the United States. Letters with accents, like 'Les Clés' are allowed.
- Don't use foreign characters for gimmicky purposes. This technique is common in spam and untrustworthy product listings. For example: (ಠ_ಠ)
- Use escaped characters instead of symbols. If you're submitting your product data in JSONL, and you need to include symbols, make sure that you follow the JSONL specification. For JSONL, use escape characters such as '\'. If you automatically encode your description, be careful not to encode it twice.
- Don't include comparisons or details about other products. For example, don't mention things like 'even better than X'. Let customers research other products on their own.
- Don't include references to categorisation systems.
- Don't include links to your shop or other websites.
- Don't use capital letters for emphasis. Capitalised text is common in spam and untrustworthy product listings. You should still use capitalisation when it's appropriate, including for abbreviations, phone numbers, countries and currency. For example, ADHD, UNICEF, 1-555-CALL-NOW, UK and USD.
- Don't include promotional text such as price, sale price, sale dates, dispatch, delivery date, other time-related information or your company's name.
- Submit a description for each product. Products that don't include a value for the description attribute may experience limited performance. Similar products that include a description may be prioritised.
Best practices
These best practices can help you go beyond the basic requirements to optimise your product data for performance.
- Be specific and accurate. The more specific that you are in your description, the easier it is for users to identify the product that they are searching for.
- List the most important details in the first 160 – 500 characters. You can include up to 5,000 characters, but customers will need to click to view product details to see the longer description.
- Include your product's most relevant features and visual attributes. Examples of types of information to include:
- Size
- Material
- Special features
- Technical specifications
- Design. For example, customers can search for very specific visual terms like 'retractable ballpoint pens'.
- Variants. List product-defining details like colour, size, age group, pattern, flavour or material.
- Rich descriptions. Customers find descriptions easier to read when they are well formatted. Include control characters and HTML tags, such as line breaks, italics and bulleted lists to increase the readability of your description.