Products
Retrieve Product Variant
Retrieve a single variant of a product.
GET
/
admin
/
products
/
{id}
/
variants
/
{variant_id}
curl 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/variants/variant_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>'
const { variant } = await client.admin.products.$id.variants.$variant_id.query({
$id: "prod_01HXYZABCDEF",
$variant_id: "variant_01HXYZABCDEF",
})
{
"variant": {
"id": "variant_01HXYZABCDEF",
"title": "M",
"sku": "LS-M",
"product_id": "prod_01HXYZABCDEF",
"manage_inventory": false,
"allow_backorder": false,
"variant_rank": 0
}
}
Returns one variant scoped to the given product.
Path parameters
string
required
The product’s ID.
string
required
The variant’s ID.
Query parameters
string
Comma-separated list of fields to include, prefix with
+/- to add or remove from defaults.Response
object
Show properties
Show properties
string
The variant’s ID.
string
Variant title.
string
Variant SKU.
string
Variant EAN.
string
Variant UPC.
string
Variant barcode.
number
Sort rank of the variant.
number
Variant weight.
number
Variant length.
number
Variant height.
number
Variant width.
string
Country of origin.
string
Variant material.
string
ID of the parent product.
boolean
Whether inventory is tracked for the variant.
boolean
Whether the variant can be ordered when out of stock.
object[]
The variant’s option values.
object
Custom key-value data.
string
Creation timestamp.
string
Last update timestamp.
curl 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/variants/variant_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>'
const { variant } = await client.admin.products.$id.variants.$variant_id.query({
$id: "prod_01HXYZABCDEF",
$variant_id: "variant_01HXYZABCDEF",
})
{
"variant": {
"id": "variant_01HXYZABCDEF",
"title": "M",
"sku": "LS-M",
"product_id": "prod_01HXYZABCDEF",
"manage_inventory": false,
"allow_backorder": false,
"variant_rank": 0
}
}
⌘I
curl 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/variants/variant_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>'
const { variant } = await client.admin.products.$id.variants.$variant_id.query({
$id: "prod_01HXYZABCDEF",
$variant_id: "variant_01HXYZABCDEF",
})
{
"variant": {
"id": "variant_01HXYZABCDEF",
"title": "M",
"sku": "LS-M",
"product_id": "prod_01HXYZABCDEF",
"manage_inventory": false,
"allow_backorder": false,
"variant_rank": 0
}
}