Pedidos · API Hooked

Visão Geral

O módulo Pedidos gerencia os pedidos de venda da empresa. Suporta o ciclo completo: criação, fechamento, cancelamento, retorno, envio por e-mail, impressão e geração de relatórios analíticos como curva ABC. Pedidos podem ser vinculados a notas fiscais e ordens de produção.

Base URL

/api/pedidos

Endpoints

GET /api/pedidos

Descrição: Retorna uma lista paginada de pedidos com filtros avançados por cliente, período, situação, vendedor, produto, condição de pagamento e outros critérios.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`pessoaId`	integer (int64)	query	—	Filtra por cliente
`empresaId`	integer (int64)	query	—	Filtra por empresa
`numero`	integer	query	—	Filtra pelo número do pedido
`situacao`	integer	query	—	`1` = Aberto, `2` = Fechado, `3` = Cancelado
`tipoPesquisaData`	integer	query	—	`1` = Emissão, `2` = Entrega
`dataInicial`	string (date-time)	query	—	Data inicial
`dataFinal`	string (date-time)	query	—	Data final
`vendedorId`	integer (int64)	query	—	Filtra por vendedor
`produtoId`	integer (int64)	query	—	Filtra por produto nos itens
`condicaoPagamentoId`	integer (int64)	query	—	Filtra por condição de pagamento
`classificacaoComercialId`	integer (int64)	query	—	Filtra por classificação comercial
`codigoCliente`	string	query	—	Código do cliente no sistema externo
`abertos`	boolean	query	—	`true` = apenas pedidos em aberto
`condicional`	string	query	—	Filtra por pedido condicional
`property`	string	query	—	Campo de ordenação
`orderBy`	string	query	—	Direção: `asc` ou `desc`
`pageNumber`	integer	query	—	Número da página (padrão: `1`)
`pageSize`	integer	query	—	Registros por página (padrão: `20`)

Resposta de Sucesso `200`

{
  "pagination": {
    "currentPage": 1,
    "totalPages": 8,
    "pageSize": 20,
    "totalCount": 142,
    "hasPrevious": false,
    "hasNext": true
  },
  "data": [
    {
      "id": 1,
      "empresaId": 1,
      "codigo": 1001,
      "data": "2024-03-01T00:00:00",
      "dataEntrega": "2024-03-15T00:00:00",
      "pessoaId": 10,
      "pessoaNome": "Cliente Exemplo Ltda",
      "vendedorId": 2,
      "vendedorNome": "Vendedor A",
      "naturezaOperacaoId": 1,
      "naturezaOperacaoDescricao": "Venda de Mercadoria",
      "condicaoPagamentoId": 3,
      "condicaoPagamentoDescricao": "30/60/90 dias",
      "formaPagamentoId": 1,
      "formaPagamentoNome": "Duplicata",
      "valorTotal": 5800.00,
      "situacao": 1,
      "situacaoDescricao": "Aberto",
      "itens": []
    }
  ],
  "summary": null
}

Campos da Resposta — `data[]`

Campo	Tipo	Descrição
`id`	integer (int64)	Identificador do pedido
`codigo`	integer (int64)	Número sequencial do pedido
`data`	string (date-time)	Data de emissão
`dataEntrega`	string (date-time)	Prazo de entrega
`pessoaNome`	string	Nome do cliente
`vendedorNome`	string	Nome do vendedor
`condicaoPagamentoDescricao`	string	Condição de pagamento
`valorTotal`	number	Valor total do pedido
`situacao`	integer	`1` = Aberto, `2` = Fechado, `3` = Cancelado
`itens`	array	Itens do pedido

Códigos de Erro

Código	Descrição
`401`	Token ausente ou inválido
`500`	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/pedidos" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/pedidos',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/pedidos", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/pedidos');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/pedidos",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/pedidos",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

POST /api/pedidos

Descrição: Cria um novo pedido de venda.

Corpo da Requisição

{
  "empresaId": 1,
  "pessoaId": 10,
  "vendedorId": 2,
  "data": "2024-03-01T00:00:00",
  "dataEntrega": "2024-03-15T00:00:00",
  "naturezaOperacaoId": 1,
  "condicaoPagamentoId": 3,
  "formaPagamentoId": 1,
  "tipoFrete": 9,
  "informacaoAdicional": "Entrega no período da manhã",
  "itens": [
    {
      "produtoId": 5,
      "quantidade": 10,
      "valorUnitario": 150.00,
      "valorTotal": 1500.00,
      "desconto": 0
    }
  ]
}

Campo	Tipo	Obrigatório	Regras	Descrição
`empresaId`	integer (int64)	✓	—	ID da empresa emissora
`data`	string (date-time)	✓	ISO 8601	Data de emissão do pedido
`pessoaId`	integer (int64)	✓	—	ID do cliente
`vendedorId`	integer (int64)	✓	—	ID do vendedor responsável
`naturezaOperacaoId`	integer (int64)	✓	—	ID da natureza de operação
`condicaoPagamentoId`	integer (int64)	✓	—	ID da condição de pagamento
`formaPagamentoId`	integer (int64)	✓	—	ID da forma de pagamento
`codigo`	integer (int64)	—	—	Número sequencial do pedido (gerado automaticamente se omitido)
`codigoCliente`	string	—	—	Código do cliente em sistema externo
`dataEntrega`	string (date-time)	—	ISO 8601	Prazo de entrega
`pessoaNome`	string	—	—	Nome do cliente (somente leitura)
`vendedorNome`	string	—	—	Nome do vendedor (somente leitura)
`naturezaOperacaoDescricao`	string	—	—	Descrição da natureza de operação (somente leitura)
`condicaoPagamentoDescricao`	string	—	—	Descrição da condição de pagamento (somente leitura)
`formaPagamentoNome`	string	—	—	Nome da forma de pagamento (somente leitura)
`carga`	string	—	—	Identificação da carga associada ao pedido
`tipoFrete`	integer (int32)	—	—	Tipo de frete (modalidade)
`transportadoraId`	integer (int64)	—	—	ID da transportadora
`transportadoraNome`	string	—	—	Nome da transportadora (somente leitura)
`tabelaPrecoId`	integer (int64)	—	—	ID da tabela de preços usada
`tabelaPrecoDescricao`	string	—	—	Descrição da tabela de preços (somente leitura)
`informacaoAdicional`	string	—	—	Observações/informações adicionais
`atualizarEstoque`	boolean	—	—	Define se o pedido movimenta estoque ao ser fechado
`parcelas`	integer (int64)	—	—	Quantidade de parcelas geradas
`condicional`	string	—	—	Indicador de pedido condicional
`dataPrevistaCondicional`	string (date-time)	—	ISO 8601	Data prevista para retorno do condicional
`valorTotal`	number (double)	—	—	Valor total do pedido
`situacao`	integer (int32)	—	—	`1` = Aberto, `2` = Fechado, `3` = Cancelado
`situacaoDescricao`	string	—	—	Descrição da situação (somente leitura)
`classificacaoComercialId`	integer (int64)	—	—	ID da classificação comercial
`classificacaoComercialDescricao`	string	—	—	Descrição da classificação comercial (somente leitura)
`descontoMaximo`	number (double)	—	—	Percentual máximo de desconto permitido
`dataFechamento`	string (date-time)	—	ISO 8601	Data em que o pedido foi fechado (somente leitura)
`userIdFechamento`	string (uuid)	—	—	ID do usuário que fechou o pedido (somente leitura)
`itens`	array	—	—	Itens do pedido (ver objeto `PedidoItemViewModel`)

Resposta de Sucesso `200`

Retorna o pedido criado.

Códigos de Erro

Código	Descrição
`400`	Dados inválidos
`401`	Token ausente ou inválido
`500`	Erro interno do servidor

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/pedidos" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"empresaId":1,"pessoaId":10,"vendedorId":2,"data":"2024-03-01T00:00:00","dataEntrega":"2024-03-15T00:00:00","naturezaOperacaoId":1,"condicaoPagamentoId":3,"formaPagamentoId":1,"tipoFrete":9,"informacaoAdicional":"Entrega no período da manhã","itens":[{"produtoId":5,"quantidade":10,"valorUnitario":150.0,"valorTotal":1500.0,"desconto":0}]}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "empresaId": 1,
  "pessoaId": 10,
  "vendedorId": 2,
  "data": "2024-03-01T00:00:00",
  "dataEntrega": "2024-03-15T00:00:00",
  "naturezaOperacaoId": 1,
  "condicaoPagamentoId": 3,
  "formaPagamentoId": 1,
  "tipoFrete": 9,
  "informacaoAdicional": "Entrega no período da manhã",
  "itens": [
    {
      "produtoId": 5,
      "quantidade": 10,
      "valorUnitario": 150.0,
      "valorTotal": 1500.0,
      "desconto": 0
    }
  ]
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/pedidos',
    headers={'Authorization': 'Bearer {token}'},
    json={'empresaId': 1, 'pessoaId': 10, 'vendedorId': 2, 'data': '2024-03-01T00:00:00', 'dataEntrega': '2024-03-15T00:00:00', 'naturezaOperacaoId': 1, 'condicaoPagamentoId': 3, 'formaPagamentoId': 1, 'tipoFrete': 9, 'informacaoAdicional': 'Entrega no período da manhã', 'itens': [{'produtoId': 5, 'quantidade': 10, 'valorUnitario': 150.0, 'valorTotal': 1500.0, 'desconto': 0}]}
).json()

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"empresaId":1,"pessoaId":10,"vendedorId":2,"data":"2024-03-01T00:00:00","dataEntrega":"2024-03-15T00:00:00","naturezaOperacaoId":1,"condicaoPagamentoId":3,"formaPagamentoId":1,"tipoFrete":9,"informacaoAdicional":"Entrega no período da manhã","itens":[{"produtoId":5,"quantidade":10,"valorUnitario":150.0,"valorTotal":1500.0,"desconto":0}]}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/pedidos", 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/pedidos');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'empresaId' => 1,
        'pessoaId' => 10,
        'vendedorId' => 2,
        'data' => '2024-03-01T00:00:00',
        'dataEntrega' => '2024-03-15T00:00:00',
        'naturezaOperacaoId' => 1,
        'condicaoPagamentoId' => 3,
        'formaPagamentoId' => 1,
        'tipoFrete' => 9,
        'informacaoAdicional' => 'Entrega no período da manhã',
        'itens' => [
            [
                'produtoId' => 5,
                'quantidade' => 10,
                'valorUnitario' => 150.0,
                'valorTotal' => 1500.0,
                'desconto' => 0
            ]
        ]
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/pedidos",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/pedidos",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"empresaId\":1,\"pessoaId\":10,\"vendedorId\":2,\"data\":\"2024-03-01T00:00:00\",\"dataEntrega\":\"2024-03-15T00:00:00\",\"naturezaOperacaoId\":1,\"condicaoPagamentoId\":3,\"formaPagamentoId\":1,\"tipoFrete\":9,\"informacaoAdicional\":\"Entrega no período da manhã\",\"itens\":[{\"produtoId\":5,\"quantidade\":10,\"valorUnitario\":150.0,\"valorTotal\":1500.0,\"desconto\":0}]}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

GET /api/pedidos/{id}

Descrição: Retorna os dados completos de um pedido pelo ID, incluindo itens, condições e informações adicionais.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID do pedido

Resposta de Sucesso `200`

Retorna o objeto completo com itens preenchidos.

Códigos de Erro

Código	Descrição
`401`	Token ausente ou inválido
`404`	Pedido não encontrado
`500`	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/pedidos/{id}" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos/{id}', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/pedidos/{id}',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/pedidos/{id}", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/pedidos/{id}');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/pedidos/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/pedidos/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

PUT /api/pedidos/{id}

Descrição: Atualiza os dados de um pedido em aberto.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID do pedido a atualizar

Corpo da Requisição

Mesmo formato do POST, com o campo id preenchido.

Resposta de Sucesso `200`

Retorna o pedido atualizado.

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/pedidos/{id}" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos/{id}', {
  method: 'PUT',
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.put(
    'https://api.app.hooked.com.br/api/pedidos/{id}',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/pedidos/{id}", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/pedidos/{id}');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — PUT /api/pedidos/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/pedidos/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

DELETE /api/pedidos/{id}

Descrição: Remove um pedido em aberto pelo ID.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID do pedido a remover

Resposta de Sucesso `200`

Retorna o pedido removido.

Exemplos de Código

cURL

curl -X DELETE "https://api.app.hooked.com.br/api/pedidos/{id}" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos/{id}', {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.delete(
    'https://api.app.hooked.com.br/api/pedidos/{id}',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("DELETE", "https://api.app.hooked.com.br/api/pedidos/{id}", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/pedidos/{id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'DELETE',
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — DELETE /api/pedidos/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "DELETE",
        "url": "https://api.app.hooked.com.br/api/pedidos/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

GET /api/pedidos/recuperar-quantidade

Descrição: Retorna o total de pedidos abertos no sistema.

Resposta de Sucesso `200`

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/pedidos/recuperar-quantidade" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos/recuperar-quantidade', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/pedidos/recuperar-quantidade',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/pedidos/recuperar-quantidade", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/pedidos/recuperar-quantidade');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/pedidos/recuperar-quantidade",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/pedidos/recuperar-quantidade",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

PUT /api/pedidos/{id}/atualizar-comissao

Descrição: Atualiza o percentual de comissão do vendedor no pedido.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID do pedido

Corpo da Requisição

{
  "id": 1,
  "percentual": 5.0
}

Campo	Tipo	Obrigatório	Descrição
`id`	integer (int64)	✓	ID do pedido
`percentual`	number (double)	✓	Percentual de comissão do vendedor

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/pedidos/{id}/atualizar-comissao" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"id":1,"percentual":5.0}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos/{id}/atualizar-comissao', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "id": 1,
  "percentual": 5.0
})
});
const data = await response.json();

Python

import requests

data = requests.put(
    'https://api.app.hooked.com.br/api/pedidos/{id}/atualizar-comissao',
    headers={'Authorization': 'Bearer {token}'},
    json={'id': 1, 'percentual': 5.0}
).json()

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"id":1,"percentual":5.0}`)
req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/pedidos/{id}/atualizar-comissao", 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/pedidos/{id}/atualizar-comissao');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'id' => 1,
        'percentual' => 5.0
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — PUT /api/pedidos/{id}/atualizar-comissao",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/pedidos/{id}/atualizar-comissao",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"id\":1,\"percentual\":5.0}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

PUT /api/pedidos/{id}/cancelar

Descrição: Cancela um pedido aberto.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID do pedido

Resposta de Sucesso `200`

Retorna o pedido com situação atualizada para Cancelado.

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/pedidos/{id}/cancelar" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos/{id}/cancelar', {
  method: 'PUT',
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.put(
    'https://api.app.hooked.com.br/api/pedidos/{id}/cancelar',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/pedidos/{id}/cancelar", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/pedidos/{id}/cancelar');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — PUT /api/pedidos/{id}/cancelar",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/pedidos/{id}/cancelar",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

PUT /api/pedidos/{id}/fechar

Descrição: Fecha um pedido, gerando os títulos financeiros e registrando a data de fechamento.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID do pedido

Resposta de Sucesso `200`

Retorna o pedido fechado.

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/pedidos/{id}/fechar" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos/{id}/fechar', {
  method: 'PUT',
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.put(
    'https://api.app.hooked.com.br/api/pedidos/{id}/fechar',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/pedidos/{id}/fechar", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/pedidos/{id}/fechar');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — PUT /api/pedidos/{id}/fechar",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/pedidos/{id}/fechar",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

PUT /api/pedidos/{id}/retornar

Descrição: Reabre um pedido fechado, estornando os títulos financeiros gerados.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID do pedido

Resposta de Sucesso `200`

Retorna o pedido reaberto.

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/pedidos/{id}/retornar" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos/{id}/retornar', {
  method: 'PUT',
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.put(
    'https://api.app.hooked.com.br/api/pedidos/{id}/retornar',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/pedidos/{id}/retornar", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/pedidos/{id}/retornar');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — PUT /api/pedidos/{id}/retornar",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/pedidos/{id}/retornar",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

GET /api/pedidos/{id}/imprimir

Descrição: Gera o pedido em PDF para impressão.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID do pedido

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/pedidos/{id}/imprimir" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos/{id}/imprimir', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/pedidos/{id}/imprimir',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/pedidos/{id}/imprimir", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/pedidos/{id}/imprimir');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/pedidos/{id}/imprimir",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/pedidos/{id}/imprimir",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

PUT /api/pedidos/{id}/enviar-email

Descrição: Envia o pedido por e-mail para o cliente.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID do pedido

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/pedidos/{id}/enviar-email" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos/{id}/enviar-email', {
  method: 'PUT',
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.put(
    'https://api.app.hooked.com.br/api/pedidos/{id}/enviar-email',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/pedidos/{id}/enviar-email", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/pedidos/{id}/enviar-email');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — PUT /api/pedidos/{id}/enviar-email",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/pedidos/{id}/enviar-email",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

GET /api/pedidos/gerar-relatorio

Descrição: Gera relatório completo de pedidos com os mesmos filtros da listagem. Suporta exportação para Excel e diferentes tipos de relatório.

Parâmetros

Os mesmos do GET /api/pedidos, com os adicionais:

Nome	Tipo	Local	Obrigatório	Descrição
`exibirItens`	boolean	query	—	`true` para incluir itens no relatório
`tipoRelatorio`	integer	query	—	`1` = Sintético, `2` = Analítico
`excel`	boolean	query	—	`true` para exportar em Excel

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/pedidos/gerar-relatorio" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos/gerar-relatorio', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/pedidos/gerar-relatorio',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/pedidos/gerar-relatorio", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/pedidos/gerar-relatorio');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/pedidos/gerar-relatorio",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/pedidos/gerar-relatorio",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

GET /api/pedidos/gerar-relatorio-curva

Descrição: Gera o relatório de curva ABC de pedidos, ranqueando os top clientes ou produtos por volume de vendas no período.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`top`	integer	query	—	Quantidade de registros a retornar (ex: `10` = top 10)
`dataInicial`	string (date-time)	query	—	Data inicial
`dataFinal`	string (date-time)	query	—	Data final
`empresaId`	integer (int64)	query	—	ID da empresa
`tipo`	string	query	—	`C` = Clientes, `P` = Produtos

Resposta de Sucesso `200`

Relatório com ranking e participação percentual de cada item no volume total.

Códigos de Erro

Código	Descrição
`401`	Token ausente ou inválido
`500`	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/pedidos/gerar-relatorio-curva" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/pedidos/gerar-relatorio-curva', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/pedidos/gerar-relatorio-curva',
    headers={'Authorization': 'Bearer {token}'}
).json()

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/pedidos/gerar-relatorio-curva", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/pedidos/gerar-relatorio-curva');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/pedidos/gerar-relatorio-curva",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/pedidos/gerar-relatorio-curva",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

Visão Geral

Base URL

Endpoints

Parâmetros

Resposta de Sucesso 200

Campos da Resposta — data[]

Códigos de Erro

Exemplos de Código

Corpo da Requisição

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Parâmetros

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Parâmetros

Corpo da Requisição

Resposta de Sucesso 200

Exemplos de Código

Parâmetros

Resposta de Sucesso 200

Exemplos de Código

Resposta de Sucesso 200

Exemplos de Código

Parâmetros

Corpo da Requisição

Exemplos de Código

Parâmetros

Resposta de Sucesso 200

Exemplos de Código

Parâmetros

Resposta de Sucesso 200

Exemplos de Código

Parâmetros

Resposta de Sucesso 200

Exemplos de Código

Parâmetros

Exemplos de Código

Parâmetros

Exemplos de Código

Parâmetros

Exemplos de Código

Parâmetros

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Resposta de Sucesso `200`

Campos da Resposta — `data[]`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`