Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Merchant API V2 token. Pass as Authorization: Bearer <token>.

Body

application/json
name
string
required
Minimum string length: 1
price
integer
required
Required range: x >= 0
description
string
sku
string
reference_id
string
status
enum<string>
Available options:
VISIBLE,
HIDDEN
type
enum<string>
Available options:
PHYSICAL,
DIGITAL,
SUBSCRIPTION,
BOOKING,
OTHERS
original_price
integer
Required range: x >= 0
cost_enabled
boolean
cost
integer
Required range: x >= 0
unit_enabled
boolean
unit
enum<string>
Available options:
QTY,
KG,
G,
ML,
L,
PCS,
PAX,
PACK,
PERSON,
ROOM,
LBS,
HOUR,
BOX
unit_value
number
weight
integer
tax_override
boolean
tax_rate
integer
tags
string[]
Pattern: ^https?:\/\//i
daily_limit
integer
cart_limit
integer
cart_minimum
integer
inventory_enabled
boolean
inventory_quantity
integer
Required range: x >= 0
variants
object[]
options
object[]

Response

Product

id
string
required
object
enum<string>
required
Available options:
product
reference_id
string | null
required
name
string
required
description
string
required
sku
string
required
status
enum<string>
required
Available options:
VISIBLE,
HIDDEN
type
enum<string>
required
Available options:
PHYSICAL,
DIGITAL,
SUBSCRIPTION,
BOOKING,
OTHERS
price
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

original_price
integer
required

Integer amount in the smallest unit of the store currency (e.g. cents).

cost_enabled
boolean
required
cost
integer | null
required

Integer amount in the smallest unit of the store currency (e.g. cents).

unit_enabled
boolean
required
unit
enum<string>
required
Available options:
QTY,
KG,
G,
ML,
L,
PCS,
PAX,
PACK,
PERSON,
ROOM,
LBS,
HOUR,
BOX
unit_value
number
required
weight
integer
required
tax_override
boolean
required
tax_rate
integer
required
tags
string[]
required
daily_limit
integer
required
cart_limit
integer
required
cart_minimum
integer
required
inventory_enabled
boolean
required
soldout
boolean
required
inventory
object
required
variants
object[]
required
options
object[]
required
images
string[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required