Configuring Pernambucanas as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Pernambucanas 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 API credential created inside the Pernambucanas Seller Center. Sign in at marketplace.pernambucanas.com.br and go to Credential Maintenance. Creating a credential asks for your Seller Center password and returns two values, both required below. The following configurations are available:- API Token: the token issued in Credential Maintenance. It is sent on every request and is stored encrypted.
- Application ID: the identifier shown next to the token. The API rejects a token sent without it.
- Seller Tenant ID: only needed when the credential belongs to a marketplace operator acting on a seller’s behalf. A seller’s own credential already resolves to its tenant, so leave this empty in the usual case.
- Start Date: the earliest record update date to sync. It applies to the streams that support incremental replication.
-
Marketplace IDs: the marketplaces whose category tree should be synced. Used only by the
marketplace_categoriesstream; leave it empty and that stream is skipped while every other stream runs normally. -
Environment: (Default:
production) the Seller Center environment to read from. Change it only if your account was explicitly given access to a test environment. - Lookback Window: (Default: 0 days) the number of days to re-read before the last synced update date, to pick up records the marketplace updated late.
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
Available streams
The table below lists every stream, its slug (the exact identifier to pass when creating the source via API) and a short description.Fields by stream
Below you’ll find all available data streams from Pernambucanas and their corresponding fields:Orders
Orders
Orders placed with the seller on the marketplace. Synced incrementally by
last_update.Key fields:Order Items
Order Items
One row per item line of an order. The lines come from the order payload, so this stream
adds no extra requests to the marketplace.Key fields:
Order Financial Details
Order Financial Details
Commission, promotional subsidies and settlement entries for each order. This stream
queries the marketplace once per order, so it makes the run longer on accounts with a
high order volume.Key fields:
Products
Products
Products the seller publishes to the marketplace. Synced incrementally by
last_update.
Stock is always requested fresh, so the SKU rows match the Seller Center.Key fields:Product SKUs
Product SKUs
Variants of each product, with price and stock. The SKUs come from the product payload,
so this stream adds no extra requests.Key fields:
Brands
Brands
Brands registered by the seller. Synced incrementally by
last_update.Key fields:Marketplace Brands
Marketplace Brands
Brands the marketplace recognises for the seller’s listings. Same fields as
brands.Key fields:Variants
Variants
Variant axes such as colour or size. Synced incrementally by
last_update.Key fields:Marketplace Categories
Marketplace Categories
The marketplace’s category tree and the attributes each category requires. This stream
only runs when Marketplace IDs is filled in; otherwise it is skipped with a note in
the run log.Key fields:
Financial Entries
Financial Entries
Manual financial entries recorded against the seller’s settlement cycle. The endpoint
accepts no filters, so this stream is always a full table.Key fields:
Implementation Notes
- Rate limit. The Seller Center API accepts 100 requests per minute per credential. Nekt stays inside that budget and backs off automatically when the marketplace answers with a rate-limit error, so a large first extraction simply takes longer rather than failing.
- Page sizes are set by the marketplace. Orders are returned 50 at a time and every other endpoint 10 at a time. A first full extraction of a large catalogue is therefore slower than the order history of the same account.
-
Order Financial Detailscosts one request per order. It is the only stream that queries the marketplace once per order, so selecting it makes the run noticeably longer on accounts with a high order volume. Select it when you need commission and settlement data; leave it out otherwise. -
Nested data is stored as JSON text. Fields such as
customer_data,payment_dataorimageshold structured content and are stored as JSON strings. Read them in SQL withJSON_VALUE(customer_data, '$.name')rather thancustomer_data.name. - Streams your credential cannot reach are skipped. If the credential lacks permission for an endpoint, that stream is skipped with a message in the run log and the rest of the extraction completes normally.