Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Mirakl source in Nexla.
mirakl_api.png

Mirakl

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Mirakl connector tile from the list of available connectors. 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.

  3. In Nexla, Mirakl data sources can be created using pre-built endpoint templates, which expedite source setup for common Mirakl endpoints. Each template is designed specifically for the corresponding Mirakl endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Mirakl sources can also be configured manually, allowing you to ingest data from Mirakl endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

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.

Endpoint Settings​

  • 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.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & 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, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Mirakl data sources can be manually configured to ingest data from any valid Mirakl API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Mirakl sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Mirakl API from the Method pulldown menu. Mirakl API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Mirakl API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including your API base URL (from your credential), the API path (e.g., /api/sellerpayment/transactions_logs), and any required query parameters (e.g., https://[HOSTNAME]/api/sellerpayment/transactions_logs?date_created_from=2021-09-24T14:49:47Z&date_created_to=2021-09-25T14:49:47Z&limit=100). Include any required query parameters in the URL, such as date filters or pagination parameters.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Mirakl API uses token-based pagination with next_page_token for some endpoints. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Mirakl API responses, use $.data[*] to extract all items from the data array within the response.

The JSONPath expression must correctly reference the structure of your Mirakl API response. Mirakl API responses typically have a data property containing an array of resource objects. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. Mirakl API uses token-based pagination with next_page_token for some endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For token-based pagination, specify the token parameter name (page_token), and configure the response path to the next page token ($.next_page_token).

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, 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.