Products
Retrieve Product
Retrieve a master catalog product by ID.
GET
/
admin
/
products
/
{id}
curl 'http://localhost:9000/admin/products/prod_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>'
const { product } = await client.admin.products.$id.query({
$id: "prod_01HXYZABCDEF",
})
{
"product": {
"id": "prod_01HXYZABCDEF",
"title": "Linen Shirt",
"handle": "linen-shirt",
"status": "published",
"variants": [
{ "id": "variant_01HXYZABCDEF", "title": "M", "sku": "LS-M", "variant_rank": 0 }
],
"product_attribute_values": [
{
"id": "pattrval_01HXYZABCDEF",
"name": "Linen",
"attribute": { "id": "pattr_01HXYZABCDEF", "name": "Material", "type": "single_select" }
}
],
"scoped_attributes": []
}
}
Returns a single product with its variants, attribute values, and product-scoped attributes.
Path parameters
string
required
The product’s ID.
Query parameters
string
Comma-separated list of fields to include, prefix with
+/- to add or remove from defaults.string
Scope offer data (when requested via
fields) to a single seller.Response
object
Show properties
Show properties
string
The product’s ID.
string
Product title.
string
Product subtitle.
string
One of
draft, proposed, published, rejected.string
Product description.
string
Unique URL-safe handle.
boolean
Whether the product is a gift card.
boolean
Whether discounts can apply to the product.
string
URL of the product thumbnail.
object
The collection with
id, title, and handle.object[]
Categories with
id, name, and handle.object[]
Variants with
id, title, sku, manage_inventory, allow_backorder, and variant_rank.object[]
object[]
object[]
Computed attribute groups, each with the selected
values and the attribute’s full all_values.object
Custom key-value data.
string
Creation timestamp.
string
Last update timestamp.
curl 'http://localhost:9000/admin/products/prod_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>'
const { product } = await client.admin.products.$id.query({
$id: "prod_01HXYZABCDEF",
})
{
"product": {
"id": "prod_01HXYZABCDEF",
"title": "Linen Shirt",
"handle": "linen-shirt",
"status": "published",
"variants": [
{ "id": "variant_01HXYZABCDEF", "title": "M", "sku": "LS-M", "variant_rank": 0 }
],
"product_attribute_values": [
{
"id": "pattrval_01HXYZABCDEF",
"name": "Linen",
"attribute": { "id": "pattr_01HXYZABCDEF", "name": "Material", "type": "single_select" }
}
],
"scoped_attributes": []
}
}
⌘I
curl 'http://localhost:9000/admin/products/prod_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>'
const { product } = await client.admin.products.$id.query({
$id: "prod_01HXYZABCDEF",
})
{
"product": {
"id": "prod_01HXYZABCDEF",
"title": "Linen Shirt",
"handle": "linen-shirt",
"status": "published",
"variants": [
{ "id": "variant_01HXYZABCDEF", "title": "M", "sku": "LS-M", "variant_rank": 0 }
],
"product_attribute_values": [
{
"id": "pattrval_01HXYZABCDEF",
"name": "Linen",
"attribute": { "id": "pattr_01HXYZABCDEF", "name": "Material", "type": "single_select" }
}
],
"scoped_attributes": []
}
}