Skip to main content

Properties

Extended information on product and variant properties.

Overview

Use the properties field to clearly identify the properties of the product that you are selling. Properties are one of the most important parts of your product listing. Your properties and properties values will be displayed to the buyer on the product page and will be used to filter and search for products.

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.

TypeString (Unicode characters. Recommended: ASCII only)
Limits1-150 Characters
Variant InheritsYes

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 property name that clearly describes the property of the product. Since properties can be normalised and mapped it is best to use generic and simple naming where possible.
  • Don't repeat any properties which have been used as Options.
  • Don't include product codes. Product codes do not need to be included in product properties, all product codes are automatically searched whenever a buyer performs a query.
  • If property 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 properties: "Power Requirements" : "1800W", "Voltage Requirements" : "180V" and "Current Requirements" : "10A".
    • It is fine for an property 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 property 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 properties.
  • 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 properties 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 property name, depending on screen size.
  • Use generic property names. Properties names will help connect your product with a person's search and help them recognise what you're selling.
  • Use sentence case when submitting values for the property. For example, use 'Focal length' rather than 'focal length' or 'Focal Length'.
  • Do not duplicate data within the property.
  • Check for errors in grammar, spelling or capitalisation.

Endpoints

GET

https://api.axiomdata.io/api/suppliers/products/{type}/{identifier}/properties

List Properties

GET

https://api.axiomdata.io/api/suppliers/products/{type}/{identifier}/properties/{propertyValue}

DELETE

https://api.axiomdata.io/api/suppliers/products/{type}/{identifier}/properties/{propertyValue}

GET

https://api.axiomdata.io/api/suppliers/products/{type}/{identifier}/properties/archives

List Property Archives

POST

https://api.axiomdata.io/api/suppliers/products/{type}/{identifier}/properties/{propertyValue}/restore

POST

https://api.axiomdata.io/api/suppliers/products/{type}/{identifier}/properties

Create Property

PUT

https://api.axiomdata.io/api/suppliers/products/{type}/{identifier}/properties/{propertyValue}

Last updated on Mar 28, 2025 by omelbs