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étodo | Path | Descrição |
|---|---|---|
| GET | /products | Listar produtos |
| POST | /products | Criar produto |
| GET | /products/{id} | Detalhes (com variações) |
| PUT | /products/{id} | Atualizar |
| DELETE | /products/{id} | Excluir |
GET /products — filtros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| search | string | nome, SKU ou descrição |
| type | string | product ou service |
| category_id | integer | categoria |
| is_active | boolean | ativo/inativo |
| has_variations | boolean | com variações |
| sort_by | string | name, price, sku, created_at, stock_quantity, sort_order |
| sort_dir | string | asc | desc (padrão asc) |
| per_page | integer | padrão 50, máx 100 |
POST /products — criar
Obrigatórios: name e price. Padrões: type=product, is_active=true.
| Campo | Tipo | Regras |
|---|---|---|
| name | string | obrigatório |
| price | number | obrigatório, ≥ 0 |
| sku | string | código |
| description | string | máx 5000 |
| short_description | string | máx 500 |
| type | string | product | service |
| category / category_id | string / integer | categoria |
| cost | number | custo ≥ 0 |
| currency | string | moeda |
| unit | string | un, kg, hr... |
| tax_rate | number | 0–100 (%) |
| track_stock | boolean | controlar estoque |
| stock_quantity | number | estoque inicial ≥ 0 |
| min_stock | number | estoque mínimo ≥ 0 |
| is_active | boolean | ativo |
| custom_fields | object | campos 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