List product variants

Parameters

Query

product_id string

Filter by parent product ID

archived boolean

Filter by archived status

cursor string

Cursor for pagination

limit integer

Pagination limit

direction string default: next

Pagination direction: 'next' or 'prev'

include_total_count boolean default: False

Whether to include total count (expensive - avoid if possible)

sort_by string

Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.

descending boolean default: True

Sort direction: true for descending (newest/largest first), false for ascending

Responses

Schema: VariantsListResponse

items array · VariantResponse requiredVariantResponse

List of items

24 fields

id string required: Variant UUID.
product_id string required: Parent product UUID.
business_id string required: Business UUID.
created_at string · date-time required: Creation timestamp.
updated_at string · date-time required: Last update timestamp.
name string required: Variant name.
sku string: Stock Keeping Unit.
manufacturer_sku string: Manufacturer's SKU.
archived boolean: Whether variant is archived.
price number: Unit price in dollars (legacy field, prefer unit_price).
cost number: Unit cost in dollars (legacy field, prefer unit_cost).
inventory_quantity integer: Current inventory quantity (legacy, prefer inventory.on_hand).
shopify_variant_id string: Shopify variant ID if synced from Shopify.
stripe_price_id string: Stripe price ID if synced to Stripe.
stripe_product_id string: Stripe product ID if synced to Stripe.
unit_price integer: Sale price in cents.
unit_cost integer: Cost price in cents.
unit_cost_precise number: Precise unit cost in dollars with sub-cent precision.
uom string: Unit of measure: EA, LB, G, KG, OZ, etc.
default_vendor_id string: Preferred vendor UUID.
inventory InventorySummary: Detailed inventory breakdown.
product_name string: Parent product name (resolved).
margin_cents integer required: Profit margin in cents (unit_price - unit_cost).
margin_percentage number required: Profit margin as percentage of sale price.

total integer

Total number of items (null when not calculated for performance)

limit integer

Pagination limit

next_cursor string

Cursor for next page

prev_cursor string

Cursor for previous page

has_next boolean required

Whether there are more items

has_prev boolean required

Whether there are previous items

Authentication