Documentação de Produtos em ERP

Visão Geral

No contexto de ERP, o produto é uma das principais entidades da integração, pois representa os itens comercializados e controlados entre a loja e o sistema de gestão 📦

Ele concentra informações como dados cadastrais, preços, variações e estoque, sendo fundamental para a consistência operacional.

---

Filas de Entrada e Saída:

Quando integrado, o produto também pode trafegar nos dois sentidos: do ERP para a plataforma ou da plataforma para o ERP.

No fluxo de entrada, produtos vindos do ERP são inseridos em uma fila de entrada, onde aguardam processamento antes de serem cadastrados ou atualizados na loja.

Já no fluxo de saída, produtos criados ou modificados na plataforma podem ser enviados para uma fila de saída, organizando o envio estruturado dessas informações ao ERP.

Esse modelo garante controle, rastreabilidade e processamento assíncrono da integração 🔄

---

Mapa de Produto e Estoque:

Outro ponto essencial são os mapas de produto, responsáveis por relacionar os identificadores da loja com os identificadores do ERP, assegurando que ambos os sistemas reconheçam o mesmo item.

Além disso, a sincronização de estoque e preços depende desse mapeamento, garantindo que atualizações realizadas em um ambiente sejam corretamente refletidas no outro, evitando divergências operacionais.

Listagem de produtos na fila de entrada

GET /erps/queue/entry/products

Retorna lista de produtos na fila de entrada

Descrição

Endpoint responsável por retornar a lista de produtos na fila de entrada da loja 📥

A listagem contempla produtos aguardando processamento, originados do ERP para a plataforma.

Trata-se de uma fila de integração, utilizada para controlar e acompanhar os itens que ainda serão processados, garantindo organização e rastreabilidade no fluxo de importação.

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 de acesso ao ERP
`action`	string	O tipo da ação para processamento (update-price', update-stock, import)
`status`	string	A situação do item para processamento (pending, running)

Campos de Ordenação Disponíveis

Campo	Descrição
createdAt	Data de cadastro do item na fila

Exemplo de Requisição

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

✅ Resposta de Sucesso

OriginalRequest

Esse campo representa os dados enviados do ERP para a loja para processamento

Identifiers

Esse campo armazena os identificadores extraídos do payload original que veio do ERP

1{
2	"status": true,
3	"data": {
4		"registers": [
5			{
6				"erpStoreCredentialId": 5,
7				"action": "import",
8				"status": "pending",
9				"createdAt": "2026-01-15 17:11:20",
10				"id": 52,
11				"originalRequest": {
12					"versao": "1.0.1",
13					"cnpj": "10831068000176",
14					"idEcommerce": 4994,
15					"tipo": "produto",
16					"dados": {
17						"id": "925834243",
18						"idMapeamento": "5890884",
19						"skuMapeamento": "5890884",
20						"nome": "As crônicas de gelo e fogo - A Fúria Dos Reis",
21						"codigo": "CRONICASGELOFOGOFURIADOSREIS",
22						"unidade": "",
23						"preco": "70.26",
24						"precoPromocional": "0.00",
25						"ncm": "",
26						"origem": "0",
27						"gtin": "",
28						"gtinEmbalagem": "",
29						"localizacao": "",
30						"pesoLiquido": "0.9",
31						"pesoBruto": "0",
32						"estoqueMinimo": "0",
33						"estoqueMaximo": "0",
34						"idFornecedor": "0",
35						"codigoFornecedor": "",
36						"codigoPeloFornecedor": "",
37						"unidadePorCaixa": "",
38						"estoqueAtual": 0,
39						"precoCusto": "30.12",
40						"precoCustoMedio": "30.12",
41						"situacao": "A",
42						"descricaoComplementar": "",
43						"obs": "",
44						"garantia": "",
45						"cest": "",
46						"sobEncomenda": "N",
47						"marca": "Editora Suma",
48						"tipoEmbalagem": "2",
49						"alturaEmbalagem": "23",
50						"larguraEmbalagem": "16",
51						"comprimentoEmbalagem": "0",
52						"diametroEmbalagem": "0",
53						"classeProduto": "V",
54						"idCategoria": "925312372",
55						"descricaoCategoria": "Guerra medieval",
56						"descricaoArvoreCategoria": "Livros > Fantasia medieval > Guerra medieval",
57						"arvoreCategoria": [
58							{
59								"id": "683413009",
60								"idPai": "0",
61								"descricao": "Livros",
62								"descricaoCompleta": "Livros"
63							},
64							{
65								"id": "925312371",
66								"idPai": "683413009",
67								"descricao": "Fantasia medieval",
68								"descricaoCompleta": "Livros > Fantasia medieval"
69							},
70							{
71								"id": "925312372",
72								"idPai": "925312371",
73								"descricao": "Guerra medieval",
74								"descricaoCompleta": "Livros > Fantasia medieval > Guerra medieval"
75							}
76						],
77						"variacoes": [
78							{
79								"id": "925834269",
80								"idMapeamento": "5890885",
81								"skuMapeamento": "5890885",
82								"codigo": "CRONICASGELOFOGOFURIADOSREIS-1",
83								"gtin": "",
84								"preco": "80.26",
85								"precoPromocional": "0.00",
86								"estoqueAtual": 100,
87								"grade": [
88									{
89										"chave": "Edição",
90										"valor": "Edição 1"
91									}
92								],
93								"anexos": []
94							},
95							{
96								"id": "925834272",
97								"idMapeamento": "5890886",
98								"skuMapeamento": "5890886",
99								"codigo": "CRONICASGELOFOGOFURIADOSREIS-2",
100								"gtin": "",
101								"preco": "85.62",
102								"precoPromocional": "0.00",
103								"estoqueAtual": 200,
104								"grade": [
105									{
106										"chave": "Edição",
107										"valor": "Edição 2"
108									}
109								],
110								"anexos": []
111							}
112						],
113						"anexos": [],
114						"seo": {
115							"title": "",
116							"description": "",
117							"keywords": "",
118							"linkVideo": "",
119							"slug": ""
120						},
121						"kit": []
122					}
123				},
124				"identifiers": [
125					"925834243",
126					"925834269",
127					"925834272"
128				]
129			}
130		],
131		"pagination": {
132			"limit": 100,
133			"offset": 0,
134			"pages": 1,
135			"registers": 1
136		}
137	}
138}
{
	"status": true,
	"data": {
		"registers": [
			{
				"erpStoreCredentialId": 5,
				"action": "import",
				"status": "pending",
				"createdAt": "2026-01-15 17:11:20",
				"id": 52,
				"originalRequest": {
					"versao": "1.0.1",
					"cnpj": "10831068000176",
					"idEcommerce": 4994,
					"tipo": "produto",
					"dados": {
						"id": "925834243",
						"idMapeamento": "5890884",
						"skuMapeamento": "5890884",
						"nome": "As crônicas de gelo e fogo - A Fúria Dos Reis",
						"codigo": "CRONICASGELOFOGOFURIADOSREIS",
						"unidade": "",
						"preco": "70.26",
						"precoPromocional": "0.00",
						"ncm": "",
						"origem": "0",
						"gtin": "",
						"gtinEmbalagem": "",
						"localizacao": "",
						"pesoLiquido": "0.9",
						"pesoBruto": "0",
						"estoqueMinimo": "0",
						"estoqueMaximo": "0",
						"idFornecedor": "0",
						"codigoFornecedor": "",
						"codigoPeloFornecedor": "",
						"unidadePorCaixa": "",
						"estoqueAtual": 0,
						"precoCusto": "30.12",
						"precoCustoMedio": "30.12",
						"situacao": "A",
						"descricaoComplementar": "",
						"obs": "",
						"garantia": "",
						"cest": "",
						"sobEncomenda": "N",
						"marca": "Editora Suma",
						"tipoEmbalagem": "2",
						"alturaEmbalagem": "23",
						"larguraEmbalagem": "16",
						"comprimentoEmbalagem": "0",
						"diametroEmbalagem": "0",
						"classeProduto": "V",
						"idCategoria": "925312372",
						"descricaoCategoria": "Guerra medieval",
						"descricaoArvoreCategoria": "Livros > Fantasia medieval > Guerra medieval",
						"arvoreCategoria": [
							{
								"id": "683413009",
								"idPai": "0",
								"descricao": "Livros",
								"descricaoCompleta": "Livros"
							},
							{
								"id": "925312371",
								"idPai": "683413009",
								"descricao": "Fantasia medieval",
								"descricaoCompleta": "Livros > Fantasia medieval"
							},
							{
								"id": "925312372",
								"idPai": "925312371",
								"descricao": "Guerra medieval",
								"descricaoCompleta": "Livros > Fantasia medieval > Guerra medieval"
							}
						],
						"variacoes": [
							{
								"id": "925834269",
								"idMapeamento": "5890885",
								"skuMapeamento": "5890885",
								"codigo": "CRONICASGELOFOGOFURIADOSREIS-1",
								"gtin": "",
								"preco": "80.26",
								"precoPromocional": "0.00",
								"estoqueAtual": 100,
								"grade": [
									{
										"chave": "Edição",
										"valor": "Edição 1"
									}
								],
								"anexos": []
							},
							{
								"id": "925834272",
								"idMapeamento": "5890886",
								"skuMapeamento": "5890886",
								"codigo": "CRONICASGELOFOGOFURIADOSREIS-2",
								"gtin": "",
								"preco": "85.62",
								"precoPromocional": "0.00",
								"estoqueAtual": 200,
								"grade": [
									{
										"chave": "Edição",
										"valor": "Edição 2"
									}
								],
								"anexos": []
							}
						],
						"anexos": [],
						"seo": {
							"title": "",
							"description": "",
							"keywords": "",
							"linkVideo": "",
							"slug": ""
						},
						"kit": []
					}
				},
				"identifiers": [
					"925834243",
					"925834269",
					"925834272"
				]
			}
		],
		"pagination": {
			"limit": 100,
			"offset": 0,
			"pages": 1,
			"registers": 1
		}
	}
}

Listagem de itens na fila de saída

GET /eps/queue/exit/products

Lista produtos presentes na fila de saída para processamento

Descrição

Endpoint responsável por retornar todos os itens presentes na fila de saída 📤

A listagem contempla produtos aguardando envio para processamento no ERP, organizados de forma estruturada.

Essa fila funciona como um controle do fluxo de integração, permitindo acompanhar o que ainda será processado e garantir maior rastreabilidade das operações.

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
productId	integer	Identificador do produto que saiu para processamento
externalId	string	Identificador do produto no ERP
erpStoreCredentialId	integer	Identificador da credencial do ERP
action	string	Determina a ação de processamento (update-status, update-price)
status	string	Status do processamento (running, pending)

Campos de Ordenação Disponíveis

Campo	Descrição
createdAt	Data de cadastro do iten na fila

Exemplo de Requisição

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

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": {
4    "registers": [
5      {
6        "erpStoreCredentialId": 1,
7        "action": "update-price",
8        "status": "pending",
9        "createdAt": "2026-02-25 11:54:57",
10        "productId": 1
11      },
12    ],
13    "pagination": {
14      "limit": 10,
15      "offset": 0,
16      "pages": 1,
17      "registers": 10
18    }
19  }
20}
{
  "status": true,
  "data": {
    "registers": [
      {
        "erpStoreCredentialId": 1,
        "action": "update-price",
        "status": "pending",
        "createdAt": "2026-02-25 11:54:57",
        "productId": 1
      },
    ],
    "pagination": {
      "limit": 10,
      "offset": 0,
      "pages": 1,
      "registers": 10
    }
  }
}

Adição de itens na fila de saída

POST /erps/queue/exit/products

Permite adicionar produtos à fila de saída

Descrição

Endpoint responsável por permitir adicionar itens à fila de saída para processamento no ERP.

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 do Corpo

Parâmetro	Tipo	Obrigatório	Descrição
`productIds`	array	✅	Lista de ids de produto que devem ser enviados para processamento
`productIds.*`	string	✅	Identificador do produto que deve ser adicionado à fila
`action`	string	✅	Tipo de ação que deve ser realizada para processamento (update-price, update-stock)

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/erps/queue/exit/products \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "productIds": [
6      1, 2, 3
7    ],
8    "action": "update-price"
9  }'
curl --request POST \
  --url {{MAIN_URL}}/erps/queue/exit/products \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
  --data '{
    "productIds": [
      1, 2, 3
    ],
    "action": "update-price"
  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": true
4}
{
  "status": true,
  "data": 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_STORE_PRODUCT_NOT_FOUND	404	Os produtos solicitados (1, 2, 3) não foram encontrados.

Remoção de itens da fila de saída

DELETE /api/v3/erps/queu/exit/products

Possibilita a remoção de itens da fila de saída

Descrição

Endpoint responsável por retornar permitir remover um produto da fila de saída. Permite remover itens que falharam ou controle manual do que deve ser processado para o ERP.

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 do Corpo

Parâmetro	Tipo	Obrigatório	Descrição
`productIds`	array	✅	Lista de produtos que devem ser removidos da fila
`productIds.*`	integer	✅	Identificador do produto que deve ser removido
`action`	string	✅	Para produtos com mais de um processamento na fila, esse campo permite selecionar exatamente qual processamento deve ser removido

Exemplo de Requisição

1curl --request DELETE \
2  --url {{MAIN_URL}}/api/v3/erps/queu/exit/products \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "productIds": [
6      1, 2, 3
7    ],
8    "action": "update-status"
9  }'
curl --request DELETE \
  --url {{MAIN_URL}}/api/v3/erps/queu/exit/products \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
  --data '{
    "productIds": [
      1, 2, 3
    ],
    "action": "update-status"
  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

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

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 Produtos em ERP

Visão Geral

Listagem de produtos na fila de entrada

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

Listagem de itens na fila de saída

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

Adição de itens na fila de saída

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros do Corpo

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Remoção de itens da fila de saída

Descrição

Parâmetros

Headers Obrigatórios