Mirakl API Documentation and PrestaShop Integration Guide

Authorised applications can exchange information with a Mirakl marketplace environment through the seller APIs available for that marketplace. Depending on the seller APIs available for a marketplace, this can include product imports, offers, orders, order-related messages, shipments, and tracking information.

Mirakl Connect’s wider ecosystem currently includes more than 450 marketplace channels. This figure describes Mirakl’s wider ecosystem. It does not mean that one seller account, API key, or PrestaShop configuration automatically provides access to every marketplace in that network.

To connect PrestaShop with a Mirakl marketplace, first understand the operator-specific seller environment, the required API credentials, the applicable seller API resources, and the workflows supported by the Common Services Mirakl module.

Quick answer: Mirakl provides commerce technology used by separate marketplace operators. A merchant normally needs access to the relevant marketplace environment, a valid API key, and marketplace-specific settings before connecting it with PrestaShop.

What Is Mirakl?

Mirakl provides technology that companies use to operate online marketplaces, dropship programmes, and related commerce services. Its Marketplace Platform is intended for retailers, distributors, manufacturers, and business-to-business organisations running marketplace programmes.

The marketplace operator controls its commercial environment. It decides:

• which sellers may participate;
• which categories are available;
• which product fields are required;
• which delivery and return rules apply;
• which seller-service standards must be followed;
• which features are available to the seller account.

Mirakl supplies technology used for areas such as seller onboarding, catalogs, offers, marketplace orders, shipment information, customer-care workflows, and reporting.

Mirakl is therefore not one consumer marketplace where a merchant opens a universal account and sells through every operator using its technology.

A seller approved by one marketplace should not assume that the same credentials, categories, mappings, or operating rules apply to another marketplace.

Important: “Powered by Mirakl” describes the underlying technology. It does not mean every Mirakl marketplace uses identical seller rules or technical settings.

Which Marketplaces Use Mirakl?

Examples associated with Mirakl technology or represented in Common Services module configurations include:

Main market	Examples
France	Galeries Lafayette, Darty, E.Leclerc, Leroy Merlin
Spain	Carrefour Spain, El Corte Inglés, PcComponentes
Portugal	Worten
United Kingdom	B&Q
Canada	Best Buy Canada
United States	Macy’s
Belgium	Vanden Borre
Germany	Conrad, Metro
Brazil	Carrefour Brazil, Leroy Merlin Brazil
Other Latin American markets	Liverpool, Ripley
Business and specialist marketplaces	ABB, Avnet, Siemens Mobility, Toyota Material Handling

Before planning a connection, confirm directly with the marketplace:

• whether it is accepting applications;
• whether your business location is eligible;
• whether your product category is supported;
• which seller requirements apply;
• whether you have access to its Mirakl environment;
• whether the required configuration is available in the module.

A marketplace may use Mirakl technology while maintaining an invitation-only or category-restricted seller programme.

How Mirakl Works for Sellers

A seller normally begins with the marketplace operator, not by opening one universal Mirakl seller account.

The operator manages its seller programme and provides access to the relevant marketplace environment. The exact application, approval, tax, logistics, and compliance process belongs to that operator.

For a technical connection, the merchant generally needs:

• access to the applicable Mirakl back office;
• the marketplace address;
• an API key from an authorised user;
• product and offer settings;
• order and transport settings;
• marketplace-specific profiles and mappings.

Each Mirakl marketplace connection in the Common Services module requires an API key. Marketplaces configured through the module remain independent and keep their own configurations, offers, and orders.

A connector can reduce repeated exchanges between a marketplace and PrestaShop. It does not replace seller approval, marketplace credentials, product preparation, or marketplace-specific configuration.

Mirakl Nexus, Mirakl Connect, and the Seller Back Office

These names refer to different products or environments.

Mirakl Seller Back Office

The marketplace back office is the operator-specific environment used by a seller.

Generate the API key in the seller back office for the specific marketplace being connected.

The exact screens and available features can vary by marketplace.

Mirakl Connect

Mirakl Connect is Mirakl’s multichannel selling product for brands and sellers.

Mirakl Connect is a multichannel selling product for brands and sellers. It supports catalogue preparation, orders, inventory, pricing, customer messages, and marketplace discovery across supported channels.

Mirakl Connect should not be used as a generic name for every operator’s Mirakl seller back office.

Mirakl Nexus

Mirakl Nexus is not the standard marketplace seller portal.

Mirakl Nexus provides infrastructure for agentic commerce. Its scope includes product discovery, transaction processing, pricing and inventory accuracy, fulfilment, refunds, and after-sales workflows involving AI-driven commerce platforms.

A merchant using an individual marketplace back office is not automatically using Mirakl Nexus.

Mirakl Developer Portal

The Mirakl Developer Portal contains technical references for different Mirakl products, roles, and API areas.

Term	Documented purpose
Marketplace back office	Access an operator-specific marketplace environment
Mirakl Connect	Manage multichannel selling across supported channels
Mirakl Nexus	Support agentic-commerce infrastructure
Mirakl Developer Portal	Access official technical API documentation

Use the Mirakl Nexus overview when evaluating agentic-commerce integrations rather than ordinary marketplace seller access.

Getting Marketplace Access and an API Key

API access normally follows access to the marketplace’s seller environment. The public Developer Portal does not replace a seller account issued or approved through a marketplace operator.

1. Obtain Access to the Marketplace

Follow the application or onboarding process provided by the marketplace operator.

Because operators manage separate programmes, the requested company, product, tax, shipping, and service information can vary.

2. Complete the Marketplace Settings

After receiving access, review the marketplace’s seller settings.

Depending on the operator, these may cover:

• company information;
• shipping origin;
• preparation times;
• carriers;
• return information;
• marketplace contacts;
• catalog requirements.

3. Generate the API Key

Generate the API key in the relevant marketplace seller back office:

1. Sign in to the relevant Mirakl back office.
2. Select the user name in the upper-right corner.
3. Open the user settings.
4. Select the API key tab.
5. Generate or copy the API key.

If the screen labels differ in your marketplace environment, follow the current Common Services API-key instructions.

4. Record the Marketplace Address

The connection also needs the address of the applicable marketplace environment.

Make sure the marketplace address and API key belong to the same account and operator.

5. Protect the Credentials

Treat the API key like a password.

Do not place it in:

• public screenshots;
• public code repositories;
• published articles;
• unsecured spreadsheets;
• unprotected support messages.

Replace the key in connected systems if the marketplace key is regenerated.

Security reminder: The Marketplace seller API requires API-key authentication and HTTPS requests.

Understanding the Mirakl API Documentation

The official Mirakl API documentation is available through the Mirakl Developer Portal.

The portal includes several products, roles, and API groups. Before using an endpoint or field, confirm that you are reading the correct documentation for:

• the Mirakl product;
• the seller role;
• the required API area;
• the functionality available to your marketplace environment.

Marketplace seller API requests use an API key in the Authorization header and must use HTTPS. The API uses standard HTTP return codes and applies endpoint-specific rate limits.

Products and Offers

Product information and seller offers are related but separate.

Product information describes the catalog item. Depending on the marketplace template, this may include:

• an identifier;
• title;
• description;
• brand;
• category;
• attributes;
• images.

Offer information represents the seller’s commercial offer for that product. It may include values such as:

• seller reference;
• price;
• quantity;
• condition;
• preparation time.

The seller APIs provide separate resources for product imports and offer imports. The Common Services module likewise separates catalogue-file generation from real-time offer export.

An offer should not be assumed to create a product that the marketplace does not yet recognise.

Offer Import Resources

The seller API includes resources for submitting offer imports and retrieving their processing status and associated error information.

Before implementation, confirm endpoint names, status values, and rate limits in the current seller API reference.

Product Import Resources

The seller API also includes resources for checking product-import processing.

When a product import returns an error, review the available status or report before modifying the source data.

Sending the same invalid data repeatedly will not correct a missing or unsupported field.

Orders

The Marketplace seller API includes resources for listing seller orders and performing documented order-related operations.

The exact actions available can depend on:

• the endpoint;
• the current order state;
• seller permissions;
• the marketplace configuration.

Do not assume that an operation supported in one Mirakl environment will behave identically in another without checking the current documentation.

Order-Related Messages

The seller API includes resources for accessing messages associated with an order.

For accuracy, these should be described as order-related messaging resources, not as one universal standalone Messages API with identical behavior across every marketplace.

Follow the operator’s communication rules when retrieving or sending messages.

Shipments and Tracking

The seller API includes shipment resources, including multiple-shipment workflows.

Depending on the documented resource, shipment information can include:

• shipment records;
• carrier information;
• tracking numbers;
• tracking URLs;
• more than one shipment for an order.

Carrier values and permitted shipment states can vary. Check the applicable marketplace documentation before processing live orders.

Rate Limits and HTTP 429

Mirakl applies rate limits to its APIs. If an integration exceeds an applicable limit, it may receive an HTTP 429 response.

An HTTP 429 response can include a Retry-After header indicating how many seconds the application should wait before making another request.

A connector or custom development should follow that guidance rather than sending unlimited immediate retries.

Recommended Integration Logs

For a custom integration or support workflow, record:

Record:

• the marketplace;
• date and time;
• product or order reference;
• operation attempted;
• response status;
• returned error;
• retry result.

This makes it easier to connect an API result with the product, order, or scheduled task that produced it.

Developer tip: Begin with one request or a small import. Confirm the result before scheduling large recurring jobs.

Connecting Mirakl With PrestaShop

The Common Services Mirakl module for PrestaShop currently supports:

• real-time offer export through web services;
• real-time marketplace order import;
• creation of marketplace orders in the PrestaShop back office;
• order-status updates;
• tracking-number updates;
• catalog export in Mirakl’s standard format.

The module is also available through the official PrestaShop Addons marketplace.

Product-Creation Limitation

The module does not include its own product-creation tool.

It can generate a catalog file containing PrestaShop products, attributes, and features for use with the marketplace’s catalog process.

This means:

• catalog data describes the product;
• offer data represents the seller’s commercial offer.

Product onboarding, category mapping, and real-time offer export should not be treated as one identical workflow.

Module Configuration Areas

The module includes configuration areas for:

• marketplace information;
• authentication;
• profiles;
• categories;
• transport;
• orders;
• general settings;
• filters;
• scheduled tasks.

The authentication area is used for the marketplace API key. Profiles and categories help prepare marketplace-specific data and selection.

Recommended Setup Sequence

Use the following setup sequence:

1. Confirm that the intended marketplace configuration is available.
2. Obtain the marketplace address and API key.
3. Enter the connection information.
4. Configure the required profiles.
5. Select the intended categories.
6. Configure transport and order settings.
7. Review filters and general preferences.
8. Test a small offer group.
9. Test an eligible marketplace order.
10. Confirm supported status and tracking updates.
11. Enable scheduled tasks after manual tests work as intended.

Installing the module does not create a seller account or guarantee marketplace approval.

Already have marketplace access and an API key? Review the Common Services Mirakl module to see which supported offer, order, status, and tracking workflows can connect with PrestaShop.

Product Data Across Mirakl Marketplaces

Mirakl supplies shared technology, but marketplace operators can use different categories, fields, languages, and accepted values.

Marketplace channels can require different categories, attributes, images, languages, and content limits.

For this reason, a product accepted by one marketplace should not automatically be assumed to meet another marketplace’s requirements.

Before testing a catalog, review:

• PrestaShop product references;
• identifiers requested by the marketplace;
• category selection;
• required attributes;
• variations;
• images;
• language requirements;
• marketplace profiles;
• price and quantity.

These preparation checks are not a universal list of mandatory fields. Each marketplace can require a different set of product information.

Follow the marketplace’s current template and review its import report to identify required or rejected product data.

Order and Fulfilment Flow

The Common Services Mirakl module can import eligible marketplace orders through web services, create them in the PrestaShop back office, and send supported order-status and tracking updates.

A simplified workflow is:

1. An eligible marketplace order becomes available.
2. The module imports the order.
3. The order is created in PrestaShop.
4. The merchant processes the order.
5. The applicable status and tracking information are added or updated.
6. The module sends supported updates to the marketplace.

The marketplace operator controls its own rules for order acceptance, cancellation, returns, refunds, and fulfilment.

Do not apply one marketplace’s process to another without checking the applicable operator documentation.

For broader warehouse and shipping planning, compare marketplace fulfilment, third-party logistics, and merchant-managed warehouse models in European fulfilment guide.

Managing Multiple Mirakl Marketplaces

The Common Services Mirakl module can manage several marketplaces that use the Mirakl platform. Each marketplace remains independent and keeps its own configuration, offers, and orders.

A multi-marketplace setup may therefore require separate:

• API keys;
• marketplace addresses;
• profiles;
• category selections;
• offer settings;
• order settings;
• scheduled tasks.

Do not assume that a working configuration for one marketplace should be copied unchanged to another.

Before adding another marketplace, prepare its API key, marketplace address, profiles, category selections, offer settings, order settings, and scheduled tasks separately. Read more here multi-marketplace documentation.

A practical recommendation is to stabilise one marketplace before configuring the next. This makes marketplace-specific reports and errors easier to isolate.

Common Integration Challenges

Problem	What to check
API authentication fails	Confirm that the API key and marketplace address belong to the same environment
A key was regenerated	Replace the previous key in the connected module or application
A product import is rejected	Review the documented product-import status and available report
An offer import is rejected	Review the applicable offer-import status or error information
The API returns HTTP 429	Wait for the period indicated by the Retry-After header
Orders do not appear	Check the marketplace order state, module settings, and import output
Tracking is rejected	Review the applicable shipment resource, carrier values, and order state
One marketplace works while another fails	Review the second marketplace’s independent credentials and configuration

Troubleshooting tip: Read the API response, marketplace report, or module output before changing several settings. Change one item at a time so its effect remains visible.

Frequently Asked Questions

Connect Supported Mirakl Workflows With PrestaShop

Managing marketplace offers, orders, statuses, and tracking in separate systems can add repetitive work as the number of channels grows.

Connect supported Mirakl marketplace workflows with your PrestaShop store using the Common Services module.

The Common Services Mirakl module supports real-time offer export, eligible marketplace order import, order creation in PrestaShop, and supported order-status and tracking updates.

Review the Mirakl module for PrestaShop and confirm that your marketplace, credentials, catalog process, and required configuration are supported before deployment.

Confirm that the Common Services Mirakl module supports your intended marketplace, credentials, catalogue process, and required configuration before deployment.