Mirakl

Mirakl is a leading marketplace platform that enables businesses to build and scale online marketplaces, manage seller relationships, process transactions, and optimize marketplace operations through comprehensive e-commerce and logistics management capabilities.

Power end-to-end data operations for your Mirakl API with Nexla. Our bi-directional Mirakl connector is purpose-built for Mirakl, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Mirakl or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Mirakl workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Mirakl credential, you need to obtain your API base URL and API key from your Mirakl account. Mirakl uses API key authentication for all API requests, with the API key sent in the Authorization header.

To obtain your Mirakl API credentials, follow these steps:

1. Sign in to your Mirakl account using your administrator credentials.

2. Navigate to the Settings or Administration section in your Mirakl dashboard.

3. Look for the API or API Keys section in the settings menu.

4. If you don't have an API key yet, click Generate API Key or Create API Key to create a new API key.

5. Copy the API key immediately after it's generated, as it may not be accessible again after you navigate away from the page.

6. Locate your API base URL in your Mirakl account settings or documentation. The API base URL is typically in the format https://[HOSTNAME] where [HOSTNAME] is your Mirakl instance hostname. The API base URL is used to construct API endpoint URLs for all Mirakl API requests.

7. Store both the API key and API base URL securely, as you will need them to configure your Nexla credential. The API key is sensitive information and should be kept confidential.

The API key is sent in the Authorization header for all API requests to the Mirakl API. The API base URL is used to construct API endpoint URLs specific to your Mirakl instance (e.g., https://[HOSTNAME]/api/sellerpayment/transactions_logs). The API key authenticates your requests and grants access to Mirakl resources based on your account permissions. If your API key is compromised, you should immediately revoke it in your Mirakl account settings and generate a new one. For detailed information about API authentication, available endpoints, and API usage, refer to the Mirakl API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Base Url	Yes	No	Your Mirakl API URL. Usually of the format https://[HOSTNAME]
API Key	Yes	Yes	Your Mirakl API key

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Mirakl

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

   Mirakl uses API key authentication for all API requests. The API key is sent in the Authorization header to authenticate API requests to the Mirakl API.

3. Enter your Mirakl API base URL in the API Base Url field. This should be the base URL of your Mirakl instance, typically in the format https://[HOSTNAME] where [HOSTNAME] is your Mirakl instance hostname. The API base URL is used to construct API endpoint URLs for all Mirakl API requests. Ensure the URL includes the protocol (https://) and does not include a trailing slash.

4. Enter your Mirakl API key in the API Key field. This is the API key you obtained from your Mirakl account settings (Settings or Administration > API Keys). The API key is sent in the Authorization header for all API requests to the Mirakl API. The API key is sensitive information and must be kept confidential.

   Your Mirakl API base URL and API key can be found in your Mirakl account settings under the Settings or Administration > API Keys section. The API base URL is typically in the format https://[HOSTNAME] where [HOSTNAME] is your Mirakl instance hostname. The API key is sent in the Authorization header for all API requests to the Mirakl API.

   If your API key is compromised, you should immediately revoke it in your Mirakl account settings and generate a new one. The API key provides access to your Mirakl data and should be treated as sensitive information. Keep your API key secure and do not share it publicly.

   For detailed information about API authentication, available endpoints, and API usage, see the Mirakl API documentation.

5. Click the Save button at the bottom of the overlay to save the configured credential. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Mirakl connector tile, then select the credential that will be used to connect to your Mirakl account, and click Next; or, create a new Mirakl credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Mirakl endpoints. Each template is designed specifically for the corresponding Mirakl endpoint, making data source setup easy and efficient. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

List Transaction Lines

This endpoint template retrieves all transaction lines within a specified time window from your Mirakl account. Use this template when you need to retrieve transaction data for financial reporting, reconciliation, or analysis purposes. The endpoint uses token-based pagination to handle large datasets efficiently.

• Enter the starting date and time in the From Date-Time field. This should be in ISO-8601 date time format (e.g., 2021-09-24T14:49:47Z). This determines the beginning of the time window for retrieving transactions. You can use Nexla macros like {now} for the current time, or {now-1} for one time unit before the current time.
• Enter the ending date and time in the To Date-Time field. This should be in ISO-8601 date time format (e.g., 2021-09-24T14:49:47Z). This determines the end of the time window for retrieving transactions. You can use Nexla macros like {now} for the current time, or {now+1} for one time unit after the current time.

This endpoint uses token-based pagination with next_page_token to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by using the next_page_token returned in the API response. The endpoint retrieves up to 100 transaction lines per page by default.

Date-time values must be in ISO-8601 format (e.g., 2021-09-24T14:49:47Z). You can use Nexla date/time macros to create dynamic date ranges. For example, use {now-7} to retrieve transactions from the last 7 days, or {now-1} to retrieve transactions from the previous time unit. The endpoint filters transactions based on the date_created_from and date_created_to parameters.

For detailed information about available endpoints, API response structure, pagination, and API usage limits, see the Mirakl API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right. If the sample data is not as expected, review the selected endpoint and associated settings, make any necessary adjustments, and test again to ensure that the correct information is displayed before saving.

Manual configuration

Mirakl data sources can also be manually configured to ingest data from any valid Mirakl API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom query parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Mirakl API typically uses the GET method for retrieving data. Construct the API URL from your Mirakl API base URL (from your credential) and the API path, for example https://[HOSTNAME]/api/sellerpayment/transactions_logs?date_created_from=2021-09-24T14:49:47Z&date_created_to=2021-09-25T14:49:47Z&limit=100. Set the Response Data Path to $.data[*] to extract all items from the data array returned by Mirakl API responses. The Mirakl API uses token-based pagination with next_page_token — specify page_token as the token parameter name and $.next_page_token as the response path to the next page token.

Once all of the relevant settings have been configured, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.