Saltar al contenido principal

API — Suppliers

Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.


GET /api/suppliers

List Suppliers

Parametros:

NomeTipoObrigatorioDescricao
pageintegerNao
page_sizeintegerNao
searchstringNao

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:

CampoTipoObrigatorioDescricao
namestringSimName
emailstringSimEmail
phoneobjectNaoPhone
addressobjectNaoAddress
contact_personobjectNaoContact Person
is_activebooleanNaoIs Active
notesobjectNaoNotes

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:

NomeTipoObrigatorioDescricao
supplier_idintegerSim

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:

NomeTipoObrigatorioDescricao
supplier_idintegerSim

Corpo do pedido:

CampoTipoObrigatorioDescricao
nameobjectNaoName
emailobjectNaoEmail
phoneobjectNaoPhone
addressobjectNaoAddress
contact_personobjectNaoContact Person
is_activeobjectNaoIs Active
notesobjectNaoNotes

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:

NomeTipoObrigatorioDescricao
supplier_idintegerSim

Resposta (204): Successful Response

Erros possiveis: 422 Validation Error


Documentacao gerada automaticamente.