> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/~/changes/J8IbZkP6ASUZu2oBhGi2/connectors-and-instances/patchworks-connectors/mirakl-prebuilt-connector.md).

# Mirakl (prebuilt connector)

## Description

**Mirakl** eCommerce software provides online marketplace software to retailers, manufacturers and wholesalers.

## API documentation

API documentation for **Mirakl** (used to build this connector) can be found via the link below:

{% embed url="<https://help.mirakl.net/help/api-doc/operator/mmp.html#apiKeyAuthentication>" %}

{% hint style="info" %}
You must sign in with Mirakl credentials to access this documentation.
{% endhint %}

## Authentication&#x20;

When adding connector instances for **Mirakl**, the following authentication methods are supported:

* [Token authentication](#token-authentication)

### Token authentication

When a user chooses to [add a connector instance](/product-documentation/~/changes/J8IbZkP6ASUZu2oBhGi2/connectors-and-instances/working-with-instances/adding-an-instance.md) using **token** authentication, the credentials below are prompted:

<table><thead><tr><th width="193">Credential</th><th data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>URL</code></td><td>true</td><td>Your Mirakl marketplace URL in full - for example:<br><code>https://patchworksintegrationsuk-dev.mirakl.net</code></td></tr><tr><td><code>Front key</code></td><td>true</td><td>This is the API key generated from the Mirakl dashboard (user settings).</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/~/changes/J8IbZkP6ASUZu2oBhGi2/connectors-and-instances/patchworks-connectors/mirakl-prebuilt-connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.