API — Suppliers
Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.
GET /api/suppliers
List Suppliers
Parametros:
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| page | integer | Nao | — |
| page_size | integer | Nao | — |
| search | string | Nao | — |
Exemplo resposta (200):
{
"items": [
"..."
],
"total": 0,
"page": 0,
"page_size": 0,
"pages": 0
}
Erros possiveis: 422 Validation Error
POST /api/suppliers
Create Supplier
Corpo do pedido:
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| name | string | Sim | Name |
| string | Sim | ||
| phone | object | Nao | Phone |
| address | object | Nao | Address |
| contact_person | object | Nao | Contact Person |
| is_active | boolean | Nao | Is Active |
| notes | object | Nao | Notes |
Exemplo pedido:
{
"name": "string",
"email": "string",
"phone": null,
"address": null,
"contact_person": null,
"is_active": true,
"notes": null
}
Exemplo resposta (201):
{
"id": 0,
"tenant_id": 0,
"name": "string",
"email": "string",
"phone": null,
"address": null,
"contact_person": null,
"is_active": true,
"notes": null,
"created_at": null,
"updated_at": null,
"product_count": 0
}
Erros possiveis: 422 Validation Error
GET /api/suppliers/{supplier_id}
Get Supplier
Parametros:
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| supplier_id | integer | Sim | — |
Exemplo resposta (200):
{
"id": 0,
"tenant_id": 0,
"name": "string",
"email": "string",
"phone": null,
"address": null,
"contact_person": null,
"is_active": true,
"notes": null,
"created_at": null,
"updated_at": null,
"product_count": 0
}
Erros possiveis: 422 Validation Error
PUT /api/suppliers/{supplier_id}
Update Supplier
Parametros:
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| supplier_id | integer | Sim | — |
Corpo do pedido:
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| name | object | Nao | Name |
| object | Nao | ||
| phone | object | Nao | Phone |
| address | object | Nao | Address |
| contact_person | object | Nao | Contact Person |
| is_active | object | Nao | Is Active |
| notes | object | Nao | Notes |
Exemplo pedido:
{
"name": null,
"email": null,
"phone": null,
"address": null,
"contact_person": null,
"is_active": null,
"notes": null
}
Exemplo resposta (200):
{
"id": 0,
"tenant_id": 0,
"name": "string",
"email": "string",
"phone": null,
"address": null,
"contact_person": null,
"is_active": true,
"notes": null,
"created_at": null,
"updated_at": null,
"product_count": 0
}
Erros possiveis: 422 Validation Error
DELETE /api/suppliers/{supplier_id}
Delete Supplier
Parametros:
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| supplier_id | integer | Sim | — |
Resposta (204): Successful Response
Erros possiveis: 422 Validation Error
Documentacao gerada automaticamente.