Options
Extended information on product and variant options.
Overview
Use the Options field to specify the combination of attributes which must be chosen in order to select the particular variant. Each variant can have many options associated with it, each option has a name and a value.
When to use
Required for each variant, not applicable to products
Format
Follow these formatting guidelines to make sure that Axiom understands the data that you're submitting.
Option Name
Type | String (Unicode characters. Recommended: ASCII only) |
---|---|
Limits | 1-150 Characters |
Option Value
Type | String (Unicode characters. Recommended: ASCII only) |
---|---|
Limits | 1-150 Characters |
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.
- Use a relevant option name that clearly describes the property of the product.
- Use a relevant property of the product to identify the different variants. For example, if you are selling beaker variants in different sizes it would be reasonable to use the volume of the beaker as an option, using the diameter or length of the beaker is less reasonable under most circumstances.
- Don't create option names which already exist as attributes.
- Don't create an unnecessary number of option names for the variants. For example, if a product has two variants, the maximum number of unique option names would be two, however best practice would be to only use one option name.
- Don't include product codes. Product codes do not need to be included in product options.
- If option values contain measurements it is best if they only include one measurement per value. This is for two reasons: 1. Axiom automatically extracts and normalises any units of measurement and this is more error-prone when there are multiple measurements. 2. When filtering products it is much easier for buyers to filter products which have only one measurement.
- e.g. "Electrical Requirements" : "1800W, 180V, 10A" would be best split out into three separate attributes: "Power Requirements" : "1800W", "Voltage Requirements" : "180V" and "Current Requirements" : "10A".
- It is fine for an attribute to have more than one unit of measure for a measurement e.g. "10cm (3.94in)"
- 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.
- Don't use foreign characters for gimmicky purposes. This technique is common in spam and untrustworthy product listings. For example: (ಠ_ಠ).
- 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. Don't add information such as price, sale price, other time-related information or your company's name.
- Don't use extra white spaces. Instead, use those characters in a more effective way to describe your product.
- Don't include references to categorisation systems.
- Don't include links to your shop or other websites.
- Only provide an option name and value when the value is confirmed. For example, for a food product, only provide 'Vegetarian=False' if it is confirmed the product is indeed not vegetarian, and not just because False is the default value for Boolean attributes.
- Don't list keywords or search terms. Only list relevant details and specifications of the product.
Best practices
These best practices can help you go beyond the basic requirements to optimise your product data for performance.
- Don't use all 150 characters. Your option names and values will be used to match your product to a customer's search. Only include the important details that define your product.
- Put the most important details first. Users will usually see only the first 30 or fewer characters of your option name and value, depending on screen size.
- Use generic option names. Option names will help connect your product with a person's search and help them recognise what you're selling.
- Use title case when submitting values for the option name. For example, use 'Focal Length' rather than 'focal length' or 'Focal length'.
- Do not duplicate data within the attribute.
- Check for errors in grammar, spelling or capitalisation.
Endpoints
https://api.axiomdata.io/api/suppliers/variants/{variant}/options
List Options
https://api.axiomdata.io/api/suppliers/variants/{variant}/options/{option}
Show Option
https://api.axiomdata.io/api/suppliers/variants/{variant}/options
Create Option
https://api.axiomdata.io/api/suppliers/variants/{variant}/options/{option}
Archive Option
https://api.axiomdata.io/api/suppliers/variants/{variant}/options/archives
List Option Archives
https://api.axiomdata.io/api/suppliers/variants/{variant}/options/{option}/restore
Restore