API de Produtos

Crie, leia, atualize e exclua produtos no seu catalogo.

Endpoints

GET

/products

products:read

Obtenha uma lista paginada de produtos. Suporta filtragem por status, categoria e busca.

GET

/products/:id

products:read

Obtenha um unico produto pelo seu ID.

POST

/products

products:write

Crie um novo produto no seu catalogo.

PUT

/products/:id

products:write

Atualize um produto existente. Atualizacoes parciais sao suportadas.

DELETE

/products/:id

products:write

Exclusao suave de um produto. Pode ser restaurado em 30 dias.

Referencia de Campos

Campo	Tipo	Obrigatorio	Descricao
id	string	Nao	Identificador unico do produto (somente leitura)
sku	string	Sim	Unidade de manutencao de estoque
name	string	Sim	Nome do produto
description	string	Nao	Descricao do produto (HTML permitido)
barcode	string	Nao	Código de barras principal do produto (UPC/EAN)
brand	string	Nao	Nome da marca do produto
categoryId	string	Nao	Identificador da categoria
unitPrice	integer	Sim	Preco em centavos (ex. 1999 = $19.99)
normalPrice	integer	Nao	Preço normal / de lista em centavos (para mostrar descontos)
purchasePrice	integer	Nao	Preço de compra / custo em centavos
weight	string	Nao	Peso em gramas
isActive	boolean	Nao	Se o produto está ativo / publicado (padrão: true)
stockTotal	integer	Nao	Estoque total disponível em todos os armazéns (somente leitura)
images	string[]	Nao	URLs das imagens do produto
createdAt	datetime	Nao	Timestamp ISO 8601 (somente leitura)
updatedAt	datetime	Nao	Timestamp ISO 8601 (somente leitura)

Parametros de Consulta (Lista)

Campo	Tipo	Obrigatorio	Descricao
page	integer	Nao	Numero da pagina (padrao: 1)
limit	integer	Nao	Itens por pagina (padrao: 20, max: 100)

Exemplo

Listar produtos com paginacao

bash

curl "https://api.mercozy.com/api/v1/external/products?page=1&limit=10" \
  -H "X-API-Key: mk_live_your_key_here"

Criar um produto

bash

curl -X POST "https://api.mercozy.com/api/v1/external/products" \
  -H "X-API-Key: mk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "sku": "WDG-001",
    "name": "Premium Widget",
    "unitPrice": 2999,
    "normalPrice": 3999,
    "brand": "Acme Corp",
    "isActive": true
  }'