POST
/
v1
/
products

Headers

X-BUSINESS-API-KEY
string
required

Body

multipart/form-data
name
string
required

The name of the product

description
string

The description of the product

headline
string

The headline of the product

quantity
number

The quantity of the product

quantity_alert_level
number

The quantity alert level of the product. It is required when quantity alert level is present.

currency
string

The currency of the product

price
number
required

The price of the product

is_manageable
enum<string>
default: 1

The is manageable of the product

Available options:
1,
0
is_pinned
enum<string>
default: 0

The is pinned of the product

Available options:
1,
0
variations
object[]
images
object[]
publish
enum<string>
default: 1
Available options:
1,
0

Response

201 - application/json
id
string
required
business_id
string
required
category_id
string[]
required
name
string
required
headline
string | null
description
string
required
currency
string
required
price
number
required
price_display
string
required
price_stored
integer
required
tax_id
string | null
is_manageable
integer
required
is_pinned
boolean
required
status
string
required
has_variations
boolean
required
is_shopify
boolean
required
product_url
string
required
variations_count
integer
required
variations
object[]
required
variation_key_1
string | null
variation_key_2
string | null
variation_key_3
string | null
images
object[]
is_published
boolean
required
created_at
string
required
updated_at
string
required
starts_at
string | null
ends_at
string | null

Was this page helpful?

Get All ProductsGet a Product