Documentação das Entidades Fundamentais da Loja

Visão geral

Este conjunto de rotas define as entidades base da loja, responsáveis por estruturar como produtos, clientes e regras comerciais se organizam dentro da plataforma.

As seções a seguir descrevem os principais conceitos utilizados por essas rotas, servindo como base para o entendimento da modelagem e do comportamento do sistema.

---

🛒 Canal de venda

Canal de venda é o ambiente ou plataforma onde os produtos da loja são disponibilizados ao cliente final, como uma loja específica, marketplace, aplicativo ou outro ponto de venda configurado.

Cada canal pode possuir regras e políticas próprias, permitindo que um mesmo produto seja apresentado de formas diferentes conforme o canal utilizado.

Essa estrutura organiza como a loja distribui e exibe seus produtos em cada ambiente de venda.

No contexto da Uappi, os canais de venda consistem principalmente em lojas, onde é possível visualizar uma base de clientes associada a seus domínios, produtos e propósitos.

---

📑 Política comercial

Política comercial é a estrutura responsável por definir como produtos e canais de venda se comportam dentro da plataforma.

Cada política pode conter informações próprias, como descrição, preço, URL e associações com lojas ou canais específicos, possibilitando que um mesmo produto exista em versões distintas de acordo com a política aplicada.

Uma mesma política comercial pode estar associada a múltiplos canais de venda, garantindo que as mesmas regras e configurações sejam aplicadas de forma consistente a todos os canais vinculados 🔎.

Listagem de Canal de Venda e Políticas Comerciais

Descrição

Endpoint responsável por listar o mapeamento entre canais de venda e políticas comerciais da loja atual.

Essa rota serve como base para todo o painel, sendo considerada de alta criticidade.

Ela é amplamente utilizada pelo frontend para o controle de exibição e a aplicação das regras de negócio.

Parâmetros

Headers Obrigatórios

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/auth/store-entities \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": {
4    "tradePolicy": [
5      {
6        "id": 1,
7        "name": "sua loja",
8        "currencyId": "BRL",
9        "salesChannel": {
10          "1": "sualoja.com.br",
11        }
12      },
13      {
14        "id": 2,
15        "name": "outra loja",
16        "currencyId": "BRL",
17        "salesChannel": {
18          "2": "outraloja.com.br",
19        }
20      }
21    ],
22    "salesChannel": {
23      "1": "sualoja.com.br",
24      "2": "outraloja.com.br",
25    }
26  }
27}

Listagem de políticas comerciais da loja

Descrição

Lista as políticas comerciais da loja, sendo utilizado pelo frontend para aplicação de regras de negócio.

Parâmetros

Headers Obrigatórios

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/auth/trade-policies \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": [
4    {
5      "id": 1,
6      "name": "minhaloja",
7      "currencyId": "BRL"
8    }
9  ]
10}

Listagem de canais de venda por política comercial

Descrição

Retorna todos os canais de venda associados a uma política comercial especificada. Necessário principalmente para controle de canais de venda e política comercial no frontend.

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/auth/trade-policy/{tradePolicyId}/sales-channels \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

Endpoint sem paginação e retorno no padrão chave:valor, onde o ID é a chave e o nome do canal de venda é o valor.

1{
2  "status": true,
3  "data": {
4    "1": "minhaloja.com.br"
5  }
6}

Listagem dos canais de venda da loja

Endpoint

Descrição

Retorna todos os canais de venda da loja. Necessário principalmente para controle de canais de venda no frontend.

Parâmetros

Headers Obrigatórios

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/auth/sales-channels \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

Endpoint sem paginação e retorno no padrão chave:valor, onde o ID é a chave e o nome do canal de venda é o valor.

1{
2  "status": true,
3  "data": {
4    "1":"minhaloja.com.br",
5    "2":"outraloja.com.br"
6  }
7}