POST
Bind to the sourcing catalog — the dropship "add to store" write.

Authorizations

X-Agent-Key
string
header
required

Service-account key, format sq_agt_*. Carries least-privilege scopes.

Headers

Idempotency-Key
string

Optional on the products domain API — absent, the request simply executes. When present, a replay with the same body returns the cached response and a different body returns 409. Send it on every write anyway.

Maximum string length: 200
X-Store-ID
string

Target store; required when the key is bound to multiple stores.

Path Parameters

product_id
string
required

Body

application/json

spu_id or a non-empty catalog_variants is required.

spu_id
string
Required string length: 1 - 64
bundle_type
string
Maximum string length: 32
is_additive
boolean
default:false

Keep existing links instead of replacing them. Also accepted as isAdditive.

catalog_variants
object[]
Maximum array length: 200
variant_relation
object[]
Maximum array length: 200

Response

OK

success
boolean
required
message
string
data
object
meta
object