Mirakl Marketplace Platform (MMP)
API Reference
The MMP suite offers a comprehensive set of REST APIs that facilitate a full spectrum of marketplace interactions. From creating offers and placing orders to rating transactions and managing incidents, our APIs are built to support a variety of use cases including e-commerce front-end integrations, and connections with Content Management Systems (CMS), seller automation tools... The API collection is structured around three primary user groups:
- Front APIs: Designed for machine-to-machine interactions, these APIs streamline integration between MMP and other systems such as e-commerce platforms, CMS tools…
- Operator APIs: These APIs are intended for use by marketplace operators. They require authentication with individual credentials linked to the operator's account, allowing for actions that reflect operator-level permissions.
- Seller APIs: Tailored for sellers, these APIs enable seller-specific operations within the marketplace environment.
To support your development efforts and ease the integration process, we provide Software Development Kits (SDKs) in both Java and PHP. Additionally, our APIs are documented in the OpenAPI format and are available as downloadable Postman collections, ensuring you have all the necessary tools at your fingertips for a smooth and efficient integration.
You are not authenticated, which means you may not have access to the full content of our documentation.
About the OpenAPI file content
The following types of APIs are excluded from the OpenAPI 3 file:
- Multipart APIs that have at least a file AND at least an object as input. This configuration is totally valid regarding HTTP standards, but the vast majority of OpenAPI code generators are not able to deal with this kind of APIs. As a result, code generators consider the whole OpenAPI 3 file as invalid, which prevents the code generation.
- APIs with dynamic URL. Some of our endpoints are not designed to be called directly: their URLs are dynamically built and returned as a result of a previous API call.
GraphQL
In addition to our RESTful services, MMP offers a GraphQL endpoint to enhance frontend integrations. This powerful API allows for optimized data retrieval and interactions, covering essential components such as orders, offers, threads, and shops. With both queries and mutations supported, developers can efficiently manage e-commerce data in a flexible and scalable manner.
Webhooks & Cloud Events
To facilitate seamless integration and enable real-time interaction capabilities, MMP provides robust HTTP Webhooks and Cloud Events features:
- HTTP Webhooks: These allow MMP to trigger calls to a developer-defined HTTP endpoint in response to events occurring within the Mirakl platform.
- Cloud Events: With Cloud Events, MMP can publish messages to a user-defined queue in major cloud services including AWS, GCP, and Azure. This service is ideal for developers looking to leverage cloud infrastructure for enhanced scalability and performance.