Varejo Online is a comprehensive retail management platform designed for Brazilian businesses. It provides tools for sales management, inventory control, order processing, and point-of-sale operations, helping retailers streamline their operations across physical stores and digital channels.
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Varejo Online option from the list of connectors.Click Next and you’ll be prompted to add your access.
You’ll need your Varejo Online API Token for this connection. This token authenticates your requests to the Varejo Online API.
Token: The authentication token for the Varejo Online API. Required. Contact your Varejo Online account manager or support team to obtain your API token.
Start Date: (Optional) The earliest date from which records will be synced for incremental streams. Used for orders, products, stock, and price_table_products based on the dataAlteracao (last modified date) field. You can use common date formats (e.g. 2024-01-01).
Store your token securely. Treat it like a password and do not share it publicly.
Choose which data streams you want to sync. Varejo Online provides access to orders, products, stock (inventory), price tables, and products per price table.
Tip: The stream can be found more easily by typing its name.
Note: The price_table_products stream is a child of price_tables: it fetches products and prices for each price table. Selecting price_table_products will sync data for every price table.Select the streams and click Next.
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
Incremental: every time the extraction happens, we’ll get only records created or modified since the last sync. Supported for orders, products, stock, and price_table_products (using dataAlteracao).
Full table: every time the extraction happens, we’ll get the current state of the data. Use for price_tables or when you prefer a full refresh.
Describe your data source for easy identification within your organization, not exceeding 140 characters.To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times).Optionally, you can define some additional settings:
Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
Once you are ready, click Next to finalize the setup.
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.
Below you’ll find all available data streams from Varejo Online and their corresponding fields:
Orders (orders)
Stream containing all sales orders from your Varejo Online account (GET /pedidos). Supports incremental sync based on the dataAlteracao (last modification date) field. Primary key: id.Identifiers
Field
Type
Description
id
Integer
Order ID
idSaida
Integer
Linked output ID
numero
String
Order number generated by the system
numeroPedidoCliente
String
Customer’s reference order number
idEntidade
Integer
Entity ID of the order
idTerceiroCliente
Integer
Third-party customer ID
idRepresentante
Integer
Representative/salesperson ID
idProvisao
Integer
Provision ID generated by the order
idCanalDigital
Integer
Digital channel ID
Dates & Times
Field
Type
Description
data
String
Order issue date
horario
String
Order creation time (format: hh:mm:ss)
dataAlteracao
String
Last modification date (format: dd-mm-yyyy hh:mi:ss) - Replication Key
Order Status
Field
Type
Description
cancelado
Boolean
Whether the order is cancelled
statusConferencia
String
Conference status of the order
statusVenda
String
Sales status
statusPedidoVenda.id
Integer
Status ID
statusPedidoVenda.nome
String
Status name
statusPedidoVenda.descricao
String
Status description
statusPedidoVenda.dataAlteracao
String
Status modification date
statusPedidoVenda.dataCriacao
String
Status creation date
statusPedidoVenda.ativo
Boolean
Whether status is active
statusPedidoVenda.deletado
Boolean
Whether status is deleted
Financial Values
Field
Type
Description
valorFrete
Number
Shipping value
valorSeguro
Number
Insurance value
valorOutros
Number
Other costs
valorTotal
Number
Total order value
valorLiquido
Number
Net order value
valorDesconto
Number
Discount value
valorAcrescimo
Number
Addition/surcharge value
valeTrocaGerado
Number
Generated exchange voucher value
Entity Information
Field
Type
Description
entidade.id
Integer
Entity ID
entidade.nome
String
Entity name
entidade.documento
String
Store’s formatted CNPJ
Customer Information
Field
Type
Description
cliente.id
Integer
Customer ID
cliente.nome
String
Customer name
cliente.documento
String
Customer’s formatted CNPJ/CPF
documentoTerceiro
String
Third-party document
Salesperson Information
Field
Type
Description
representante.id
Integer
Salesperson ID
representante.nome
String
Salesperson name
representante.documento
String
Salesperson’s formatted CPF
Order Details
Field
Type
Description
origem
String
Order origin (e.g., MARKETPLACE)
tipo
String
Order type (NORMAL, SHIP_FROM_STORE, CLICK_COLLECT)
Stream containing inventory/stock balances for products across entities (GET /saldos-mercadorias). Supports incremental sync based on the dataAlteracao (last modified date) field.Primary Keys:idProduto, idEntidade (composite)Core Fields
Field
Type
Description
idProduto
Integer
Product ID (primary key)
idEntidade
Integer
Entity ID (primary key)
quantidade
Number
Stock quantity
data
Date
Stock information date
dataAlteracao
DateTime
Last modification date - Replication Key
Entity Information (entidade)
Field
Type
Description
entidade.id
Integer
Entity ID
entidade.nome
String
Entity name
entidade.documento
String
Entity document (CNPJ)
Product Information (produto)
Field
Type
Description
produto.id
Integer
Product ID
produto.codigoBarras
String
Product barcode
produto.descricao
String
Product description
produto.codigoInterno
String
Internal product code
produto.codigoSistema
String
System product code
Products (products)
Stream containing product catalog from your Varejo Online account (GET /produtos). Supports incremental sync based on the dataAlteracao (last modified date) field. Primary key: id.Core Fields
Field
Type
Description
id
Integer
Product ID
descricao
String
Product description
codigoInterno
String
Internal product code
codigoBarras
String
Product barcode
codigoSistema
String
System product code
codigoNcm
String
NCM code
codigoSKU
String
SKU
dataCriacao
String
Creation date (dd-mm-aaaa hh:mi:ss)
dataAlteracao
String
Last modification date - Replication Key
unidade
String
Sales unit
preco
Number
Product price
custoReferencial
Number
Reference cost
descontoMaximo
Number
Maximum discount allowed
ativo
Boolean
Whether product is active
deletado
Boolean
Whether product is deleted
permiteVenda
Boolean
Whether product can be sold
controlaLote
Boolean
Whether product uses lot control
controlaValidadeLote
Boolean
Whether lot expiry is controlled
estoqueMinimo
Number
Minimum stock
estoqueMaximo
Number
Maximum stock
peso
Number
Product weight
comissao
Number
Commission
margemLucro
Number
Profit margin
porcentagemRoyalties
Number
Percentage of royalties for the product
disponivelEcommerce
Boolean
Available for e-commerce
disponivelMarketplace
Boolean
Available for marketplaces
Nested / Arrays
Field
Type
Description
produtoBase
Object
Base product (id, nome, codigoSistema)
categorias
Array
Categories (id, nivel, nome)
fornecedores
Array
Suppliers (cnpj, codigo)
dadosPorEntidade
Array
Per-entity data (entidade, codBeneficioFiscal, estoqueMinimo, estoqueMaximo)
Stream containing price tables (GET /tabelas-preco). Full table sync only (no replication key). Primary key: id. Table with ID 1 is always the system default. price_table_products is a child stream of this one.Key Fields
Field
Type
Description
id
Integer
Price table ID
nome
String
Price table name
idsEntidades
Array
Entity IDs for which the table is valid (empty = all)
idsClassificacoesClientes
Array
Customer classification IDs (empty = all)
classificacoesCliente
Array
Customer classifications (id, nome)
disponivel
Boolean
Whether table is available at query time (validity)
ativo
Boolean
Whether table can be applied
permanente
Boolean
Whether table is permanent
promocao
Boolean
Whether table is promotional
excluido
Boolean
Whether table was deleted in the system
inicioVigencia
String
Start date when table can be applied (dd-mm-aaaa hh:mi:ss)
fimVigencia
String
End date when table can be applied (dd-mm-aaaa hh:mi:ss)
peso
Integer
Weight for table application (higher weight wins at sale)
compra
Boolean
Whether table applies to purchases
aplicaDesconto
Boolean
Whether table applies discount
tabelaReferenciaDesconto
Object
Reference table for discount (id, nome)
Price Table Products (price_table_products)
Stream containing products and prices per price table (GET /tabelas-preco/{id}/produtos). Child stream of price_tables — one partition per price table. Supports incremental sync based on dataAlteracao. Primary keys: idTabelaPreco, idProduto.Key Fields
Field
Type
Description
idTabelaPreco
Integer
Price table ID
idProduto
Integer
Product ID
id
Integer
Record ID in price table
preco
Number
Product price in this table
dataAlteracao
String
Last modification date - Replication Key
ativo
Boolean
Whether this price is active
nomeTabelaPreco
String
Price table name
isFromESB
Boolean
Whether record comes from ESB
Product (object)
Field
Type
Description
produto.id
Integer
Product ID
produto.descricao
String
Product description
produto.codigoSistema
String
System code
produto.codigoInterno
String
Internal code
produto.codigoBarras
String
Barcode
History (optional)
Field
Type
Description
historico
Array
Price change history (dataAlteracao, preco, ativo, terceiroAlteracao) when requested
The following diagram illustrates the main relationships. price_table_products is a child of price_tables (one partition per price table). orders reference products and entities; stock is per product and entity.
Incremental Sync: The orders, products, stock, and price_table_products streams support incremental sync using the dataAlteracao (last modification date) field. Only records created or modified since the last sync (or since Start Date on first run) are extracted.
Full Table: The price_tables stream has no replication key; use full table sync to refresh all price table definitions.
Date Formats: Varejo Online uses Brazilian date formats. The data field uses dd-mm-yyyy format, and dataAlteracao uses dd-mm-yyyy hh:mi:ss format. You can configure Start Date using common date formats; the tap sends it to the API as alteradoApos in this format.
Child Stream: price_table_products is a child of price_tables. The tap first syncs all price tables, then requests products and prices for each table. Selecting both streams will result in one price_table_products partition per price table.
Brazilian Tax Fields: Order items include various Brazilian tax fields such as ICMS, ICMS-ST, IPI, PIS, COFINS, and FCP-ST. These are important for fiscal compliance and financial analysis.
