Retrieve Product

GET

vendor

products

{id}

curl 'http://localhost:9000/vendor/products/prod_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { product } = await client.vendor.products.$id.query({
  $id: "prod_01HXYZ",
})

{
  "product": {
    "id": "prod_01HXYZ",
    "title": "Acme T-Shirt",
    "status": "published",
    "handle": "acme-t-shirt",
    "variants": [
      { "id": "variant_01HXYZ", "title": "M", "sku": "ACME-SHIRT-M" }
    ]
  }
}

Returns a single product with its images, variants, and attribute assignments.

Path parameters

string

required

The product’s ID.

Query parameters

string

Comma-separated fields to include in the response. Prefix with +/- to add to or remove from the defaults. Include variants.offers to attach the seller’s offers to each variant.

Response

object

Show properties

string

The product’s ID.

string

The product’s title.

string

The product’s subtitle.

string

The product’s description.

string

One of draft, proposed, published, rejected.

string

The product’s URL handle.

string

URL of the product’s thumbnail image.

object[]

Images with id, url, and rank.

object

The associated collection with id, title, and handle.

object[]

Associated categories with id, name, and handle.

object[]

Variants with id, title, sku, manage_inventory, allow_backorder, and variant_rank.

object[]

Product attributes grouped per attribute with their selected values.

object

Custom key-value pairs.

curl 'http://localhost:9000/vendor/products/prod_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { product } = await client.vendor.products.$id.query({
  $id: "prod_01HXYZ",
})

{
  "product": {
    "id": "prod_01HXYZ",
    "title": "Acme T-Shirt",
    "status": "published",
    "handle": "acme-t-shirt",
    "variants": [
      { "id": "variant_01HXYZ", "title": "M", "sku": "ACME-SHIRT-M" }
    ]
  }
}

curl 'http://localhost:9000/vendor/products/prod_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { product } = await client.vendor.products.$id.query({
  $id: "prod_01HXYZ",
})

{
  "product": {
    "id": "prod_01HXYZ",
    "title": "Acme T-Shirt",
    "status": "published",
    "handle": "acme-t-shirt",
    "variants": [
      { "id": "variant_01HXYZ", "title": "M", "sku": "ACME-SHIRT-M" }
    ]
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Path parameters

Query parameters

Response

​Path parameters

​Query parameters

​Response

Path parameters

Query parameters

Response