API — Produtos e Serviços (/products)

Catálogo de produtos e serviços via API: criar, listar com filtros, controlar estoque, preço, custo, impostos, categoria, imagens e variações.

API — Produtos e Serviços

Catálogo de produtos e serviços. Base: /api/v1/products.

Endpoints

MétodoPathDescrição
GET/productsListar produtos
POST/productsCriar produto
GET/products/{id}Detalhes (com variações)
PUT/products/{id}Atualizar
DELETE/products/{id}Excluir

GET /products — filtros

ParâmetroTipoDescrição
searchstringnome, SKU ou descrição
typestringproduct ou service
category_idintegercategoria
is_activebooleanativo/inativo
has_variationsbooleancom variações
sort_bystringname, price, sku, created_at, stock_quantity, sort_order
sort_dirstringasc | desc (padrão asc)
per_pageintegerpadrão 50, máx 100

POST /products — criar

Obrigatórios: name e price. Padrões: type=product, is_active=true.

CampoTipoRegras
namestringobrigatório
pricenumberobrigatório, ≥ 0
skustringcódigo
descriptionstringmáx 5000
short_descriptionstringmáx 500
typestringproduct | service
category / category_idstring / integercategoria
costnumbercusto ≥ 0
currencystringmoeda
unitstringun, kg, hr...
tax_ratenumber0–100 (%)
track_stockbooleancontrolar estoque
stock_quantitynumberestoque inicial ≥ 0
min_stocknumberestoque mínimo ≥ 0
is_activebooleanativo
custom_fieldsobjectcampos personalizados
POST /api/v1/products
{
  "name": "Consultoria por Hora",
  "price": 250.00,
  "type": "service",
  "unit": "hr",
  "tax_rate": 5
}

PUT /products/{id}

Mesmos campos (todos opcionais; name não vazio se enviado).

Formato (detalhe)

Campos básicos (id, name, sku, type, price, cost, currency, unit, tax_rate, is_active, stock_quantity, track_stock, has_variations, category, image_url, images[]) mais, no detalhe: description, short_description, min_stock, custom_fields, margin (margem calculada) e variations[] (id, name, sku, price, cost, stock_quantity, is_active, is_default).

api produtos products estoque catálogo integração

Este artigo foi útil?

Artigos Relacionados