Pular para o conteúdo

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

HeaderValorRequeridoDescrição
Content-Typeapplication/jsonYesThe content type of the request body.
AuthorizationBearer [access_token]YesThe authorization header.
X-Api-Keyxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxYesThe key to verify the message integrity.

Request

O corpo da solicitação será um objeto JSON com a seguinte estrutura:

Parameters

NomeTipoDescriçãoRequerido
metadataobjetoO objeto de metadados.No
metadata.page_total_countintO número total de páginas.No
metadata.total_recordsintO número total de registros.No
metadata.page_recordsintO número de registros por página.No
metadata.page_numberintO número da página atual.No
metadata.batch_idstringO ID do lote.No
itemsarrayO array de itens.Yes
items[].idstringO ID do fornecedor.Yes
items[].namestringO nome do fornecedor.Yes
items[].contacts[]arrayO array de contatos.Yes
items[].contacts[].contactstringNome do contato.Yes
items[].contacts[].emailstringO e-mail do fornecedor.Yes
items[].contact[].send_emailboolean: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ódigoDescrição
200Supplier created
400Invalid input
500Internal server error

200

{
"message": "Batch of Supplier received"
}

400

{
"error": {
"message": "Invalid input"
},
}

500