Skip to main content
POST
Create product

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
productId
string
required

Unique identifier for the product

Required string length: 1 - 100
Example:

"prod-12345"

productName
string
required

Name of the product

Required string length: 1 - 200
Example:

"Premium Headphones"

productUrl
string<uri>
required

URL to the product page

Example:

"https://example.com/products/premium-headphones"

status
enum<string>
required

Product status

Available options:
active,
archived
Example:

"active"

price
number

Product price (must be positive)

Required range: x > 0
Example:

99.99

currency
string

ISO 4217 currency code (3 characters)

Required string length: 3
Example:

"USD"

thumbnailUrl
string<uri>

URL to the product thumbnail image

Example:

"https://example.com/images/headphones-thumb.jpg"

thumbnailMode
enum<string>

How the thumbnail should be displayed

Available options:
fit,
fill
Example:

"fit"

Response

Successful response with product data

status
string
Example:

"success"

data
object