How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mirakl Messages API

The Messages API from Mirakl — 9 operation(s) for messages.

Mirakl Messages API is one of 34 APIs that Mirakl publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Message. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 9 paths, and defines 58 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://your-instance.mirakl.net.

10 operations 9 paths 58 schemas 4 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://your-instance.mirakl.net
Authentication
HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 8

Mirakl Messages API declares 8 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Front-Bearer-Token). It supports OAuth 2.0 (OAuth-2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (Operator-Bearer-Token). It accepts HTTP bearer tokens (JWT) (operator_bearer_token). An API key is passed in the header as Authorization (Shop-API-Key). An API key is passed in the header as Authorization (shop_api_key). An API key is passed in the header as Authorization (front_api_key). An API key is passed in the header as Authorization (operator_api_key).

  • OAuth-2 — For more information, see our [Authentication System documentation](https://help.mirakl.com/docs/customers/page/topics/Mirakl/partnersintegration/authenticatio…

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 4 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Messages 10
GET
/api/messagesdeprecated
M01 - List messages linked to orders and offers
M01 9 params → 200
GET
/api/inbox/threads/{thread_id}
M10 - Retrieve a thread
M10 2 params → 200
GET
/api/inbox/threads
M11 - List all threads
M11 7 params → 200
POST
/api/inbox/threads
M14 - Create a thread with a seller
M14 body → 201
POST
/api/inbox/threads/{thread_id}/message
M12 - Reply to a thread
M12 1 param body → 201
GET
/api/inbox/threads/{attachment_id}/download
M13 - Download an attachment
M13 1 param → 200
POST
/api/orders/{order_id}/messagesdeprecated
OR42 - Post a message on an order
OR42 1 param body → 201
POST
/api/orders/{order_id}/threads
OR43 - Create a thread on an order
OR43 1 param body → 201
POST
/api/mms/services/{service_code}/threads
SOF43 - Create a thread on a service
SOF43 1 param body → 201
POST
/api/mms/orders/{order_id}/threads
SOR43 - Create a thread on a service order
SOR43 1 param body → 201

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are M01_Response_200_Messages (22 properties), M10_Response_200 (11 properties), M11_Response_200_Data (11 properties), OR42_Request (11 properties). Each schema is shown below with its type and property counts.

M12_Request_MultipartFormData_MessageInput_To
object
List of recipients of the message
2 properties 1 required
M11_Response_200_Data_Metadata_LastSender
object
3 properties 2 required
M11_Response_200_Data_CurrentParticipants
object
3 properties 2 required
M10_Response_200_NoStoreReplyNeeded
object
2 properties 2 required
M10_Response_200_Metadata_LastSender_OrganizationDetails
object
3 properties 2 required
M10_Response_200_Messages_From_OrganizationDetails
object
3 properties 2 required
M11_Response_200_Data_CustomerOrganization
object
2 properties 2 required
M11_Response_200_Data_Messages
object
6 properties 5 required
OR43_Response_201
object
2 properties 2 required
M01_Response_200
object
2 properties 2 required
M10_Response_200_Messages
object
6 properties 5 required
M10_Response_200_Messages_To
object
3 properties 2 required
OR43_Request_MultipartFormData_ThreadInput
object
3 properties 3 required
M11_Response_200_Data_Topic
object
2 properties 2 required
M11_Response_200_Data_Messages_From_OrganizationDetails
object
3 properties 2 required
M10_Response_200_Messages_From
object
3 properties 2 required
M11_Response_200_Data
object
11 properties 7 required
M10_Response_200_Entities
object
3 properties 3 required
M10_Response_200_CustomerOrganization
object
2 properties 2 required
OR42_Response_201
object
1 property 1 required
M10_Response_200_Topic
object
2 properties 2 required
M12_Request_MultipartFormData_MessageInput
object
3 properties 2 required
M11_Response_200_Data_AuthorizedParticipants
object
3 properties 2 required
M10_Response_200_CurrentParticipants
object
3 properties 2 required
M11_Response_200_Data_Entities
object
3 properties 3 required
M10_Response_200_AuthorizedParticipants
object
3 properties 2 required
M11_Response_200_Data_Messages_Attachments
object
3 properties 3 required
M10_Response_200_Messages_Attachments
object
3 properties 3 required
M11_Response_200_Data_NoStoreReplyNeeded
object
2 properties 2 required
OR42_Request
object
11 properties 9 required
M01_Response_200_Messages
object
22 properties 16 required
OR43_Request_MultipartFormData_ThreadInput_Topic
object
Thread topic The topic can either have a free or a fixed value depending on the topic type
2 properties 2 required
M11_Response_200_Data_Metadata_LastSender_OrganizationDetails
object
3 properties 2 required
M10_Response_200_Metadata_LastSender
object
3 properties 2 required
M12_Response_201
object
2 properties
M01_Response_200_Messages_Documents
object
5 properties 3 required
M11_Response_200_Data_Messages_From
object
3 properties 2 required
M11_Response_200_Data_Metadata
object
4 properties 4 required
M10_Response_200
object
11 properties 8 required
M12_Request_MultipartFormData_MessageInput_Topic
object
New topic for the thread. Leave empty if you don't want to update it.
2 properties
M11_Response_200
object
3 properties 1 required
M10_Response_200_Metadata
object
4 properties 4 required
M11_Response_200_Data_Messages_To
object
3 properties 2 required
M14_Request_MultipartFormData_ThreadInput
object
3 properties 3 required
M14_Request_MultipartFormData_ThreadInput_Entity
object
Entity related to the thread
2 properties 2 required
M14_Request_MultipartFormData_ThreadInput_Topic
object
Topic of the thread
2 properties
M14_Response_201
object
2 properties
M14_Request_MultipartFormData_ThreadInput_Entity_2
object
Entity related to the thread
1 property 1 required
OR42_Request_2
object
6 properties 5 required
SOR43_Request_MultipartFormData_ThreadInput_Topic
object
Thread topic The topic can either have a free or a fixed value depending on the topic type
2 properties 2 required
SOF43_Request_MultipartFormData_ThreadInput
object
4 properties 4 required
SOR43_Response_201
object
2 properties 2 required
SOF43_Request_MultipartFormData_ThreadInput_Customer
object
The customer that initiated the thread, if any
6 properties 4 required
SOF43_Response_201
object
2 properties 2 required
SOR43_Request_MultipartFormData_ThreadInput
object
3 properties 3 required
SOF43_Request_MultipartFormData_ThreadInput_Topic
object
Thread topic
2 properties 2 required
SOF43_Request_MultipartFormData_ThreadInput_2
object
3 properties 3 required
SOF43_Request_MultipartFormData_ThreadInput_3
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-messages-api-openapi.yml Raw ↑

Other APIs Mirakl publishes across the network.

Mirakl Carriers API
Mirakl Catalog Configuration API
Mirakl Incidents API
Mirakl Invoicing and Accounting API
Mirakl Multiple shipments API
Mirakl Offers API
Mirakl Orders API
Mirakl Picklists API
Mirakl Platform Settings API
Mirakl Product Feedback API
Mirakl Products API
Mirakl Promotions API
Where this information came from

This is an independent, third-party profile of Mirakl Messages API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.