Documentação de Status de Pedido e ERP

No contexto de ERP, o status de pedido é responsável por relacionar as etapas do pedido (faturamento, logística, etc).

Esse vínculo garante que, ao exportar um pedido, o ERP reconheça corretamente a etapa do pedido atual, evitando inconsistências no pedido.

O mapeamento atua como uma camada de correspondência entre identificadores, assegurando que códigos internos da plataforma sejam traduzidos para os códigos esperados pelo ERP.

Sem esse alinhamento, pedidos podem ficar parados, impactando no faturamento e na entrega 🔄

Listagem de status de pedidos disponíveis

GET /erps/maps/{erpStoreCredentialId}/order-status/options

Lista status de pedidos disponíveis no ERP

Descrição

Endpoint responsável por retornar a lista de status de pedidos disponíveis no ERP 📦

A requisição exige as credenciais do ERP, pois a consulta é realizada diretamente no sistema de gestão.

Dessa forma, os status retornados refletem exatamente a configuração ativa no ERP, garantindo alinhamento entre a plataforma e o fluxo real dos pedidos.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Authorization`	Bearer {token}	Token de autenticação

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
erpStoreCredentialId	integer	Sim	Identificador da credencial do ERP para acesso

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/erps/maps/{erpStoreCredentialId}/order-status/options \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
curl --request GET \
  --url {{MAIN_URL}}/erps/maps/{erpStoreCredentialId}/order-status/options \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

1{
2	"status": true,
3	"data": {
4		"externalId": {
5			"code": "externalId",
6			"title": "Status",
7			"type": "enum",
8			"default": "",
9			"enum": [
10				"Aberto",
11				"Faturado",
12				"Cancelado",
13				"Aprovado",
14				"Preparando Envio",
15				"Enviado",
16				"Entregue",
17				"Não Pronto Envio",
18				"Dados Incompletos",
19				"Não Entregue"
20			],
21			"mapKey": "",
22			"mapValue": ""
23		}
24	}
25}
{
	"status": true,
	"data": {
		"externalId": {
			"code": "externalId",
			"title": "Status",
			"type": "enum",
			"default": "",
			"enum": [
				"Aberto",
				"Faturado",
				"Cancelado",
				"Aprovado",
				"Preparando Envio",
				"Enviado",
				"Entregue",
				"Não Pronto Envio",
				"Dados Incompletos",
				"Não Entregue"
			],
			"mapKey": "",
			"mapValue": ""
		}
	}
}

⚠️ 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 Interno	Código Http	Descrição
UAPPI_INTEGRATION_ERP_CREDENTIAL_NOT_FOUND	404	A credencial de ERP solicitada não foi encontrada.
UAPPI_EXTERNAL_ERROR_NOT_MAPPED	403	A aplicação encontrou um erro de "não mapeado" no microsserviço external.uappi.

Listagem de status de pedidos mapeados em ERPs

GET /erps/maps/order-status

Lista status de pedidos mapeados em ERPs

Descrição

Endpoint responsável por retornar a lista de status de pedidos mapeados nos ERPs associados à loja 📦

A resposta contempla apenas status previamente mapeados, considerando todas as integrações ativas vinculadas à loja.

Ideal para cenários em que é necessário consultar os status já integrados e padronizados, sem depender de uma chamada direta ao ERP.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Authorization`	Bearer {userToken}	Token de autenticação

Campos de Condição Disponíveis

Campo	Tipo	Descrição
erpStoreCredentialId	integer	Identificador da credencial do ERP
orderStatusId	integer	Identificador do status de pedido mapeado
externalId	string	Identificador do status de pedido no ERP
entry	boolean	Determina se a plataforma irá enviar o status para o ERP
out	boolean	Determina se a plataforma aceitará o status de pedido recebido do ERP
createdAt	string	Data de cadastro do mapeamento

Campos de Ordenação Disponíveis

Campo	Descrição
createdAt	Data de cadastro do mapeamento

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/erps/maps/order-status \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
curl --request GET \
  --url {{MAIN_URL}}/erps/maps/order-status \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": {
4    "registers": [
5      {
6        "erpStoreCredentialId": 1,
7        "externalId": "Aberto",
8        "createdAt": "2026-02-24 17:53:49",
9        "orderStatusId": 1,
10        "entry": true,
11        "out": false
12      },
13      {
14        "erpStoreCredentialId": 1,
15        "externalId": "Faturado",
16        "createdAt": "2026-02-24 17:53:49",
17        "orderStatusId": 2,
18        "entry": false,
19        "out": true
20      }
21    ],
22    "pagination": {
23      "limit": 100,
24      "offset": 0,
25      "pages": 1,
26      "registers": 3
27    }
28  }
29}
{
  "status": true,
  "data": {
    "registers": [
      {
        "erpStoreCredentialId": 1,
        "externalId": "Aberto",
        "createdAt": "2026-02-24 17:53:49",
        "orderStatusId": 1,
        "entry": true,
        "out": false
      },
      {
        "erpStoreCredentialId": 1,
        "externalId": "Faturado",
        "createdAt": "2026-02-24 17:53:49",
        "orderStatusId": 2,
        "entry": false,
        "out": true
      }
    ],
    "pagination": {
      "limit": 100,
      "offset": 0,
      "pages": 1,
      "registers": 3
    }
  }
}

Atualização do mapeamento de status do pedido com o ERP

PUT /erps/maps/{erpStoreCredentialId}/order-status

Possibilita atualizar mapeamento de status do pedido com o ERP

Descrição

Endpoint responsável por possibilitar a atualização do mapeamento de status de pedido com os ERPs 🔄

Permite o cadastro manual de novos mapeamentos, garantindo flexibilidade em cenários onde a integração automática não ocorreu como esperado.

Também é utilizado para corrigir mapeamentos incorretos em casos de falha, assegurando consistência entre a plataforma e os sistemas de gestão integrados.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	application/json	Tipo de conteúdo
`Authorization`	Bearer {userToken}	Token de autenticação

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
erpStoreCredentialId	integer	Sim	Identificador da credencial do ERP

Parâmetros do Corpo

Parâmetro	Tipo	Obrigatório	Descrição
`maps`	array	✅	Lista de itens que devem ser mapeados
`maps.*.orderStatusId`	integer	✅	Identificador do status do pedido a ser mapeado
`maps.*.externalId`	string	✅	Identificador do status de pedido no ERP
`maps.*.entry`	boolean	✅	Determina se a plataforma irá enviar o status para o ERP
`maps.*.out`	boolean	✅	Determina se a plataforma aceitará o status de pedido recebido do ERP
`maps.*.action`	string	✅	Ação que deve ser feita no mapeamento (add/remove)

Exemplo de Requisição

1curl --request PUT \
2  --url {{MAIN_URL}}/erps/maps/{erpStoreCredentialId}/order-status \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "maps": [
6      {
7        "orderStatusId": 1,
8        "externalId": "Enviado",
9        "entry": true,
10        "out": true,
11        "action": "add"
12      }
13    ]
14  }'
curl --request PUT \
  --url {{MAIN_URL}}/erps/maps/{erpStoreCredentialId}/order-status \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
  --data '{
    "maps": [
      {
        "orderStatusId": 1,
        "externalId": "Enviado",
        "entry": true,
        "out": true,
        "action": "add"
      }
    ]
  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": [
4    {
5      "externalId": "Enviado",
6      "erpStoreCredentialId": 1,
7      "action": "add",
8      "orderStatusId": 1,
9      "entry": true,
10      "out": true
11    }
12  ]
13}
{
  "status": true,
  "data": [
    {
      "externalId": "Enviado",
      "erpStoreCredentialId": 1,
      "action": "add",
      "orderStatusId": 1,
      "entry": true,
      "out": true
    }
  ]
}

⚠️ 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 Interno	Código Http	Descrição
UAPPI_INTEGRATION_ERP_CREDENTIAL_NOT_FOUND	404	A credencial de ERP solicitada não foi encontrada.
UAPPI_STORE_ORDER_STATUS_NOT_FOUND	404	Os status de pedido solicitados (1, 2, 3) não foram encontrados.

Começando

Store Theme

Customização de Interface

Consumo de Dados

Tracking e SEO

Checkout

Consumo de Dados

Tracking e SEO

Ambiente de Pagamento

Área Restrita (Minha Conta)

Consumo de Dados

Tracking e SEO

SDK Público (public-sdk)

Modules

Api

Tracking

API Pública

Área Restrita (Minha Conta)

Carrinho de Compras

API Privada

Apps

Configurações Gerais

Clientes

Template

Avaliações

Notificações

ERPs

Filas

Grupo de Pedidos

Pedidos

Carrinhos

Pagamentos

Anti-Fraude

Produtos

Inteligência Artificial

Marcas

Categorias

Filtros

Atributos

Url

Relatórios

Render

Fretes

Usuários

Promocionais

Marketplace

Third Party

Datalogic

Busca

MCP

Documentação de Status de Pedido e ERP

Listagem de status de pedidos disponíveis

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Listagem de status de pedidos mapeados em ERPs

Descrição

Parâmetros

Headers Obrigatórios

Campos de Condição Disponíveis

Campos de Ordenação Disponíveis

Exemplo de Requisição

✅ Resposta de Sucesso

Atualização do mapeamento de status do pedido com o ERP

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Nesta página

Institucional