Skip to content

Listagem de Histórico do Pedido

GET /orders/{orderId}/history

Retorna a listagem de alterações e eventos ocorridos em um pedido específico.

Descrição

Este endpoint fornece uma trilha de auditoria completa de todos os eventos e modificações realizados em um pedido. O acesso a essas informações exige o escopo de permissão ORDER_READ.

Através deste recurso, é possível identificar quem realizou cada ação, a data exata da ocorrência e a origem da alteração, garantindo total transparência no ciclo de vida do pedido.

Os registros incluem desde mudanças de status e atualizações de rastreio até inserções de notas fiscais e ajustes de estoque, permitindo rastrear o histórico técnico e operacional da venda.

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {token}Token de autenticação

Parâmetros da URL

ParâmetroTipoObrigatórioDescrição
orderIdintegerSimID único do pedido

Campos de Condição Disponíveis

CampoTipoDescrição
originstringOrigem da alteração. Valores aceitos: order, status, shipping, invoice, storage, alteration.
actionstringAção executada. Valores aceitos: create-order, change-status, update-tracking, update-invoice, change-storage, create-discount, create-addition.
userNamestringNome do usuário responsável pela ação.
userEmailstringE-mail do usuário responsável pela ação.
createdAtdatetimeData de criação do registro de histórico.
customerIdintegerID do cliente vinculado ao pedido.

Campos de Ordenação Disponíveis

CampoDescrição
idID do registro de histórico
createdAtData de criação do evento

Exemplo de Requisição

1curl --request GET \
2  --url https://sua-loja-uappi.com.br/api/v3/orders/123/history \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI"

✅ Resposta de Sucesso

1{
2  "registers": [
3    {
4      "id": 1,
5      "userId": 5,
6      "userName": "Administrador",
7      "userEmail": "admin@uappi.com.br",
8      "origin": "status",
9      "action": "change-status",
10      "createdAt": "2026-04-27 10:00:00",
11      "before": {
12        "orderStatusId": 1
13      },
14      "after": {
15        "orderStatusId": 2
16      },
17      "orderGroupId": 456,
18      "orderId": 123,
19      "newOrderStatusId": 2
20    }
21  ],
22  "pagination": {
23    "limit": 10,
24    "offset": 0,
25    "pages": 1,
26    "registers": 1
27  }
28}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Código InternoCódigo HttpDescrição
UAPPI_STORE_ORDER_NOT_FOUND404O pedido solicitado através do orderId não foi encontrado.

Listagem de Histórico de Pedidos em Massa

GET /orders/history

Retorna a listagem de alterações e eventos ocorridos em todos os pedidos, sem restrição por pedido específico.

Descrição

Este endpoint fornece uma trilha de auditoria completa de todos os eventos e modificações realizados em todos os pedidos da loja, sem a necessidade de informar um orderId na URL. O acesso a essas informações exige o escopo de permissão ORDER_READ.

Cada registro traz o campo orderId, indicando a qual pedido aquela alteração pertence, além de quem realizou cada ação, a data exata da ocorrência e a origem da alteração, garantindo total transparência sobre o ciclo de vida de todos os pedidos.

Os registros incluem desde mudanças de status e atualizações de rastreio até inserções de notas fiscais e ajustes de estoque, permitindo rastrear o histórico técnico e operacional de toda a operação de vendas a partir de uma única listagem.

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {token}Token de autenticação

Campos de Condição Disponíveis

CampoTipoDescrição
orderIdintegerFiltrar pelo ID do pedido.
originstringOrigem da alteração. Valores aceitos: order, status, shipping, invoice, storage, alteration.
actionstringAção executada. Valores aceitos: create-order, change-status, update-tracking, update-invoice, change-storage, create-discount, create-addition.
userNamestringNome do usuário responsável pela ação.
userEmailstringE-mail do usuário responsável pela ação.
createdAtdatetimeData de criação do registro de histórico.

Campos de Ordenação Disponíveis

CampoDescrição
idID do registro de histórico
createdAtData de criação do evento

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/orders/history \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI"

✅ Resposta de Sucesso

1{
2  "registers": [
3    {
4      "id": 1,
5      "orderId": 123,
6      "orderGroupId": 456,
7      "newOrderStatusId": 2,
8      "userId": 5,
9      "userName": "Administrador",
10      "userEmail": "admin@uappi.com.br",
11      "origin": "status",
12      "action": "change-status",
13      "before": {
14        "orderStatusId": 1
15      },
16      "after": {
17        "orderStatusId": 2
18      },
19      "createdAt": "2026-04-27 10:00:00"
20    }
21  ],
22  "pagination": {
23    "limit": 10,
24    "offset": 0,
25    "pages": 1,
26    "registers": 1
27  }
28}

⚠️ Possíveis erros:

Por se tratar de uma listagem em massa, sem orderId na URL, este endpoint não possui um erro de pedido não encontrado — o único erro específico deste contexto é a validação dos campos de condição/ordenação informados.

Código InternoCódigo HttpDescrição
UAPPI_CORE_INVALID_SEARCH_FIELD400Um dos campos de condição ou ordenação informados na requisição não é válido para esta listagem.

Busca de Detalhes do Histórico do Pedido

GET /orders/{orderId}/history/{historyId}

Retorna os detalhes de um registro específico do histórico de um pedido.

Descrição

Este endpoint permite a consulta granular de um único evento no histórico do pedido. O acesso é restrito e exige o escopo de permissão ORDER_READ.

É ideal para analisar minuciosamente uma alteração, permitindo visualizar os estados de dados anteriores (before) e posteriores (after) à modificação realizada.

Essas informações são fundamentais para processos de resolução de conflitos ou para entender o impacto exato de uma ação administrativa ou sistêmica no pedido.

Parâmetros

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {token}Token de autenticação

Parâmetros da URL

ParâmetroTipoObrigatórioDescrição
orderIdintegerSimID único do pedido
historyIdintegerSimID único do registro de histórico

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/orders/123/history/1 \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI"

✅ Resposta de Sucesso

1{
2  "id": 1,
3  "userId": 5,
4  "userName": "Administrador",
5  "userEmail": "admin@uappi.com.br",
6  "origin": "status",
7  "action": "change-status",
8  "createdAt": "2026-04-27 10:00:00",
9  "before": {
10    "orderStatusId": 1
11  },
12  "after": {
13    "orderStatusId": 2
14  },
15  "orderGroupId": 456,
16  "orderId": 123,
17  "newOrderStatusId": 2
18}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

Código InternoCódigo HttpDescrição
UAPPI_STORE_ORDER_NOT_FOUND404O pedido informado não foi encontrado.
UAPPI_STORE_HISTORY_NOT_FOUND404O registro de histórico solicitado não foi encontrado.

Uappi é a melhor opção para o crescimento da sua loja!

Institucional

;