Get a product - Spree Commerce documentation

GET

api

admin

products

{id}

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const product = await client.products.get('prod_86Rf07xd4z', {
  expand: ['variants', 'option_types'],
})

{
  "id": "prod_UkLWZg9DAJ",
  "name": "Product 616894",
  "slug": "product-616894",
  "meta_title": null,
  "meta_description": null,
  "meta_keywords": null,
  "variant_count": 0,
  "available_on": null,
  "purchasable": true,
  "in_stock": false,
  "backorderable": true,
  "available": true,
  "description": "Neque dicta incidunt consequuntur accusamus autem tempore voluptatum. Ab sapiente doloribus qui expedita. Quam odit blanditiis ullam tempora. Fugit totam ullam soluta adipisci ipsa dolores. Ipsum omnis iusto ex facilis esse maiores. Dicta ipsam expedita ut maxime tenetur consequatur eos incidunt. Id numquam ipsum sequi inventore. Molestiae dolore explicabo animi numquam. Inventore quod perspiciatis hic dolores aliquid nesciunt aliquam. Debitis quis modi iste perferendis odio laborum quasi facere. Minima quidem dolor accusamus tenetur dolorum vel consequuntur quia. Repellendus beatae modi cumque eligendi architecto dicta.",
  "description_html": "Neque dicta incidunt consequuntur accusamus autem tempore voluptatum. Ab sapiente doloribus qui expedita. Quam odit blanditiis ullam tempora. Fugit totam ullam soluta adipisci ipsa dolores.\nIpsum omnis iusto ex facilis esse maiores. Dicta ipsam expedita ut maxime tenetur consequatur eos incidunt. Id numquam ipsum sequi inventore.\nMolestiae dolore explicabo animi numquam. Inventore quod perspiciatis hic dolores aliquid nesciunt aliquam. Debitis quis modi iste perferendis odio laborum quasi facere. Minima quidem dolor accusamus tenetur dolorum vel consequuntur quia. Repellendus beatae modi cumque eligendi architecto dicta.",
  "default_variant_id": "variant_UkLWZg9DAJ",
  "thumbnail_url": null,
  "tags": [],
  "price": {
    "id": "price_UkLWZg9DAJ",
    "amount": "19.99",
    "amount_in_cents": 1999,
    "compare_at_amount": null,
    "compare_at_amount_in_cents": null,
    "currency": "USD",
    "display_amount": "$19.99",
    "display_compare_at_amount": null,
    "price_list_id": null,
    "variant_id": "variant_UkLWZg9DAJ",
    "created_at": "2026-06-17T13:37:42.084Z",
    "updated_at": "2026-06-17T13:37:42.084Z"
  },
  "original_price": null,
  "status": "active",
  "metadata": {},
  "deleted_at": null,
  "created_at": "2026-06-17T13:37:42.074Z",
  "updated_at": "2026-06-17T13:37:42.091Z",
  "tax_category_id": "taxcat_UkLWZg9DAJ"
}

Authorizations

x-spree-api-key

string

header

required

Secret API key for admin access

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Bearer token for admin authentication

Path Parameters

string

required

Product ID (e.g., prod_xxx)

Query Parameters

expand

string

Comma-separated associations to expand (e.g., variants, media, option_types, categories). Use dot notation for nested expand (max 4 levels).

fields

string

Comma-separated list of fields to include (e.g., name,slug,price,status). id is always included.

Response

product found

string

required

name

string

required

slug

string

required

meta_title

string | null

required

meta_description

string | null

required

meta_keywords

string | null

required

variant_count

number

required

available_on

string | null

required

purchasable

boolean

required

in_stock

boolean

required

backorderable

boolean

required

available

boolean

required

description

string | null

required

description_html

string | null

required

default_variant_id

string

required

thumbnail_url

string | null

required

categories

object[]

Show child attributes

custom_fields

object[]

Show child attributes

prior_price

object

Show child attributes

product_publications

object[]

Show child attributes

channels

object[]

Show child attributes

Create a product

Delete a product

⌘I

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const product = await client.products.get('prod_86Rf07xd4z', {
  expand: ['variants', 'option_types'],
})

{
  "id": "prod_UkLWZg9DAJ",
  "name": "Product 616894",
  "slug": "product-616894",
  "meta_title": null,
  "meta_description": null,
  "meta_keywords": null,
  "variant_count": 0,
  "available_on": null,
  "purchasable": true,
  "in_stock": false,
  "backorderable": true,
  "available": true,
  "description": "Neque dicta incidunt consequuntur accusamus autem tempore voluptatum. Ab sapiente doloribus qui expedita. Quam odit blanditiis ullam tempora. Fugit totam ullam soluta adipisci ipsa dolores. Ipsum omnis iusto ex facilis esse maiores. Dicta ipsam expedita ut maxime tenetur consequatur eos incidunt. Id numquam ipsum sequi inventore. Molestiae dolore explicabo animi numquam. Inventore quod perspiciatis hic dolores aliquid nesciunt aliquam. Debitis quis modi iste perferendis odio laborum quasi facere. Minima quidem dolor accusamus tenetur dolorum vel consequuntur quia. Repellendus beatae modi cumque eligendi architecto dicta.",
  "description_html": "Neque dicta incidunt consequuntur accusamus autem tempore voluptatum. Ab sapiente doloribus qui expedita. Quam odit blanditiis ullam tempora. Fugit totam ullam soluta adipisci ipsa dolores.\nIpsum omnis iusto ex facilis esse maiores. Dicta ipsam expedita ut maxime tenetur consequatur eos incidunt. Id numquam ipsum sequi inventore.\nMolestiae dolore explicabo animi numquam. Inventore quod perspiciatis hic dolores aliquid nesciunt aliquam. Debitis quis modi iste perferendis odio laborum quasi facere. Minima quidem dolor accusamus tenetur dolorum vel consequuntur quia. Repellendus beatae modi cumque eligendi architecto dicta.",
  "default_variant_id": "variant_UkLWZg9DAJ",
  "thumbnail_url": null,
  "tags": [],
  "price": {
    "id": "price_UkLWZg9DAJ",
    "amount": "19.99",
    "amount_in_cents": 1999,
    "compare_at_amount": null,
    "compare_at_amount_in_cents": null,
    "currency": "USD",
    "display_amount": "$19.99",
    "display_compare_at_amount": null,
    "price_list_id": null,
    "variant_id": "variant_UkLWZg9DAJ",
    "created_at": "2026-06-17T13:37:42.084Z",
    "updated_at": "2026-06-17T13:37:42.084Z"
  },
  "original_price": null,
  "status": "active",
  "metadata": {},
  "deleted_at": null,
  "created_at": "2026-06-17T13:37:42.074Z",
  "updated_at": "2026-06-17T13:37:42.091Z",
  "tax_category_id": "taxcat_UkLWZg9DAJ"
}