Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json
merchantId
string
required
Pattern: ^org_[a-zA-Z0-9]+$
name
string
required

Canonical sellable name for the Item

catalogId
string

The product this item belongs to.

Pattern: ^prod_[a-zA-Z0-9]+$
metadata
object

Optional key-value metadata

Response

Item created

id
string
required

Unique identifier for an item

Pattern: ^itm_[a-zA-Z0-9]+$
object
enum<string>
default:item
required
Available options:
item
merchantId
string
required
Pattern: ^org_[a-zA-Z0-9]+$
name
string
required
metadata
object
required
externalReferences
object[]
required
catalogId
string | null
required

The product this item belongs to.

Pattern: ^prod_[a-zA-Z0-9]+$
archivedAt
string<date-time> | null
required
read-only

When this item was retired from the catalog. Null while active.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required