Identifiers
Extended information on product and variant identifiers.
Overview
Use the Product Identifier and Variant Identifier fields to clearly identify the product that you are selling. The identifiers won't be shown to customers who view your products online.
When to use
Required for each product and variant
Format
Follow these formatting guidelines to make sure that Axiom understands the data that you're submitting.
| Type | Unicode characters (Recommended: ASCII only): alphanumeric, underscores and dashes |
|---|---|
| Limits | 1-255 Characters |
| Variant Inherits | No |
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.
- Submit a unique identifier for each different product.
- Use a stable identifier for each product. Once you've assigned an identifier to a product, don't change it. The identifier that you choose, identifies the product.
- Use the same identifier for the same product targeting different countries or different languages within the same country. You can create translations or pricing rules depending on the country, store and language.
- If you target a multilingual country, like Switzerland, use the same identifier for a product shared in each supported language such as German, French and Italian.
- If you target multiple countries, like the United States and Canada, use the same identifier for a product shared between countries.
- Don't use casing to make identifiers unique. Product identifiers are case-insensitive in the Axiom platform, there may be cases in which two products with product IDs that differ only by casing are interpreted as the same product. For example, if you submit identifier 'abc123' for one product and identifier 'ABC123' for another, these products may be confused. Instead of casing, use unique combinations of letters and numbers to differentiate products.
- Don't reuse or recycle the same identifier for different products. For example:
- Don't reuse an identifier for different products in the same target country or language.
- Don't reuse an identifier for products with variants. Each variant is a unique product and needs its unique identifier.
- Don't recycle an identifier for new products. Even if you're not selling a product anymore or the product is out of stock, don't use that product's identifier for any other product.
- Avoid white space. Consecutive white spaces and white spaces before and after the identifier will be automatically removed.
- Don't submit invalid Unicode characters. These characters are generally added during your file's encoding process. To avoid them, use UTF-8 encoding. Examples of invalid Unicode characters include:
- Control characters (e.g.
U+200D) - Function characters
- Private area characters
- Surrogate pairs
- Unassigned code points
- Control characters (e.g.
Best practices
These best practices can help you go beyond the basic requirements to optimise your product data for performance.
- Use internal system immutable identifiers where possible. As internal system identifiers can be guaranteed to be unique this can help prevent errors. Using SKUs as identifiers here is not recommended as they are generally not immutable and are often not a referenceable object in an e-commerce system.
Examples
Products without variants
Only a single product identifier is required
curl --location -g --request POST '{{baseUrl}}/suppliers/products' \\
--data-raw '{
"name": "BeeBlot™ Automated Immunoblot Processor, Gold Standard Diagnostic",
"sku": "123",
"codes": [
{
"code": "13411862134",
"type": "MPN"
}
],
"prices": [
{
"price": "38467.37",
"country": "GB",
"currency": "GBP"
}
],
"country": "US",
"quantity": "1 x each",
"categories": [
"Home",
"Blotting Apparatus"
],
"image_urls": [
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/56/13411356.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/57/13411357.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/58/13411358.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/59/13411359.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/60/13411360.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/61/13411361.jpg"
],
"product_identifier": "nzpkuuirhtia",
"properties": {
"Capacity": "50 strips per Run",
"quantity": "1 x each",
"Dimensions": "64 x 62 x 45 cm",
"Description": "BeeBlotTM Immunoblot Processor",
"Power supply": "100-240V, 50-60HZ",
"Ordering information:": "GSD experts will fully install, set up and train according to your specific laboratory requirements."
},
"description": "<div class=\\"textBodyText expander\\" data-linkify=\\"this\\" data-linkify-target=\\"_self\\">\\n<div class=\\"textBodyText\\">\\nIncrease productivity while reducing errors with automated processing, reading and analysis for strip based assays<br>\\n</div>\\n<br>\\n<div class=\\"textBodyText\\">\\nThe BeeBlot™ semi-automated immunoblot processor automates the protocol for most strip based assays, including Line Immunoassays and traditional Western Blots. When combined with the BLOTrix scanner and analysis software, processing and software-assisted interpretation of immunoblot diagnostic assays is possible.<br>\\n</div>\\n<br>\\n<div class=\\"textBodyText\\">\\nThe BLOTrix Scanner captures digital imagery of developed immunoassay strips. Simply load the tray from the BeeBlot processor into the reader, and the fully-integrated software assists with band identification and band interpretation. Images and results can be archived, and automatically sent to the LIS/LIMS system.<br>\\n</div>\\n<br>\\n<div class=\\"textBodyText\\">\\nGold Standard Diagnostics provides the instrumentation and software required to automate the labor-intensive manual processing of immunoblot assays.<br>\\n</div>\\n<br>\\n<div class=\\"textOrdering\\">\\n<b>Ordering information: </b>GSD experts will fully install, set up and train according to your specific laboratory requirements.<br>\\n</div>\\n</div>",
"manufacturer": "Gold Standard Diagnostics",
"document_urls": null,
"product_page_url": "https://us.vwr.com/store/product/13411864/beeblottm-nbsp-automated-immunoblot-processor-gold-standard-diagnostic"
}'
Product with variants
When a product has variants you will first need to create a parent product with its own identifier and then create the variants where each variant has its own variant_identifier.
curl --location --request POST 'https://api-dev.axiomdata.io/api/suppliers/products' \\
--data-raw '{
"name": "BeeBlot™ Automated Immunoblot Processor, Gold Standard Diagnostic",
"sku": "1234",
"codes": [
{
"code": "13411862134",
"type": "MPN"
}
],
"prices": [
{
"price": "38467.37",
"country": "GB",
"currency": "GBP"
}
],
"quantity": "1 x each",
"categories": [
"Home",
"Blotting Apparatus"
],
"image_urls": [
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/56/13411356.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/57/13411357.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/58/13411358.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/59/13411359.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/60/13411360.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/61/13411361.jpg"
],
"product_identifier": "nzpkuuirhtia",
"properties": {
"Capacity": "50 strips per Run",
"quantity": "1 x each",
"Dimensions": "64 x 62 x 45 cm",
"Description": "BeeBlotTM Immunoblot Processor",
"Power supply": "100-240V, 50-60HZ",
"Ordering information:": "GSD experts will fully install, set up and train according to your specific laboratory requirements."
},
"description": "<div class=\\"textBodyText expander\\" data-linkify=\\"this\\" data-linkify-target=\\"_self\\">\\n<div class=\\"textBodyText\\">\\nIncrease productivity while reducing errors with automated processing, reading and analysis for strip based assays<br>\\n</div>\\n<br>\\n<div class=\\"textBodyText\\">\\nThe BeeBlot™ semi-automated immunoblot processor automates the protocol for most strip based assays, including Line Immunoassays and traditional Western Blots. When combined with the BLOTrix scanner and analysis software, processing and software-assisted interpretation of immunoblot diagnostic assays is possible.<br>\\n</div>\\n<br>\\n<div class=\\"textBodyText\\">\\nThe BLOTrix Scanner captures digital imagery of developed immunoassay strips. Simply load the tray from the BeeBlot processor into the reader, and the fully-integrated software assists with band identification and band interpretation. Images and results can be archived, and automatically sent to the LIS/LIMS system.<br>\\n</div>\\n<br>\\n<div class=\\"textBodyText\\">\\nGold Standard Diagnostics provides the instrumentation and software required to automate the labor-intensive manual processing of immunoblot assays.<br>\\n</div>\\n<br>\\n<div class=\\"textOrdering\\">\\n<b>Ordering information: </b>GSD experts will fully install, set up and train according to your specific laboratory requirements.<br>\\n</div>\\n</div>",
"manufacturer": "Gold Standard Diagnostics",
"document_urls": null,
"product_page_url": "https://us.vwr.com/store/product/13411864/beeblottm-nbsp-automated-immunoblot-processor-gold-standard-diagnostic",
"variants": [{"name": "BeeBlot™ Automated Immunoblot Processor, Gold Standard Diagnostic",
"sku": "123-1",
"codes": [
{
"code": "13411862134-1",
"type": "MPN"
}
],
"prices": [
{
"price": "38467.37",
"country": "GB",
"currency": "GBP"
}
],
"quantity": "1 x each",
"options": [{"name": "option_name", "value": "option_value"}],
"categories": [
"Home",
"Blotting Apparatus"
],
"image_urls": [
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/56/13411356.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/57/13411357.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/58/13411358.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/59/13411359.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/60/13411360.jpg",
"https://us.vwr.com/stibo/bigweb/std.lang.all/13/61/13411361.jpg"
],
"variant_identifier": "nzpkuuirhtia-1",
"document_urls": null,
"product_page_url": "https://us.vwr.com/store/product/13411864/beeblottm-nbsp-automated-immunoblot-processor-gold-standard-diagnostic"}]
}'
Same product in multiple languages
When a product is offered in multiple languages you just need to create the same product again with the same product and variant identifiers along with any locale-specific information.
WIP