Pular para o conteúdo

POST /v1/products

POST
/v1/products
curl --request POST \
--url https://seu-endereco-da-api/v1/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "price": 1, "description": "example", "imageKey": "example", "imageMime": "example", "categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sku": "example", "barcode": "example", "stock": 1, "active": true }'

Permissão que a Chave de acesso precisa: Gerenciar catálogo (catalog:manage).

Media typeapplication/json
object
name
required
string
<= 200 characters /\S/
price
number
description
string
<= 2000 characters
imageKey
string
>= 1 characters <= 512 characters
imageMime
string
>= 1 characters <= 100 characters
categoryId
string format: uuid
sku
string
<= 64 characters
barcode
string
stock
number
<= 1000000000
active
boolean

Example generated

{
"name": "example",
"price": 1,
"description": "example",
"imageKey": "example",
"imageMime": "example",
"categoryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"sku": "example",
"barcode": "example",
"stock": 1,
"active": true
}
Media typeapplication/json
object
id
required
string
name
required
string
price
required

Price in the smallest currency unit (centavos)

number
description
required
string
nullable
imageKey
required
string
nullable
imageMime
required
string
nullable
imageUrl
required

Signed url, valid for one hour

string
nullable
categoryId
required
string
nullable
sku
required
string
nullable
barcode
required
string
nullable
stock
required

Null means unlimited

number
nullable
active
required
boolean
optionNames
required

Names of the option groups, e.g. Size and Color; empty when the product has no variants

Array<string>
variantCount
required

Number of live variants

number
priceFromCents
required

Lowest price among active variants, in centavos

number
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time

Example generated

{
"id": "example",
"name": "example",
"price": 1,
"description": "example",
"imageKey": "example",
"imageMime": "example",
"imageUrl": "example",
"categoryId": "example",
"sku": "example",
"barcode": "example",
"stock": 1,
"active": true,
"optionNames": [
"example"
],
"variantCount": 1,
"priceFromCents": 1,
"createdAt": "2026-04-15T12:00:00Z",
"updatedAt": "2026-04-15T12:00:00Z"
}