Skip to main content
POST
Spree Admin SDK

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

Body

application/json
name
string
required
Example:

"Premium T-Shirt"

description
string
slug
string
status
enum<string>
Available options:
draft,
active,
archived
tax_category_id
string

Tax category ID

category_ids
string[]

Array of category IDs

tags
string[]
Example:
prices
object[]

Shorthand for a simple (no-options) product: per-currency prices that forward to the product's sole variant. For products with options, set prices per variant under variants: instead.

variants
object[]

Array of variant payloads. Variants can declare multiple option pairs via options: and per-currency prices via prices:. Stock counts go in stock_items: (per stock location).

Response

product created

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
thumbnail_url
string | null
required
tags
string[]
required
price
object | null
required
original_price
object | null
required
status
string
required
metadata
object
required
deleted_at
string | null
required
created_at
string
required
updated_at
string
required
tax_category_id
string | null
required
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
translations
object
product_publications
object[]
channels
object[]