Documentação de Pedidos em ERP

Visão Geral

No contexto de ERP, o pedido é uma das principais entidades da integração, pois representa a formalização de uma venda realizada na loja 📦

---

Filas de Entrada e Saída:

Quando integrado, o pedido pode trafegar em dois sentidos: da plataforma para o ERP ou do ERP para a plataforma.

No fluxo de entrada, os pedidos recebidos são direcionados para uma fila de entrada, onde aguardam processamento interno antes de serem efetivamente persistidos ou atualizados no sistema.

Já no fluxo de saída, pedidos criados ou atualizados na loja podem ser enviados para uma fila de saída, responsável por organizar o envio estruturado dessas informações ao ERP.

---

Mapa de Pedido e Status de Pedido:

Outro ponto essencial são os mapas de pedido, que realizam a correspondência entre identificadores da loja e do ERP, assegurando que ambos os sistemas reconheçam o mesmo registro.

Além disso, o mapeamento de status de pedido é fundamental para manter o fluxo operacional alinhado, permitindo que alterações como “pago”, “enviado” ou “cancelado” sejam refletidas corretamente entre os ambientes 🔄

Listagem de itens da fila de entrada

Descrição

Endpoint responsável por retornar todos os itens da fila de entrada para a plataforma.

Nesse contexto, a fila de entrada é responsável por processar informações que vem do ERP sobre os pedidos, atualizando a plataforma e garantindo a sincronização entre os sistemas 🔄

Parâmetros

Headers Obrigatórios

Campos de Condição Disponíveis

Campos de Ordenação Disponíveis

Exemplo de Requisição

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

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": {
4    "registers": [
5      {
6        "erpStoreCredentialId": 1,
7        "action": "update-status",
8        "status": "pending",
9        "createdAt": "2026-01-21 19:01:47",
10        "orderId": 1
11      },
12      {
13        "erpStoreCredentialId": 2,
14        "action": "update-invoice",
15        "status": "pending",
16        "createdAt": "2025-11-21 12:29:49",
17        "orderId": 2
18      }
19    ],
20    "pagination": {
21      "limit": 10,
22      "offset": 0,
23      "pages": 1,
24      "registers": 10
25    }
26  }
27}

Listagem de itens da fila de saída

Descrição

Endpoint responsável por retornar todos os itens da fila de saída para o ERP.

Nesse contexto, a fila de saída é responsável por processar informações de pedidos que serão enviadas ao ERP, garantindo a sincronização entre os sistemas 🔄

Entre as operações processadas estão:

• atualização de status do pedido
• envio de informações de faturamento
• sincronizações gerais relacionadas ao pedido

Esse retorno facilita o acompanhamento do que está pendente, em processamento ou já enviado ao ERP 📦

Parâmetros

Headers Obrigatórios

Campos de Condição Disponíveis

Campos de Ordenação Disponíveis

Exemplo de Requisição

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

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": {
4    "registers": [
5      {
6        "erpStoreCredentialId": 1,
7        "action": "update-status",
8        "status": "pending",
9        "createdAt": "2026-01-21 19:01:47",
10        "orderId": 1
11      },
12      {
13        "erpStoreCredentialId": 2,
14        "action": "update-invoice",
15        "status": "pending",
16        "createdAt": "2025-11-21 12:29:49",
17        "orderId": 2
18      }
19    ],
20    "pagination": {
21      "limit": 10,
22      "offset": 0,
23      "pages": 1,
24      "registers": 10
25    }
26  }
27}

Adição de pedidos na fila de eventos

Descrição

Endpoint responsável por permitir que o lojista adicione pedidos manualmente na fila de saída para o ERP.

Essa funcionalidade é útil quando há necessidade de reenviar pedidos específicos ou corrigir fluxos que não foram processados automaticamente 🔁

Tipos de ações possíveis

• export – exportação de pedidos para o ERP
• update-status – atualização de status do pedido
• update-invoice – atualização de faturamento do pedido
• update-shipping – atualização de frete
• generate-invoice – geração de faturamento do pedido

Parâmetros

Headers Obrigatórios

Parâmetros do Corpo

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/login \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "orderIds": [
6      1, 2, 3
7    ],
8    "action": "update-status"
9  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": true
4}

⚠️ 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.

Remoção de itens da fila de pedido

Descrição

Endpoint responsável por permitir a remoção de itens da fila de pedidos.

Por que esse endpoint é importante? 🤔 Ele possibilita remover um pedido da fila quando identificado algum problema, evitando que informações incorretas ou inconsistentes sejam enviadas ao ERP.

Com isso, é possível cancelar o envio antes do processamento, garantindo maior controle e confiabilidade na integração 🚀

Observação importante: um mesmo pedido pode aparecer mais de uma vez na fila, dependendo dos tipos de ações geradas para processamento.

Por esse motivo, a remoção exige que seja especificada qual operação do pedido deve ser removida, evitando exclusões indevidas e mantendo a integridade do fluxo ⚠️

Tipos de ações possíveis

• export – exportação de pedidos para o ERP
• update-status – atualização de status do pedido
• update-invoice – atualização de faturamento do pedido
• update-shipping – atualização de frete
• generate-invoice – geração de faturamento do pedido

Parâmetros

Headers Obrigatórios

Parâmetros do Corpo

Exemplo de Requisição

1curl --request DELETE \
2  --url {{MAIN_URL}}/erps/queue/exit/orders \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "orderIds": [
6      1, 2, 3
7    ],
8    "action": "export"
9  }'