Skip to main content
POST
Create a product

Authorizations

Authorization
string
header
required

HTTP Basic authentication. Use your secret key as the username and an empty string as password. The API key should be base64 encoded in the format 'username:' when sending the Authorization header.

Body

application/json
merchantId
string
required

ID of the merchant that owns the product.

Example:

"2RhQg9M7ZCg3X3nMb9W1kX8Q"

name
string
required

Product name shown on the checkout.

Maximum string length: 255
Example:

"Camiseta Preta P"

price
number
required

Price in the currency unit (e.g., 89.90).

Required range: x >= 0
Example:

89.9

currency
string
required

ISO 4217 currency code.

Example:

"BRL"

productType
enum<string>
required

Product type.

Available options:
physical,
digital
description
string

Free-form product description.

Example:

"Algodão 100%, gola careca."

Access URL (digital products) delivered to the buyer.

Example:

"https://meusite.com/area-do-aluno"

sku
string

Internal code used in search and identification.

Maximum string length: 64
Example:

"CAM-PT-P"

trackStock
boolean

Enable stock tracking (physical only).

Example:

true

stock
integer

Available quantity.

Required range: x >= 0
Example:

120

weight
number

Weight in kilograms, used for freight quoting.

Required range: x >= 0
Example:

0.25

heightCm
number

Height in centimeters.

Required range: x >= 0
Example:

2

widthCm
number

Width in centimeters.

Required range: x >= 0
Example:

30

lengthCm
number

Length in centimeters.

Required range: x >= 0
Example:

40

status
enum<string>

Defaults to active. Use PATCH /v1/products/{id}/status to archive/reactivate later.

Available options:
active,
inactive

Response

The product has been successfully created

id
string
Example:

"2RhQg9M7ZCg3X3nMb9W1kX8Q"

merchantId
string
Example:

"2RhQg9M7ZCg3X3nMb9W1kX8Q"

name
string
Example:

"Camiseta Preta P"

description
string | null
price
number
Example:

89.9

currency
string
Example:

"BRL"

productType
enum<string>
Available options:
physical,
digital
sku
string | null
trackStock
boolean
stock
integer | null
weight
number | null
heightCm
number | null
widthCm
number | null
lengthCm
number | null
status
enum<string>
Available options:
active,
inactive
imageUrl
string | null

Signed, short-lived URL for the product image. null when no image was uploaded.

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