# Glossário

> O que cada termo significa nesta API — vários nomes não são os que um ERP costuma usar.

Fonte: https://api.viashopmoda.com.br/docs-api/?p=glossario · Atualizado em 18/11/2026


> **Leia antes de integrar o catálogo.** Alguns nomes da API não batem com o que o ERP chama de "tipo", "categoria" ou "cor". A tabela abaixo é a referência.

## Catálogo

| Termo na API | O que é | Rota | Exemplo |
|---|---|---|---|
| **produto** | O modelo da peça, identificado pelo `cod_ref`. Tem título, descrição, preços e fotos. | `produto/*` | `VES001` — Vestido xadrez |
| **variação** / **SKU** | Uma combinação **produto × grade × estampa**. É onde ficam o código de barras, a quantidade em estoque e o preço diferenciado (se houver). | `estoque/*`, `preco/atualizar` | `VES001` tamanho P na cor Azul |
| **grade** | O **tamanho** da variação. | `grade/*` | `P`, `M`, `G`, `38` |
| **estampa** | A **cor ou estampa** da variação. Pode ter uma imagem (estampa) ou uma cor sólida em hexadecimal (cor). | `estampa/*` | `AZUL CLARO`, `FLORAL` |
| **cor** | Estampa do tipo cor sólida (hexadecimal), pré-definida pelo sistema. Só consulta. | `cor/consultar` | `PRETO` = `#000000` |
| **tipo** (campo `tipo` do produto) | O **tipo de peça**. Na API, a rota se chama **`peso`** por motivo histórico. | `peso/*` | `Vestido`, `Blusas e Camisetas` |
| **gênero** (campo `genero` do produto) | O **público** da peça. Na API, a rota se chama **`categoria`**. | `categoria/*` | `FEMININO`, `INFANTIL` |
| **coleção** | Agrupamento de produtos na vitrine (temporada, linha, lançamento). Coleção inativa esconde os produtos. | `colecao/*` | `INVERNO 2026` |
| **SuperVitrine** | Grupo de produtos que são o **mesmo modelo em cores diferentes**, cadastrados como produtos separados. A loja mostra as outras cores na página de cada um. | `produto/associar_supervitrine` | `001 - Preto`, `001 - Verde` |
| **Compre Junto** | Produtos sugeridos junto com outro (relacionados). | `produto/associar_comprejunto` | |

> **Não confunda:** o campo `peso` do produto é o **peso em gramas**. A rota `peso/*` é o cadastro de **tipos** de produto.

## Códigos

| Código | De quem é | Onde aparece |
|---|---|---|
| `id` / `cod_produto` / `cod_grade` / `cod_estampa` | Gerado pela loja (ViaShopModa). | Respostas das consultas e do cadastro. |
| `cod_ref` | Código de referência do produto, definido pelo ERP. Identifica o produto no cadastro: enviar o mesmo `cod_ref` de novo **atualiza** o produto. | `produto/*` |
| `cod_barras` | Código de barras da **variação**, definido pelo ERP. Precisa ser único na loja. É a forma mais simples de identificar uma variação. | `estoque/*`, `preco/*`, `imagens/upload`, `pedido/cadastrar` |
| `cod_gtin` | GTIN/EAN da variação, quando diferente do `cod_barras`. | `produto/cadastrar` |
| `cod_externo` | Código que o **ERP** usa para um produto, tipo, grade, estampa ou cliente. Serve para o ERP localizar o registro pelo código dele. | `cod_externo/associar`, `cliente/associar_codexterno` |
| `numero_pedido` | Número do pedido na loja: **6 dígitos** (ex.: `111111`). | `pedido/*` |
| `numero_pedido_externo` | Número do pedido no **ERP**. | `pedido/associar_codexterno`, `pedido/cadastrar` |
| `cod_cliente`, `id` de cupom, lead e vendedor | Identificadores **codificados** (texto como `"MTIz"`), não números. Use exatamente como recebidos. | `cliente/*`, `cupom/*`, `leads/*`, `vendedores/*` |

## Clientes

| Termo | O que é |
|---|---|
| `tipo_pessoa` | `F` pessoa física, `J` pessoa jurídica, `E` cliente do exterior. |
| **Revendedor** | Cliente pessoa física que compra no atacado (padrão para `F`). |
| **Lojista** | Cliente pessoa jurídica (padrão para `J` e `E`). |
| **Consignado** | Cliente que compra em consignação, com valor máximo de compra (`compra_maxima_atacado`). |
| `liberado_para_comprar` | `S` = pode fazer login e comprar. Qualquer outro valor deixa o cadastro aguardando liberação da loja. |
| **vendedor** | Usuário da loja responsável pelo cliente (vendedora, representante). |
| **lead** | Contato que ainda não é cliente: deixou nome e e-mail ou WhatsApp na loja. |
| **etiqueta** | Marcador de CRM aplicado ao cliente. |

## Vendas

| Termo | O que é |
|---|---|
| **atacado** / **varejo** | Os dois preços de cada produto (`preco_atacado`, `preco_varejo`) e os dois tipos de pedido (`A`, `V`). |
| **preço promocional** (`*_promo`) | Preço "de" na vitrine: a loja mostra "de X por Y". |
| **subpedido** | Parte do pedido com tipo de venda, pagamento e rastreio. Não tem rota própria: vai dentro do corpo de `pedido/*`. |
| **sacola** | Os itens de um pedido. |
| **sacola abandonada** | Itens que um cliente identificado colocou na sacola sem finalizar o pedido. |
| **pedido alterado** | A loja cancela o pedido original e cria um novo com outro número. Veja o guia [Pedidos](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md). |

## Integração

| Termo | O que é |
|---|---|
| **token** | Credencial da loja para a API. Vai no caminho da URL. |
| **webhook** | Aviso que a ViaShopModa envia ao ERP quando algo acontece (pedido novo, cliente novo…). |
| **automação** / **assíncrono** | Algumas rotas não executam na hora: colocam a ação numa fila e devolvem `automacao_id`. Acompanhe com `automacao/consultar`. |
| **lote** | Rotas que recebem uma lista: no máximo **20 itens** por requisição. |
