Skip to Content
Documentação de integração da plataforma — em evolução contínua.
ReferênciaGlossário

Glossário

ContractAccount — a conta contratante, identificada por CNPJ. É o seu tenant: todo dado da plataforma pertence a um. O contractAccountId viaja no header x-contractAccountId de toda requisição.

CommercialPolicy (política comercial) — o agrupador de preços. Todo registro de preço é gravado como SKU + política, e todo produto declara a política a que pertence. Mais de uma política no mesmo tenant é suportado: modele um produto por política. O que a resolução do preço não faz é desempatar por política — por isso um mesmo SKU não deve ter preço vigente em duas ao mesmo tempo. Criada pelo time Grocers. Veja Tipos de preço.

Seller — a loja física ou centro de distribuição, com endereço. É de onde a mercadoria sai. Criado pelo time Grocers.

Warehouse — a unidade de estoque. Tem quantidade por SKU e se liga a políticas de entrega. Não confundir com seller: um seller pode ter mais de um warehouse. É a única entidade estrutural criada pela integração (POST /v1/batch/Warehouses).

ShippingPolicy (política de entrega) — amarra seller, política comercial e modalidade de entrega (agendada, expressa ou retirada). É o caminho entre a escolha do cliente e o estoque que atende. Criada pelo time Grocers. Uma política aponta para um único warehouse; um warehouse pode atender várias políticas.

externalReference (do warehouse) — exceção à regra geral: o warehouse é reconciliado pelo name, não pelo externalReference. Veja Warehouses.

Produto — a entidade de vitrine: nome, descrição, categoria, marca. Não tem preço nem estoque.

SKU — a unidade vendável: EAN, peso, dimensões, embalagem. É quem tem preço e estoque. Um produto tem um ou mais SKUs.

externalReference — o código que a entidade já tem no seu ERP. É a chave de idempotência de toda a integração: reenviar o mesmo valor atualiza, não duplica.

operationId — identificador da operação assíncrona, devolvido pelas rotas em lote e presente em todo evento de webhook. É a chave de rastreamento ponta a ponta e o que o suporte pede para investigar qualquer problema.

Change order — a alteração de itens do pedido durante a separação, com ajuste do valor final e da cobrança. Fluxo essencial em supermercado, por causa de itens pesáveis e faltas.

Preço de lista (listPrice) — o valor “de”, exibido riscado.

Preço base (basePrice) — o valor “por”, o que o cliente paga.

Preço fixo (fixedPrice) — valor travado, imune a promoções.

quantityAvailable — quantidade vendável do SKU naquele warehouse. É o número que a vitrine considera.

quantityReserved — quantidade separada para pedidos em andamento. Informativo: a plataforma não o desconta do disponível.

PAYMENT_APPROVED — o status (300) em que o pedido cruza a fronteira da plataforma para a operação (seu ERP, ou os apps de Picking e Shipping da Grocers, se contratados). É o único valor de data.status que autoriza criar um pedido. Notificações com status menor existem (250, recusa de pagamento) e mandam descartar.

Tenant — sinônimo de ContractAccount no vocabulário técnico da plataforma.