Mirakl API Documentation

This is the complete API documentation for connecting to the Mirakl API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Mirakl: connect business data and workflows through MindCloud's Universal API. Keep reading to get started.

Quickstart

Before you run your first Mirakl request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Mirakl connection — create or choose one in Connections. Note its connectionId.

Every Mirakl action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/mirakl/latest/actions/{actionSlug}

You need a MindCloud API Key and a Mirakl connection. Then call an action such as Get information about an offer:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/mirakl/latest/actions/get-information-about-an-offer" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Mirakl account that should run the action. MindCloud stores and refreshes the Mirakl credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

Mirakl actions

All 16 published actions for this Mirakl version. Each page documents the endpoint, arguments, and response controls.

• PUTAccept or refuse order lines
• POSTCreate shipments
• POSTCreate, update, or delete offers
• GETGet information about an offer
• GETGet Pricing Import Error Report
• GETList accounting documents
• GETList accounting documents requests
• GETList all carriers
• GETList Offer Imports
• GETList Offers
• GETList Orders
• GETList Pricing Imports
• GETList Shipments
• PUTUpdate carrier tracking information for a specific order
• PUTUpdate carrier tracking information for shipments
• PUTValidate shipments as shipped

Related apps

More apps on the Universal API, behind the same REST shape. Or browse all apps.

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionHubSpotGoogle Forms