Pedidos
A rota /api/integration/orders permite enviar pedidos para a Smarti Supply.
Method: POST
Essa rota aceita solicitações POST para Smarti Supply.
Headers
| Header | Value | Required | Description |
|---|---|---|---|
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
| Name | Type | Description | Required |
|---|---|---|---|
| metadata | objeto | O objeto de metadados. | No |
| metadata.overwrite_all | boolean:default:true | Se deve sobrescrever todos os itens. | 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[].material_id | string | O ID do material. | Yes |
| items[].organization_code | string | O código da organização (Filial/Depósito/Armazém). | Yes |
| items[].order_id | string | O código do pedido. | Yes |
| items[].order_item_id | string | O ID do item do pedido. | Yes |
| items[].parcel_id | int | O ID da divisão de remessa. | No |
| items[].delivery_date | data:Y-m-d | A data de entrega. | Yes |
| items[].reprogramming_date | data:Y-m-d | A data de reprogramação. | No |
| items[].required_date | data:Y-m-d | A data de requerimento. | Yes |
| items[].sign | string | O sinal (+ ou -). | Yes |
| items[].quantity | int | A quantidade. | Yes |
| items[].total_order_item | int | A quantidade total do item do pedido. | Yes |
| items[].supplier_id | string | O ID do fornecedor. | Yes |
| items[].status | string | O código do status. | No |
| items[].requisition_id | string | O ID da requisição. | No |
| items[].requisition_item_id | string | O ID do item da requisição. | No |
| --- | ---- | ----------- | -------- |
| items[].material | objeto | O objeto do material. | Yes se o Material for novo / No |
| items[].material.material_id | string | O ID do material. | Yes |
| items[].material.organization_code | string | O código da organização. | Yes |
| items[].material.merchandise_group | string | O grupo de mercadoria. | Yes |
| items[].material.restricted_stock | boolean:default:false | A restrição de estoque. | No |
| items[].material.blocked_stock | boolean:default:false | A bloqueio de estoque. | No |
| items[].material.mesurement_unit | string | A unidade de medida. | Yes |
| items[].material.organization_stock_quantity | int | A quantidade de estoque. | Yes |
| items[].material.min_size | int | O tamanho mínimo. | Yes |
| items[].material.max_size | int | O tamanho máximo. | Yes |
| items[].material.fixed_size | int | O tamanho fixo. | Yes |
| items[].material.lead_time | int | O tempo de lead. | Yes |
| items[].material.rounding | int | A arredondamento. | Yes |
| --- | ---- | ----------- | -------- |
| items[].supplier | objeto | O objeto do fornecedor. | Yes se o Fornecedor for novo / No |
| items[].supplier.supplier_id | string | O ID do fornecedor. | Yes |
| items[].supplier.name | string | O nome do fornecedor. | Yes |
| items[].supplier.contact | string | Nome do contato. | No |
| items[].supplier.email | string | O e-mail do fornecedor. | Yes |
| items[].supplier.send_email | boolean:default:true | Se o fornecedor envia e-mail. | No |
| --- | ---- | ----------- | -------- |
| items[].extras* | array | Dados extras. | No |
Nota*: Os dados extras com as seguintes regras:
- As chaves em CAPS serão mantidas do jeito que estão
- Se palavras compostas por snake_case, serão convertidas com a primeira palavra em maiúscula e restantes em minúscula, com espaços em branco.
- Se no valor existir um ’>’ o que vier antes será usado como referência para um icone e o que vier depois como cor.
- Se no valor apos o ’>’ existir um ’&’ depois sera usado como está.
As chaves dos campos extra devem ser informadas a Smarti para correta configuração.
Example
{ "metadata": { "overwrite_all": false, "page_total_count": "2", "total_records": "1791", "page_records": "1000", "page_number": "1", "batch_id": "20240301-0001" }, "items":[ { "material_id": "000000000000100018", "organization_code": "EI03", "order_id": "4500633125", "order_item_id": "000001", "parcel_id": 1, "delivery_date": "2022-11-08", "reprogramming_date": "2023-05-17", "required_date": "2022-12-07", "sign": "+", "quantity": 4600000000, "total_order_item": 4600000000, "supplier_id": "0000000439", "status": "S", "requisition_id": "", "requisition_item_id": "", "material": { "material_id": "000000000000100018", "organization_code": "EI03", "merchandise_group": "001.0.001", "restricted_stock": false, "blocked_stock": false, "mesurement_unit": "KG", "organization_stock": 2792936000, "min_size": 25000000, "max_size": 0, "fixed_size": 0, "lead_time": 31, "rounding": 25000000 }, "supplier": { "supplier_id": "0000000439", "name": "FABRICA DE CONFEÇOES LTDA", "contact": "Joana", "email": "k5TqG@example.com", "send_email": false }, "extras": [{ "SAP_status": "ph-arrows-left-right>Green&Em andamento", "comprador_atribuido": "Juliana", }] } ]
}Responses
| Code | Description |
|---|---|
| 200 | Order created |
| 400 | Invalid input |
| 500 | Internal server error |
200
{ "message": "Batch of orders received"}400
{ "error": { "message": "Invalid input" }}