Recaudo Docs

Loja

Produtos

Gerencie seu catálogo de produtos e categorias. Os produtos podem ter controle de estoque, preços de comparação, impostos e metadados personalizados.

Listar categorias

GET /v1/product-categories

Parâmetros opcionais: is_active, parent_id (UUID ou "root"), limit, page

Criar categoria

POST /v1/product-categories
Corpo
{
  "name": "Electrónicos",
  "description": "Productos electrónicos y gadgets",
  "parent_id": null,
  "sort_order": 1,
  "is_active": true
}
Campo Tipo Obrigatório Descrição
namestringSimNome da categoria
parent_iduuidNãoCategoria pai (para subcategorias)
descriptionstringNãoDescrição
sort_orderintegerNãoOrdem de exibição
is_activebooleanNãoSe está ativa (padrão: true)

Obter / Atualizar / Excluir categoria

GET /v1/product-categories/{'{id}'}
PATCH /v1/product-categories/{'{id}'}
DELETE /v1/product-categories/{'{id}'}

Ao excluir uma categoria, suas subcategorias passam para a categoria pai e os produtos são desvinculados.


Listar produtos

GET /v1/products

Parâmetros opcionais: status (active, draft, archived), category (UUID), search, featured, in_stock, limit, page

Criar produto

POST /v1/products
Corpo
{
  "name": "Laptop Pro 15",
  "price": 25999.00,
  "currency": "MXN",
  "sku": "LAP-PRO-15",
  "description": "Laptop profesional de 15 pulgadas",
  "product_category_id": "uuid-de-la-categoria",
  "track_stock": true,
  "stock_quantity": 50,
  "tax_rate": 16,
  "is_featured": true,
  "metadata": {
    "brand": "TechCorp",
    "warranty_months": 24
  }
}
Campo Tipo Obrigatório Descrição
namestringSimNome do produto
pricenumberSimPreço em decimais (100.00 = $100)
currencystringNãoMoeda ISO 4217 (padrão: a da conta)
statusstringNãoactive, draft, archived (padrão: active)
product_category_iduuidNãoUUID da categoria
skustringNãoCódigo SKU
descriptionstringNãoDescrição longa
compare_at_pricenumberNãoPreço de comparação (antes)
cost_pricenumberNãoCusto do produto
track_stockbooleanNãoAtivar controle de estoque
stock_quantityintegerNãoQuantidade em estoque
tax_ratenumberNãoAlíquota de imposto (%)
is_featuredbooleanNãoProduto em destaque
image_urlurlNãoURL da imagem
metadataobjectNãoMetadados personalizados

Obter / Atualizar / Excluir produto

GET /v1/products/{'{id}'}
PATCH /v1/products/{'{id}'}
DELETE /v1/products/{'{id}'}

Não é possível excluir um produto com pedidos pendentes.

Esta página ajudou? Obrigado por avisar.
Esc