POST
Publish a product, now or at a scheduled time

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

productId
string
required

Body

application/json

An empty body publishes immediately. Every parameter is in the body and never the query string: the idempotency key hashes method, path and body, so ?force=true and no query at all would hash identically and the flag would be silently discarded on a replay.

publish_at
string<date-time> | null

Schedules the product to go live later. Absent publishes now.

force
boolean

Acknowledges the refusal raised when a product's variants are partly free and partly priced. Never a default.

Response

Success

data
object