GET
List product variants for stock
Company space For: Manager, Cashier and seller, Stock keeper, Buyer · Permission: product_variants.list Part of Create products and variants.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 1000
sort_by
enum<string> | null

Field the list is sorted by.

Available options:
id,
status,
created_at,
updated_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
search
string | null

Free text, up to 255 characters. It is split on spaces; every word must match (case-insensitive, contains) the product title, an option value, or a unit of sale SKU or barcode.

Maximum string length: 255
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: vat_rate_id, tax_configuration_mode, id, name, status, is_tracked, is_taxable, uom_category_id, max_sellable_quantity, max_sellable_unit_id, weight, weight_unit_id, volume, volume_unit_id, subject_type, subject_id, organization_id, options, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: vat_rate, taxes, units, units.uomUnit, units.prices, units.stockable.

Response

Resource.

data
VariantStockableResource · object[]
required

Items of this page.

meta
object
required

Pagination details.