Romaneios

Visão Geral

O módulo Romaneios permite a geração de relatórios de romaneio de carga, documentos utilizados para controle e conferência de mercadorias em transporte. O romaneio lista os volumes, pesos e notas fiscais associadas a uma entrega.

Endpoints

POST /api/romaneios/gerar-relatorio

Descrição: Gera um relatório de romaneio de carga com base nos parâmetros informados, retornando um arquivo para download. Autenticação: Obrigatória

Corpo da Requisição (Request Body)

{
  "notasFiscaisIds": [
    "uuid-nfe-1",
    "uuid-nfe-2",
    "uuid-nfe-3"
  ],
  "transportadoraId": "uuid",
  "dataExpedicao": "2024-01-15",
  "observacoes": "Entrega urgente - cliente prioritário",
  "formato": "pdf"
}

Resposta de Sucesso

Retorna o arquivo do romaneio em formato PDF ou outro formato solicitado para download, com Content-Type adequado.

Códigos de Erro Comuns

CódigoDescrição
400Parâmetros inválidos ou lista de notas vazia
401Não autorizado
404Notas fiscais não encontradas
500Erro ao gerar o relatório

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/romaneios/gerar-relatorio" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"notasFiscaisIds":["uuid-nfe-1","uuid-nfe-2","uuid-nfe-3"],"transportadoraId":"uuid","dataExpedicao":"2024-01-15","observacoes":"Entrega urgente - cliente prioritário","formato":"pdf"}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/romaneios/gerar-relatorio', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "notasFiscaisIds": [
    "uuid-nfe-1",
    "uuid-nfe-2",
    "uuid-nfe-3"
  ],
  "transportadoraId": "uuid",
  "dataExpedicao": "2024-01-15",
  "observacoes": "Entrega urgente - cliente prioritário",
  "formato": "pdf"
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/romaneios/gerar-relatorio',
    headers={'Authorization': 'Bearer {token}'},
    json={'notasFiscaisIds': ['uuid-nfe-1', 'uuid-nfe-2', 'uuid-nfe-3'], 'transportadoraId': 'uuid', 'dataExpedicao': '2024-01-15', 'observacoes': 'Entrega urgente - cliente prioritário', 'formato': 'pdf'}
).json()

Go

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"notasFiscaisIds":["uuid-nfe-1","uuid-nfe-2","uuid-nfe-3"],"transportadoraId":"uuid","dataExpedicao":"2024-01-15","observacoes":"Entrega urgente - cliente prioritário","formato":"pdf"}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/romaneios/gerar-relatorio", bytes.NewBuffer(payload))
req.Header.Set("Authorization", "Bearer {token}")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/romaneios/gerar-relatorio');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'notasFiscaisIds' => [
            'uuid-nfe-1',
            'uuid-nfe-2'
        ],
        'transportadoraId' => 'uuid',
        'dataExpedicao' => '2024-01-15',
        'observacoes' => 'Entrega urgente - cliente prioritário',
        'formato' => 'pdf'
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/romaneios/gerar-relatorio",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/romaneios/gerar-relatorio",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"notasFiscaisIds\":[\"uuid-nfe-1\",\"uuid-nfe-2\",\"uuid-nfe-3\"],\"transportadoraId\":\"uuid\",\"dataExpedicao\":\"2024-01-15\",\"observacoes\":\"Entrega urgente - cliente prioritário\",\"formato\":\"pdf\"}",
        "options": {
          "response": {
            "response": {
              "responseFormat": "file"
            }
          }
        }
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}
← PedidosRemessas →