Sign in
latestOpenAPI 3.1.02026-08-1828105315.1 KB

cc009fec5cdd

Conversations

listConversations - List all order conversations

<div class="extension-title">Description</div>

Use this API to synchronize Mirakl Connect conversations with your system.

<div class="api-description-extension"> <div class="extension-title">Pagination</div> <p>This resource supports seek pagination (<a href="#section/Seek-pagination-and-sort">see documentation</a>)</p> <div class="extension-title">Sort fields</div>

<code>sort</code> field can have the following values:<ul><li><b>updated_at</b> (Default) - Sort by date time of last conversation modification in Mirakl Connect (desc by default)</li></ul>

</div>
get/conversations

Query parameters

page_tokenstring

Token to access the next or previous page

limitinteger

Maximum number of listed conversations

updated_fromstring date-time
Example:2026-01-04T08:30:00Z

Select conversations that were last updated in Mirakl Connect from the specified date time. Required when conversation_ids is not provided.

entity_type'ORDER'

Type of the entity linked to the conversation. Should be used with entity_ids.

entity_idsstring[]

List of unique identifiers of the entities linked to the conversation. Should be used with entity_type.

conversation_idsstring[]

List of conversation IDs to retrieve. Required when updated_from is not provided.

Response

List of conversations matching the filter parameters

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Example response

{
  "data": [
    {
      "anonymized_at": "2024-01-02T13:00:00.000Z",
      "created_at": "2024-01-02T12:13:14.567Z",
      "entity": {
        "channel_entity_id": "MIR-F745HNL8-A",
        "id": "0054_MIR-F745HNL8-A"
      },
      "participants": [
        {
          "id": "123456",
          "name": "Marketplace 1",
          "type": "CHANNEL"
        }
      ],
      "topic": {
        "value": "Hello, I have a question about my order"
      },
      "updated_at": "2024-01-02T12:42:00.667Z"
    }
  ]
}