Fornecedores
A rota /api/integration/suppliers permite que você envie fornecedores para o Smarti Supply.
Method: POST
Essa rota aceita solicitações POST de Smarti Supply.
Headers
| Header | Valor | Requerido | Descrição |
|---|---|---|---|
Content-Type | application/json | Yes | The content type of the request body. |
Authorization | Bearer [access_token] | Yes | The authorization header. |
X-Api-Key | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | Yes | The key to verify the message integrity. |
Request
O corpo da solicitação será um objeto JSON com a seguinte estrutura:
Parameters
| Nome | Tipo | Descrição | Requerido |
|---|---|---|---|
| metadata | objeto | O objeto de metadados. | No |
| metadata.page_total_count | int | O número total de páginas. | No |
| metadata.total_records | int | O número total de registros. | No |
| metadata.page_records | int | O número de registros por página. | No |
| metadata.page_number | int | O número da página atual. | No |
| metadata.batch_id | string | O ID do lote. | No |
| items | array | O array de itens. | Yes |
| items[].id | string | O ID do fornecedor. | Yes |
| items[].name | string | O nome do fornecedor. | Yes |
| items[].contacts[] | array | O array de contatos. | Yes |
| items[].contacts[].contact | string | Nome do contato. | Yes |
| items[].contacts[].email | string | O e-mail do fornecedor. | Yes |
| items[].contact[].send_email | boolean:default:true | Se recebe e-mail. | No |
Example
{ "metadata": { "page_total_count": "2", "total_records": "1791", "page_records": "1000", "page_number": "1", "batch_id": "20240301-0001" }, "items": [ { "id": "000000000000100018", "name": "Fornecedor de Exemplo", "contacts": [ { "contact": "Contato de Exemplo", "email": "contato@exemplo.com.br", "send_email": true } ] } ]
}Responses
| Código | Descrição |
|---|---|
| 200 | Supplier created |
| 400 | Invalid input |
| 500 | Internal server error |
200
{ "message": "Batch of Supplier received"}400
{ "error": { "message": "Invalid input" },}