Skip to main content
GET
Spree Seller SDK

Authorizations

Authorization
string
header
required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id
string
required

Path Parameters

id
string
required

Product ID

Response

product returned

id
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
preorder_ships_at
string | null
required
purchasable
boolean
required
preorder
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
buy_box_variant_id
string | null
required
thumbnail_url
string | null
required
tags
string[]
required
price
object
required
original_price
object | null
required
seller_id
string | null
required
status
required

The values listed are the built-in ones; extensions may add more.

Available options:
draft,
active,
archived,
proposed,
rejected
metadata
object
required
created_at
string
required
updated_at
string
required
product_type_id
string | null
required
delivery_profile_id
string | null
required
seller
object
primary_media
object
media
object[]
variants
object[]
default_variant
object
option_types
object[]
option_values
object[]
categories
object[]
custom_fields
object[]
prior_price
object | null
submission
object | null