API endpoint: product
[Back to root]
Show product based on SKU. You can get this also in JSON or XML format.
See the root documentation page to learn how to do this.
Localization via the querystring
This endpoint supports localization via the querystring parameter 'language'.
See the root documention page to learn how to use it.
Description of fields in the response
- id
- Unique numerical identifier of the product.
- name
- Name of the product.
- short_name
- Possibly different version of the product's name.
- category
- Main category the product belongs to (available categories).
- description
- HTML-formatted short description of the product.
- modified_at
- Date and time (UTC) the product's data was last modified.
- image
- Main image of the product, screen quality.
- sku_information
- List of SKU's (product variants) with their specific properties.
- sku_information.sku
- Code of the SKU.
- sku_information.html_description
- HTML-formatted description of the SKU, or null if it the description does not exist (yet).
The field description can be used as a fallback.
- sku_information.created_at
- Creation date and time (UTC) of the SKU.
- sku_information.is_eol
- Whether or not the SKU has end-of-life status.
- documents
- List of documents and high quality photos associated with the product.
- documents.id
- Numerical identifier for the document or high quality photo. Note that the id is unique within the
document's respective group (high quality photos vs. other documents).
- documents.sku
- List of SKU's (product variants) the document or high quality photo is relevant for.
- documents.name
- Descriptive title of the document or high quality photo.
- documents.document_type
- Type of the document (available types).
- documents.url
- Url of the document.
- documents.notes
- If relevant, notes on the document use.
- external_images
- List of high quality photos that are not listed in the downloads sections of the Victron website product pages.
Note that the subfields are the same as in the documents-field.
- main_images
- List of high quality photos that are considered the main photo for a specific SKU (product variant).
Note that the subfields are the same as in the documents-field.
- sku
- List of SKU-codes (product variants) the product has.
- qr_images
- Several color/format variants of the QR code that leads to the relevant product page on the Victron website.
- pms_technical_data
- List of technical properties of the product.
- pms_technical_data.sku
- The sku (product variant) the technical property belongs to.
- pms_technical_data.field_name
- Name of the property.
- pms_technical_data.field_value
- Value of the property.
[
]