variants

One variant with its stock and its suppliers

One variant as the catalogue holds it, and what is true of it right now: sku, barcode, gtin, lifecycle and its alias status, description and images, vendor, category, sell_price, unit_cost and unit_cost_currency, the physical fields, hs_code, country_of_origin, selected_options, custom_fields, launch_date, and the product_id and product_name it belongs to.

in_stock, incoming_stock and inventory_value are the stock figures, narrowed to one warehouse when location_id is sent and totalled across every warehouse when it is not. inventory_value is at cost, the variant's or else its product's, and it is null when neither carries one. health_cover is per location, {location, cover, health}, and performance_category_by_location carries the performance category and capital quadrant per location.

suppliers is who can supply it, production_type says whether it is bought, made or a raw material, and prepack carries the full prepack when it is part of one. last_stockout_date is null where it has never gone out of stock.

A variant id that does not exist in this organisation is refused 404.

Scope: products:read.

get/api/v1/variants/{variant_id}

Request

  • Base URL: https://api.app.tightly.io
  • URL: https://api.app.tightly.io/api/v1/variants/{variant_id}
  • Auth: HTTP bearer

Path parameters

variant_idstring required
Example:42318902722609

The variant this reads.

Query parameters

location_idstring
Example:61240442

Narrow in_stock, incoming_stock and inventory_value to one warehouse.

Headers

Tightly-Versionstring
Example:2026-11

The date train to answer on. One train exists today, 2026-11, the one this reference describes and the one every key is minted on, so the call answers on it with or without this header. Send it anyway, so a client built now names its train from the start.

Response

The variant, its stock and its suppliers.

messageobject

severity, service and desc.

Changes

No recorded changes to this operation across all 1 revision of this API.