Skip to main content
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.

​
Configuring Varejo Online as a Source

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.

​
1. Add account access

You’ll need your Varejo Online API Token for this connection. This token authenticates your requests to the Varejo Online API.

​
Configuration Fields

The following configurations are available:
  • Token: The authentication token for the Varejo Online API. Contact your Varejo Online account manager or support team to obtain your API token.
  • Start Date: The earliest date from which records will be synced. This is used for incremental sync of orders based on the dataAlteracao (last modified date) field.
Store your token securely. Treat it like a password and do not share it publicly.
Once you’re done, click Next.

​
2. Select streams

Choose which data streams you want to sync. Varejo Online provides access to your sales order data.
Tip: The stream can be found more easily by typing its name.
Select the streams and click Next.

​
3. Configure data streams

Customize how you want your data to appear in your catalog. Select a name for each table (which will contain the fetched data) and the type of sync.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix 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 the new data - which is good if, for example, you want to keep every record ever fetched.
    • Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
Once you are done configuring, click Next.

​
4. Configure data source

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 determine when to execute a 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.

​
5. Check your new source

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.

​
Streams and Fields

Below you’ll find all available data streams from Varejo Online and their corresponding fields:
Stream containing all sales orders from your Varejo Online account. This stream supports incremental sync based on the dataAlteracao (last modified date) field.Identifiers:
  • id: Order ID
  • idSaida: Linked output ID
  • numero: Order number generated by the system
  • numeroPedidoCliente: Customer’s reference order number
  • idEntidade: Entity ID of the order
  • idTerceiroCliente: Third-party customer ID
  • idRepresentante: Representative/salesperson ID
  • idProvisao: Provision ID generated by the order
  • idCanalDigital: Digital channel ID
Dates & Times:
  • data: Order issue date
  • horario: Order creation time (format: hh:mm:ss)
  • dataAlteracao: Last modification date (format: dd-mm-yyyy hh:mi:ss)
Order Status:
  • cancelado: Whether the order is cancelled
  • statusConferencia: Conference status of the order
  • statusVenda: Sales status
  • statusPedidoVenda: Order status object containing:
    • id: Status ID
    • nome: Status name
    • descricao: Status description
    • dataAlteracao: Status modification date
    • dataCriacao: Status creation date
    • ativo: Whether status is active
    • deletado: Whether status is deleted
Financial Values:
  • valorFrete: Shipping value
  • valorSeguro: Insurance value
  • valorOutros: Other costs
  • valorTotal: Total order value
  • valorLiquido: Net order value
  • valorDesconto: Discount value
  • valorAcrescimo: Addition/surcharge value
  • valeTrocaGerado: Generated exchange voucher value
Entity Information:
  • entidade: Entity data object containing:
    • id: Entity ID
    • nome: Entity name
    • documento: Store’s formatted CNPJ
Customer Information:
  • cliente: Customer data object containing:
    • id: Customer ID
    • nome: Customer name
    • documento: Customer’s formatted CNPJ/CPF
  • documentoTerceiro: Third-party document
Salesperson Information:
  • representante: Salesperson data object containing:
    • id: Salesperson ID
    • nome: Salesperson name
    • documento: Salesperson’s formatted CPF
Order Details:
  • origem: Order origin (e.g., MARKETPLACE)
  • tipo: Order type (NORMAL, SHIP_FROM_STORE, CLICK_COLLECT)
  • sistemaOrigem: Source system
  • nomeTerminal: Terminal name where order was placed
  • planoPagamento: Payment plan
  • vendaConsumidorFinal: Whether it’s a sale to final consumer
  • descontoDetalhes: Discount details
  • observacao: Order observation/notes
Order Items:
  • itens: Array of order items, each containing:
    • id: Item ID
    • idProduto: Product ID
    • quantidade: Quantity
    • operacao: Item operation
    • descricao: Item description
    • unidade: Measurement unit
    • valorTotal: Total item value
    • valorDesconto: Item discount
    • valorAcrescimo: Item surcharge
    • valorDescontoRateado: Prorated discount value
    • valorDescontoItem: Specific item discount
    • valorFreteRateado: Prorated shipping value
    • valorCusto: Cost value
    • descontoDetalhes: Discount details
    • dataEntrega: Delivery date
    • reservarEstoque: Whether to reserve stock
    • tabelaPrecoId: Price table ID
    • Tax values: valorICMS, valorICMSItem, valorICMSFrete, valorICMSST, valorIPI, valorPIS, valorCOFINS, valorFCPST
    • produto: Product object with id, descricao, codigoBarras, codigoInterno, codigoSistema
    • representante: Item salesperson object
    • epcs: Array of Electronic Product Codes
    • lotes: Array of lots
    • numerosValesPresentes: Gift voucher numbers used
Payment Composition:
  • composicaoPagamento: Payment composition object containing:
    • saidaId: Output ID related to payment
    • valorDinheiro: Cash payment value
    • valorChequeVista: Check payment (cash)
    • valorChequePrazo: Check payment (term)
    • valorCrediario: Credit plan value
    • valorVoucher: Voucher payment value
    • valorValePresente: Gift voucher value
    • valorTroca: Exchange value
    • valorAdiantamento: Advance payment value
    • idPlanoCrediario: Credit plan ID
    • valoresCartao: Array of card payments with valor, nsu, bandeira, tipoCartao, operadora, numeroParcelas, autorizacao
    • valoresPix: Array of PIX payments with nsu, autorizacao, valor
    • plano: Payment plan object with id, descricao
Payment Plan:
  • plano: Payment plan object containing:
    • id: Plan ID
    • descricao: Plan description
Installments:
  • parcelas: Array of installments, each containing:
    • id: Installment ID
    • valor: Installment value
    • dataVencimento: Due date
Invoices:
  • notasFiscais: Array of linked invoices, each containing:
    • status: Invoice status
    • idNotaFiscal: Invoice ID
    • tipoNotaFiscal: Invoice type (e.g., MERCADORIA)
Delivery Address:
  • enderecoEntrega: Delivery address object containing:
    • logradouro: Street name
    • numero: Street number
    • complemento: Address complement
    • bairro: Neighborhood
    • cep: Postal code (CEP)
    • cidade: City
    • uf: State (UF)
    • receptorEntrega: Recipient name
    • receptorEntregaDocumento: Recipient document (CPF/CNPJ)
Shipping/Transport:
  • transporte: Transport data object containing:
    • modalidade: Transport modality (e.g., EMITENTE)
    • transportador: Carrier object with id, documento
    • codigoANTT: ANTT code
    • placaVeiculo: Vehicle plate
    • estadoVeiculo: Vehicle registration state
    • quantidade: Number of volumes
    • especie: Volume type (e.g., CAIXA)
    • marca: Volume brand
    • numero: Volume number
    • pesoBruto: Gross weight (kg)
    • pesoLiquido: Net weight (kg)
Intermediary:
  • intermediador: Intermediary object containing:
    • id: Intermediary ID
    • documento: Intermediary’s formatted CNPJ
Additional:
  • idsOrcamentos: Array of related quote IDs
  • servicos: Array of services
  • valeTrocasUtilizados: Array of exchange vouchers used with valorUtilizado

​
Implementation Notes

​
Data Sync Considerations

  • Incremental Sync: The Orders stream supports incremental sync using the dataAlteracao (last modification date) field. This ensures that only orders that have been created or modified since the last sync are extracted.
  • 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.
  • 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.

​
Payment Methods

Varejo Online supports multiple payment methods that are captured in the composicaoPagamento object:
  • Cash (dinheiro)
  • Check - cash and term (cheque)
  • Credit cards with detailed transaction data (NSU, authorization, flag, operator)
  • PIX payments with transaction identifiers
  • Vouchers and gift cards
  • Store credit (crediário)
  • Exchange vouchers (vale troca)

​
Order Types

Orders can be classified by type:
  • NORMAL: Standard orders
  • SHIP_FROM_STORE: Orders fulfilled from physical store inventory
  • CLICK_COLLECT: Buy online, pick up in store orders