Skip to main content
Español (España) 简体中文

Where to find Mirakl API documentation

  • Updated

 

In this article, we explain where to find the official Mirakl API documentation and what information you will find in each technical API page.

Important: APIs require technical knowledge or support from your integration team. Before developing a connection, always review the official Mirakl documentation.
Contents
  1. What API documentation is used for
  2. How to access it from Mirakl
  3. Official Mirakl resources
  4. How to search for a specific API
  5. What information an API page includes
  6. Before integrating via API
  7. Summary
1️⃣ What API documentation is used for

Mirakl APIs allow you to automate processes between your system and the Marketplace platform.

You can use them to retrieve or update information related to offers, orders, documents, invoices or other processes available in the official documentation.

2️⃣ How to access it from Mirakl

In Mirakl, you can access help from the help icon located at the top right of the screen.

  1. Log in to your seller account in Mirakl.
  2. Select the help icon at the top right.
  3. Use the search bar to find API-related documentation.
  4. Open the relevant result and review the technical information.
Keep in mind: some technical content may require you to log in or have specific permissions.
3️⃣ Official Mirakl resources

You can consult the official documentation through these resources:

Remember: if you need to review all APIs available for sellers, use the Seller APIs index. Do not use the URL of a specific API, such as offers, orders or invoices, as a general API index.
4️⃣ How to search for a specific API

If you need to locate a specific API, use the search bar in the Mirakl Help Center or Developer Portal.

  1. Access the Help Center or the Developer Portal.
  2. Enter the process you want to automate.
  3. Filter or review results related to Seller APIs.
  4. Open the relevant API and review the full documentation.

You can search for terms such as:

  • Offers, to work with offers.
  • Orders, to work with orders.
  • Documents, to work with documents.
  • Accounting, for accounting information available through API.
  • Invoices, for invoice-related processes when available.
5️⃣ What information an API page includes

The information may vary depending on the API, but you will usually find:

  • API code or name: technical identifier of the operation, such as orders, offers or documents.
  • Description: explanation of what the API is used for.
  • Call frequency: recommended usage and usage limits when defined.
  • Endpoint: technical path used by the integration.
  • Method: call type, such as GET, POST, PUT or DELETE.
  • Pagination: how to browse results when the API returns many records.
  • Parameters: filters or fields that can be sent in the request.
  • Response fields: data structure returned by the API.
  • Allowed values: accepted statuses, codes or enumerations.
  • Examples or schemas: sample calls or response structures to support implementation.
  • Technical notes: warnings about deprecated fields, localisation, permissions or recommended alternatives.
Example of an API technical page in Mirakl

Example image: the API shown may not match the API you need to implement. Use it only as a visual reference of how technical documentation is displayed.

Important: always check whether the API belongs to the Seller environment and whether it applies to the action you want to automate. Not all APIs are available for every user type or permission level.
6️⃣ Before integrating via API

Before developing an integration, review these points:

  • Objective: define which process you want to automate.
  • Permissions: check that your user or integration has access to the required information.
  • Credentials: manage keys or access tokens securely.
  • Environment: confirm whether you are working in test or production.
  • Volume: check whether the API recommends asynchronous exports for large data volumes.
  • Errors: prepare proper error handling, retries and logs.
Security: do not share keys, tokens or credentials by email, messages or unsecured channels. If you have doubts, consult your technical team before continuing.
7️⃣ Summary
  • Mirakl help is located at the top right: access it from the platform’s help icon.
  • Always use official documentation: Help Center, Developer Portal and Seller APIs index.
  • Each API may include different technical information: endpoint, method, frequency, parameters, pagination, responses and examples.
  • You need technical support: APIs require development, testing and secure credential management.
  • Avoid using a specific API as a general index: always search in the Seller APIs index or official search tool.

 

Related articles