Configuring Olist as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Olist option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
You’ll need to authorize Nekt to access your Olist Tiny data. Click on theOlist Authorization button and log in with your Olist Tiny account. Grant the requested read permissions for the account you want to extract data from.
The following configurations are available:
- Start Date: (Optional) Lower bound for incremental syncs (
dataAlteracaofor Products,dataAtualizacaofor Contacts). If omitted, records are synced from the full history available in the API. Other streams are full-table extractions.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.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 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 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.
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 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.
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.Streams and Fields
Below you’ll find all available data streams from Olist Tiny and their corresponding fields. List responses are paginated and unwrapped from the API’s{ itens, paginacao } envelope.
Pedidos (Orders)
Pedidos (Orders)
Sales orders, including e-commerce channel data, customer, items, shipping, and totals. Full table sync.Key Fields:
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier for the order (primary key) |
numeroPedido | Integer | Order number in Olist Tiny |
situacao | String | Order status |
dataCriacao | Date | When the order was created |
dataPrevista | Date | Expected/scheduled date |
ecommerce | Object | E-commerce channel data (id, nome, numeroPedidoEcommerce, numeroPedidoCanalVenda, canalVenda) |
cliente | Object | Customer details (nome, codigo, cpfCnpj, tipoPessoa, endereco, etc.) |
valor | Number | Order total amount |
Produtos (Products)
Produtos (Products)
Product catalog with pricing and stock summary. Incremental sync on
dataAlteracao.Key Fields:| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier for the product (primary key) |
sku | String | Product SKU |
descricao | String | Product description / name |
tipo | String | Product type |
situacao | String | Product status |
gtin | String | GTIN / barcode |
unidade | String | Unit of measure |
precos | Object | Pricing block (preco, precoPromocional, precoCusto, precoCustoMedio) |
estoque | Object | Stock summary (localizacao and stock data) |
dataCriacao | Date | When the product was created |
dataAlteracao | Timestamp | When the product was last updated (replication key) |
Contatos (Contacts)
Contatos (Contacts)
Contacts / customers registry. Incremental sync on
dataAtualizacao.Key Fields:| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier for the contact (primary key) |
nome | String | Contact name |
codigo | String | Contact code |
fantasia | String | Trade name (nome fantasia) |
tipoPessoa | String | Person type (F = individual, J = company) |
cpfCnpj | String | CPF (individuals) or CNPJ (companies) |
email | String | Email address |
telefone / celular | String | Phone numbers |
endereco | Object | Address (numero, complemento, bairro, municipio, cep, uf, pais) |
vendedor | Object | Associated seller |
situacao | String | Contact status |
statusCrm | String | CRM status |
dataCriacao | Timestamp | When the contact was created |
dataAtualizacao | Timestamp | When the contact was last updated (replication key) |
Notas (Invoices / NF-e)
Notas (Invoices / NF-e)
Fiscal invoices (Nota Fiscal eletrônica) with customer, items, taxes, and access key. Full table sync.Key Fields:
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier for the invoice (primary key) |
tipo | String | Invoice type |
numero | String | Invoice number |
serie | String | Invoice series |
chaveAcesso | String | NF-e access key (chave de acesso) |
dataEmissao | Date | When the invoice was issued |
dataPrevista | Date | Expected date |
situacao | String | Invoice status |
cliente | Object | Customer details (nome, cpfCnpj, endereco, etc.) |
Contas a pagar (Accounts payable)
Contas a pagar (Accounts payable)
Accounts payable entries. Full table sync.Key Fields:
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier for the payable (primary key) |
situacao | String | Status (e.g., open, paid) |
data | Date | Entry date |
dataVencimento | Date | Due date |
historico | String | Description / memo |
valor | Number | Amount due |
saldo | Number | Outstanding balance |
numeroDocumento | String | Document number |
cliente | Object | Counterparty details (nome, cpfCnpj, etc.) |
Contas a receber (Accounts receivable)
Contas a receber (Accounts receivable)
Accounts receivable entries. Full table sync.Key Fields:
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier for the receivable (primary key) |
situacao | String | Status (e.g., open, received) |
data | Date | Entry date |
dataVencimento | Date | Due date |
historico | String | Description / memo |
valor | Number | Amount |
numeroDocumento | String | Document number |
numeroBanco | String | Bank document number |
cliente | Object | Counterparty details (nome, cpfCnpj, etc.) |
Formas de pagamento (Payment methods)
Formas de pagamento (Payment methods)
Registered payment methods. Full table sync.Key Fields:
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier for the payment method (primary key) |
nome | String | Payment method name |
situacao | String | Status |
Marcas (Brands)
Marcas (Brands)
Product brands registry. Full table sync.Key Fields:
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier for the brand (primary key) |
descricao | String | Brand name |
Vendedores (Sellers)
Vendedores (Sellers)
Availability depends on your Olist Tiny plan/permissions. If the module is not available for your account, the stream is skipped (empty) without failing the run.
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier for the seller (primary key) |
nome | String | Seller name |
codigo | String | Seller code |
cpfCnpj | String | CPF or CNPJ |
contato | Object | Linked contact information |
situacao | String | Seller status |
Depósitos (Warehouses)
Depósitos (Warehouses)
Availability depends on your Olist Tiny plan/permissions. If the module is not available for your account, the stream is skipped (empty) without failing the run.
| Field | Type | Description |
|---|---|---|
id | Integer | Unique identifier for the warehouse (primary key) |
descricao | String | Warehouse description / name |
tipo | String | Warehouse type |
desconsideraSaldo | Boolean | Whether the warehouse balance is ignored |
padrao | Boolean | Whether it is the default warehouse |
possuiReserva | Boolean | Whether the warehouse supports reservations |
Data Model
The following diagram illustrates the relationships between the core data streams in Olist Tiny. The arrows indicate the keys that link the different entities, providing a clear overview of the data structure.Implementation Notes
Incremental sync and replication keys
- Produtos: incremental on
dataAlteracao; Contatos: incremental ondataAtualizacao. API requests include a datetime filter (YYYY-MM-DD HH:MM:SS) derived from the bookmark or Start Date. - All other streams (Pedidos, Notas, Contas a pagar, Contas a receber, Formas de pagamento, Marcas, Vendedores, Depósitos) are full-table syncs.
Plan-dependent modules
Some Olist Tiny modules are gated by the account’s plan or permissions. When an endpoint is not accessible, the connector logs a warning and skips that stream with empty results instead of failing the whole run. This commonly affects Vendedores and Depósitos.Brazilian context
This connector is designed for the Brazilian market:- Currency: Values are in BRL (Brazilian Real).
- Documents: Counterparties are identified by CPF (individuals) or CNPJ (companies) in the
cpfCnpjfield. - Addresses: Brazilian address format with CEP (postal code) and state abbreviation (
uf). - Invoices:
chaveAcessois the NF-e access key (chave de acesso).
Nested data structures
Olist Tiny payloads include nested objects (e.g.,cliente, endereco, precos, ecommerce). When querying:
- Access nested objects using dot notation (e.g.,
cliente.nome). - Handle NULL values in nested fields with
COALESCE.
Skills for agents
Download Olist skills file
Olist connector documentation as plain markdown, for use in AI agent contexts.