Skip to main content

Get Product

GET 
/api/v2/products/:product

Get a single product with default relations loaded (brand, primaryImage, primaryCategory, tags, defaultSupplierProduct.supplier, totalInventory).

Required scope: products:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Use the with query parameter to load additional relations.

Load productAttributeValues.attribute.attributeGroup and productAttributeValues.attribute.values to include product_attributes in the response. Each entry carries the stored value plus the attribute's editing metadata:

  • type — stored data type: string, longtext, numeric, integer, date, datetime, checkbox
  • display_options — has_options, type (Single or Multi), option_display_type (e.g. swatch), allow_custom_value, is_html, is_link, sort_order
  • validation — optional constraints: limit (max characters), precision (decimal places), min, max
  • options — the configured option list with per-option swatch data (value, swatch_hex, swatch_image_url, sort_order); empty when the attribute is not option-backed or when productAttributeValues.attribute.values was not requested
  • group_id / group_name — the attribute group the attribute belongs to

Multi-value attributes (display_options.type = Multi) hold every selected value in a single newline-separated string.

Request​

Responses​

OK

Response Headers
    Content-Type