Configuring Magazord as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Magazord option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
The following configurations are required:-
Panel URL: The base URL of your Magazord administrative panel, for example
https://yourstore.painel.magazord.com.br(no trailing path). The API is served under this domain. - API Token: The API token of your Magazord account. If you don’t have one yet, request your integration credentials from Magazord (for example via your account manager or integracao@magazord.com.br).
- API Password: The API password paired with the token. Both are sent using HTTP Basic authentication.
- Start Date: The earliest date from which records will be synced for incremental streams (defaults to 2023-01-01).
- Store Timezone: IANA timezone used to render date filters in store-local time (defaults to America/Sao_Paulo).
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). 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.Streams and Fields
Below you’ll find all available data streams from Magazord and their corresponding fields. Orders, customers, products, carts, invoices, prices and stock movements sync incrementally; the remaining streams are extracted as full tables.Pedidos (Orders)
Pedidos (Orders)
Orders across all stores and marketplaces, incrementally synced by their last-change timestamp.Key Fields:
id- Internal ID of the ordercodigo- Order codedata_hora- Date/time when the order was createdvalor_produto- Total product value of the ordervalor_frete- Shipping valuevalor_desconto- Discount value granted at purchase timevalor_total- Total order value paid by the customerpessoa_id/pessoa_nome/pessoa_cpf_cnpj- Customer identificationforma_pagamento_id/forma_pagamento_nome- Payment methodcondicao_pagamento_nome- Payment condition (cash, installments)pedido_situacao/pedido_situacao_descricao- Order status code and descriptionloja_id- Store the order belongs toloja_do_marketplace_id/loja_do_marketplace_nome- Marketplace store, when applicablesynced_at- Sync timestamp used as the incremental replication key
Pessoas (Customers)
Pessoas (Customers)
People and companies registered in the account, with their addresses and contacts, incrementally synced by their last-update date.Key Fields:
id- Internal ID of the persontipo- Person type (individual or company)nome- Name of the personemail- Email addresscpf_cnpj- CPF/CNPJ of the persondata_cadastro- Registration datedata_hora_atualizacao- Date of the last updatenome_fantasia/inscricao_estadual- Company details, when applicablepessoa_endereco- Addresses (JSON array)pessoa_contato- Contacts such as phones and emails (JSON array)
Produtos (Products)
Produtos (Products)
Products in the catalog with their variations, incrementally synced by their last-update timestamp.Key Fields:
id- ID of the productnome- Name of the productcodigo- Code of the producttipo- Type (product, service or kit)marca- ID of the product’s brandativo- Whether the product is activencm/cest/origem_fiscal- Fiscal codespeso/altura/largura/comprimento- Dimensionsdata_lancamento- Launch datecategorias- IDs of the categories (the first is the main one)derivacoes- Variations/SKUs of the product (JSON array)
Carrinhos (Carts)
Carrinhos (Carts)
Shopping carts (open, abandoned or converted), incrementally synced by their update date.Key Fields:
id- ID of the cartstatus- Status (open, abandoned or purchased)data_inicio- When the cart was createddata_atualizacao- Last update to the cart and its items (replication key)hash- Unique hash of the cartpedido- Order linked to the cart, when converted (JSON)draft- Partially filled cart data (JSON)
Notas Fiscais (Fiscal Invoices)
Notas Fiscais (Fiscal Invoices)
Fiscal invoices (NF-e) with their line items, incrementally synced by emission date.Key Fields:
id- ID of the fiscal invoicetipo- Inbound or outbound invoicesituacao- Status (typed, closed, authorized, cancelled, etc.)numero/serie/chave- Invoice number, series and access keydata_emissao- Emission date/time (replication key)itens- Line items with product, quantity, values and taxes (JSON array)
Contas a Pagar (Accounts Payable)
Contas a Pagar (Accounts Payable)
Financial titles to pay, extracted as a full table.Key Fields:
id- ID of the financial titlenumero- Number of the titledata_abertura/data_geracao/data_vencimento- Opening, generation and due datesvalor_original/valor_liquidado/saldo- Original, settled and outstanding valuesparcela- Installment indicatorsituacao- Status of the title (JSON)pessoa- Supplier linked to the title (JSON)ultimo_movimento- Latest settlement movement (JSON)
Contas a Receber (Accounts Receivable)
Contas a Receber (Accounts Receivable)
Financial titles to receive, extracted as a full table.Key Fields:
id- ID of the financial titlenumero- Number of the titledata_abertura/data_geracao/data_vencimento- Opening, generation and due datesvalor_original/valor_liquidado/saldo- Original, settled and outstanding valuesparcela- Installment indicatorsituacao- Status of the title (JSON)pessoa- Customer linked to the title (JSON)origem- Origin of the title, including the linked order (JSON)
Estoque (Stock)
Estoque (Stock)
Current stock position per product variation (SKU) and warehouse, extracted as a full table.Key Fields:
produto- Code of the product variation (SKU)deposito- ID of the warehousequantidade_disponivel_venda- Quantity available for salequantidade_fisica- Physical quantity in stockquantidade_reservado_saida- Quantity reserved for outbound ordersquantidade_prevista_entrada- Quantity expected to arrivecusto_medio/custo_virtual- Average and virtual costs
Movimentações de Estoque (Stock Movements)
Movimentações de Estoque (Stock Movements)
Stock movement history, incrementally synced by movement date/time.Key Fields:
movimentacao- ID of the stock movementproduto- Code of the product variation (SKU)deposito- ID of the warehousequantidade- Quantity movedvalor_movimentacao- Total value of the movementdata_hora_movimentacao- Date/time of the movement (replication key)tipo_operacao- Adjustment, inbound or outboundorigem- Origin of the movementpedido_id/nota_fiscal_id- Related order and invoice
Preços (Prices)
Preços (Prices)
Prices per product variation and price table, incrementally synced by update time.Key Fields:
produto- Code of the product variation (SKU)tabela_preco/tabela_nome- Price tablepreco_venda- Current sale pricepreco_antigo- Previous (crossed-out) pricepercentual_desconto- Discount percentagedata_hora_atualizacao- Last price update (replication key)
Categorias (Categories)
Categorias (Categories)
Product categories, extracted as a full table.Key Fields:
id- Internal ID of the categorynome- Name of the categorypai- ID of the parent categorydescricao- Description of the category
Marcas (Brands)
Marcas (Brands)
Product brands, extracted as a full table.Key Fields:
id- Internal ID of the brandnome- Name of the brandproducao_propria- Whether the brand is produced in-house
Lojas (Stores)
Lojas (Stores)
Stores configured in the account, extracted as a full table.Key Fields:
id- Internal ID of the storecodigo- Code of the storenome- Name of the storeativo- Whether the store is activeurl- URL of the storegrupo- Store group (JSON)
Transportadoras (Carriers)
Transportadoras (Carriers)
Shipping carriers, extracted as a full table.Key Fields:
id- Internal ID of the carriernome- Name of the carrierpessoa- Carrier person registered in Magazord (JSON)
Tabelas de Preço (Price Tables)
Tabelas de Preço (Price Tables)
Price tables, extracted as a full table.Key Fields:
id- ID of the price tablenome- Name of the price tableativa- Whether the price table is activedata_inicio/data_fim- Validity periodopcoes- Pricing options and rules (JSON)
Cupons de Desconto (Discount Coupons)
Cupons de Desconto (Discount Coupons)
Discount coupons, extracted as a full table.Key Fields:
id- Identifier of the couponcodigo- Code entered by the customer at checkoutativo- Whether the coupon is activetipo_desconto- Discount type (value, percentage, fixed price, etc.)valor_desconto- Discount value or percentagevalido_de/valido_ate- Validity periodloja- Store the coupon belongs to