Skip to main content
POST
Create a product variant

Authorizations

Authorization
string
header
required

Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.

Headers

Idempotency-Key
string
required
Required string length: 1 - 200
X-BatchRelay-Client-Surface
string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Client-Version
string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Invocation-Mode
string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

studio_id
string
required

Stable public studio ID beginning with stu_. The API never selects a studio implicitly; a local CLI profile name is not a studio ID.

Required string length: 5 - 256
Pattern: ^stu_[A-Za-z0-9_-]+$
product_id
string
required
Required string length: 1 - 256

Body

application/json
name
string
required
Required string length: 1 - 240
availability
object
description
string
media_asset_ids
string[]
Maximum array length: 12
option_selections
object[]
price
object
sort_order
integer
Required range: x >= 0
variant_label
string
Maximum string length: 240

Response

Draft variant

availability
object
required
canonical_product_id
string | null
required
canonical_product_revision
integer | null
required
edit_version
integer
required
id
string
required
media_asset_ids
string[]
required
name
string
required
option_selections
object[]
required
price
object
required
status
enum<string>
required
Available options:
draft,
published,
archived
description
string
sort_order
integer
variant_parent_product_id
string