Skip to main content
Eduzz is a Brazilian platform for selling digital products, covering checkout and payments, subscriptions, affiliate programs, financial settlement, and the Nutror course platform. Its public API exposes sales, subscribers, buyers, products, affiliates, financial statements, and course data.

​
Configuring Eduzz as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Eduzz option from the list of connectors. Click Next and you’ll be prompted to add your access.

​
1. Add account access

You’ll need an access token from an Eduzz application. Sign in at the Eduzz developer console with the producer account that owns the data, create an application, enable the read scopes of the data you want to sync, and copy the application’s access token. The token does not expire and only reaches the data of the account that generated it, so each source needs the token of its own producer account. The following configurations are available:
  • Access Token: The access token of your Eduzz application, used to authenticate every API call.
  • Initial sync date: The earliest date from which records will be synced. When left empty, the connector goes back two years.
  • Date window (days): (Default: 30) Size of each date range requested from the endpoints that require a start and an end date — sales, chargebacks, financial statement, and fiscal documents. Larger windows mean fewer requests to the API.
  • Items per page: (Default: 100) Number of records requested per page on the list endpoints.
  • Requests per minute: (Default: 30) Maximum number of API calls per minute. Eduzz documents a limit of 30 requests per minute for the whole account, so lower this value if the same account is shared with other integrations.
The read scopes are granted per Eduzz module. If the application is missing the scope of a selected stream, the extraction fails with an authorization error — enable the scope in the developer console and run the source again.
Once you’re done, click Next.

​
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.
The product_offers, product_campaigns, and product_partners streams request one page per product, and nutror_course_modules requests one page per course. On accounts with many products or courses, deselect them if you don’t need catalog detail — the extraction respects the 30 requests per minute limit, so they take proportionally longer.
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.
Sales and subscriptions are read by their update date, so records edited after they were created — refunds, cancellations, status changes — are picked up again by the incremental sync. 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 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.

​
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 Eduzz and their corresponding fields. Nested objects are flattened into columns such as buyer_email and total_value, and lists of objects are delivered as JSON strings.
Every sale (invoice) of the producer, including recurring charges of subscriptions. Synced incrementally by update date.Key Fields:
  • id: Unique identifier of the sale
  • contract_id: Subscription contract the sale belongs to, when it is a recurring charge
  • status: Current status of the sale (paid, open, canceled, refunded, chargeback, and others)
  • total_value / total_currency: Total amount paid by the buyer
  • gross_gain_value, net_gain_value: Gross and net amounts earned by the producer
  • fee_value, affiliates_gain_value, partners_gain_value: Fee and commissions discounted from the sale
  • installments, total_interest_value: Installment plan chosen by the buyer
  • paid_at, due_date, credit_date: Payment, due, and credit dates
  • created_at, updated_at: Creation and last update timestamps
  • payment_method, payment_detail, payment_link: Payment method used in the checkout
  • product_id, product_name, product_type, product_billing_type, product_sku: Product sold
  • offer_name: Offer used in the checkout
  • buyer_id, buyer_name, buyer_email, buyer_document, buyer_phone: Buyer data
  • affiliate_id, affiliate_name: Affiliate credited for the sale
  • producer_id, producer_name, recipient_name, recipient_email: Producer and recipient of the amount
  • refund_type, refund_value_value, refund_refunded_at: Refund applied to the sale
  • utm_source, utm_campaign, utm_medium, utm_content, utm_term: Campaign attribution
  • tracker, tracker2, tracker3: Tracking codes sent by the checkout link
  • order_bump_has, order_bump_is_main_sale, order_bump_main_sale_id: Order bump relationship
  • is_infinite_funnel, recovering_status: Funnel and payment recovery flags
Chargebacks opened against the producer’s sales. Synced incrementally by request date.Key Fields:
  • id: Identifier of the sale the chargeback was opened against
  • chargeback_status: Status of the chargeback (new, won, lost, waitingDocuments, inAnalysis)
  • chargeback_requested_at: Date the chargeback was requested
  • chargeback_limit_date: Deadline to send the contesting documents
  • chargeback_documents_uploaded_at: Date the documents were uploaded
  • total_value / total_currency: Amount under chargeback
  • product_id, product_name, product_type, product_sku: Product of the original sale
  • buyer_id, buyer_name, buyer_email, buyer_document: Buyer who opened the chargeback
  • affiliate_id, affiliate_name: Affiliate credited for the original sale
Subscription contracts of recurring products. Synced incrementally by update date.Key Fields:
  • id: Unique identifier of the subscription contract
  • status: Current status of the subscription (active, late, canceled, and others)
  • created_at, updated_at: Creation and last update timestamps
  • first_invoice_id: First invoice (sale) of the subscription
  • is_finite, is_unlimited_installments, has_negotiation: Contract flags
  • recurrence_starts_at, recurrence_next_due_date, recurrence_current_due_date, recurrence_final_due_date, recurrence_finishes_at: Recurrence calendar
  • recurrence_frequency_type, recurrence_frequency_value: Interval between charges
  • charges_total, charges_current, charges_paid, charges_pending, charges_negotiated: Charge counters
  • payment_price_value, payment_method, payment_installments: Amount and method of each charge
  • interruption_type, interruption_reason, interruption_created_at, interruption_remove_access_date, interruption_previous_status, interruption_responsible, interruption_origin: Cancellation or suspension data
  • client_name, client_email, client_phone_number: Subscriber data
  • products: Products included in the subscription, with membership fee and delivery methods (JSON)
Buyers of the producer, with an overview of their purchase history.Key Fields:
  • id: Unique identifier of the buyer
  • name: Full name of the buyer
  • email: Email address used in the checkout
  • phone_country_code, phone_area_code, phone_number: Phone number
  • purchase_history_overview_products_quantity: Number of products purchased from the producer
  • purchase_history_overview_gross_value, purchase_history_overview_net_value: Gross and net amounts generated by the buyer
Products registered by the producer.Key Fields:
  • id: Unique identifier of the product
  • name, description, author: Product identification
  • type: Type of the product (digital, physical, service)
  • status: Current status of the product (active, inactive)
  • moderation: Moderation state on Eduzz
  • producer_id: Producer who owns the product
  • image_url: Cover image of the product
  • payment_type: Charge model (oneTime, subscription)
  • payment_price_value, payment_price_currency: Default price
  • payment_methods_bankslip, payment_methods_pix, payment_methods_card, payment_methods_multiple_cards: Accepted payment methods
  • created_at, updated_at: Creation and last update timestamps
Offers (checkout links and prices) configured for each product.Key Fields:
  • id: Unique identifier of the offer
  • product_id: Product the offer belongs to
  • name: Name of the offer
  • is_default: Whether this is the default offer of the product
  • is_visible_to_affiliates: Whether affiliates can promote the offer
  • checkout_url: Checkout URL of the offer
  • default_price_value, default_price_currency: Price in the default currency
  • prices: Prices per currency (JSON)
Affiliate campaigns created for each product.Key Fields:
  • id: Unique identifier of the campaign
  • product_id: Product the campaign belongs to
  • key: Key identifying the campaign in the checkout links
  • title: Title of the campaign
  • url: Destination URL of the campaign
  • result_per_click_affiliate, result_per_click_producer: Result per click credited to each side
  • is_infinity_funnel, is_active: Campaign flags
  • created_at: Creation timestamp
Partners sharing the revenue of each product.Key Fields:
  • id: Unique identifier of the partner
  • product_id: Product the partner is attached to
  • name, email: Partner identification
  • commission_type, commission_value, commission_only_by_affiliate: Commission rules
  • permission_can_manage_affiliates, permission_can_refund, permission_can_view_customer_data: Permissions granted to the partner
Discount coupons created for the producer’s products.Key Fields:
  • code: Code the buyer types in the checkout
  • description: Description of the coupon
  • value, type: Discount granted, as a fixed value or a percentage
  • quantity: Number of times the coupon can still be redeemed
  • limit_date: Date after which the coupon expires
  • products: Products the coupon applies to, with discounted price and checkout link (JSON)
Affiliations between the producer’s products and their affiliates.Key Fields:
  • id: Unique identifier of the affiliation
  • status: Status of the affiliation request (approved, pending, refused)
  • requested_at, approved_at, created_at, updated_at: Affiliation timeline
  • product_id, product_name: Product the affiliate promotes
  • customer_id, customer_name: Eduzz account affiliated to the product
Statement entries of the producer’s Eduzz account. Synced incrementally by credit date.Key Fields:
  • id: Unique identifier of the statement entry
  • credit_date: Date the amount was credited to the account
  • description: Description shown in the statement
  • type: Category of the entry (sale, refund, bonus, fee, chargeback, and others)
  • sale_id: Sale that originated the entry
  • value_value, value_currency: Amount of the entry
Withdrawals transferred from the Eduzz account to the producer’s bank account.Key Fields:
  • id: Unique identifier of the transfer
  • value_value, value_currency: Amount transferred
  • status: Current status of the transfer
  • requested_at, completed_at, created_at: Transfer timeline
  • details: Details registered about the transfer
  • bank_account_type, bank_account_bank_code, bank_account_agency, bank_account_account: Destination bank account
Fiscal documents issued to the producer’s affiliates. Synced incrementally by emission date.Key Fields:
  • document_id: Unique identifier of the fiscal document
  • document_name, document_type, document_status: Document identification and status
  • document_emission_date, document_reference_date, document_processing_date: Document timeline
  • document_base_value_value, document_tax_value_value, document_tax_base, document_base_percent: Calculation base and withheld tax
  • sale_id, sale_payment_date, sale_total_value: Sale that originated the document
  • product_id, product_title: Product of the originating sale
  • source, destination, client: Issuer, recipient, and client data with addresses (JSON)
Fiscal documents issued to the producer’s buyers. Synced incrementally by emission date. Same fields as the affiliate fiscal documents stream.Key Fields:
  • document_id: Unique identifier of the fiscal document
  • document_name, document_type, document_status: Document identification and status
  • document_emission_date, document_reference_date, document_processing_date: Document timeline
  • document_base_value_value, document_tax_value_value: Calculation base and withheld tax
  • sale_id, sale_payment_date, sale_total_value: Sale that originated the document
  • product_id, product_title: Product of the originating sale
  • source, destination, client: Issuer, recipient, and client data with addresses (JSON)
Courses published by the producer on Nutror, the Eduzz course platform.Key Fields:
  • id: Unique identifier of the course
  • title: Title of the course
  • hash: Hash identifying the course in the Nutror URLs
  • published: Whether the course is published to the students
  • category_id, category_name: Category of the course
  • my_eduzz_association_content_id, my_eduzz_association_title: Product delivering the course
  • created_at, updated_at: Creation and last update timestamps
Modules of each Nutror course.Key Fields:
  • id: Unique identifier of the module
  • course_id: Course the module belongs to
  • title: Title of the module
  • sequence: Position of the module inside the course
  • is_draft, is_free: Module flags
  • days_locked, available_days, release_date: Release rules for the students
  • banner: Banner image of the module
  • created_at: Creation timestamp
Students enrolled in the producer’s Nutror courses.Key Fields:
  • id: Unique identifier of the student
  • name: Full name of the student
  • email: Email address used to access Nutror
  • avatar: Profile picture of the student
Comments left by students on the lessons of the Nutror courses.Key Fields:
  • id: Unique identifier of the comment
  • text: Content of the comment
  • author: Student who wrote the comment
  • type: Type of the comment content
  • status: Moderation status of the comment
  • lesson_id: Lesson the comment was left on
  • is_read, is_answered, is_fixed, is_favorite: Comment flags
  • created_at: Creation timestamp
Nutror is a separate Eduzz product. If the account doesn’t use it, the Nutror streams are skipped with a warning instead of failing the extraction.