POST
Create a product per Shopify product link.

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.

Body

application/json
urls
string<uri>[]
required
Required array length: 1 - 20 elements
status
enum<integer>
default:0

0 draft (default), 1 active, 2 archived. Imports default to draft so nothing reaches the storefront before the pricing is reviewed.

Available options:
0,
1,
2
skip_existing
boolean
default:true

true reports an already-imported source product as skipped with its existing product_id instead of creating a duplicate. Dedupe is on the source product identity, not the title.

Response

Every link imported.

success
boolean
required
message
string
data
object
meta
object