Skip to main content
POST
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

Body

application/json
name
string
required
Example:

"Hand-thrown mug"

description
string
slug
string
Example:

"hand-thrown-mug"

meta_title
string
meta_description
string
meta_keywords
string
metadata
object
product_type_id
string | null

The marketplace's product type this product is listed against, from the product types endpoint. Null detaches it. Saving with a type seeds its option types onto the product.

delivery_profile_id
string

Which of the marketplace's delivery profiles the product ships under. A new product sent without one lands on the profile marked default.

prices
object[]

Shorthand for a simple (no-options) product: per-currency prices that forward to the product's sole variant.

media
object[]

The gallery, as a whole: a file absent from the list is removed. signed_id attaches a fresh upload; id updates one already there.

variants
object[]

The variants, as a whole: one absent from the list is removed. Pass id to update an existing variant.

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
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