List all threads

Mirakl Marketplace APIs (latest-release)

Servers

URL to be replaced by your Mirakl instance URL

https://your-instance.mirakl.net/

Stores

Operations

Platform Settings

Operations

Invoicing and Accounting

Operations

Products

Operations

Messages

Operations

Retrieve a thread

Request

Path

thread_idstringrequired

The identifier of the thread to retrieve.

Query

shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/inbox/threads/{thread_id}?shop_id=0'

Responses

Bodyapplication/json

authorized_participantsArray of objects(M10_Response_200_AuthorizedParticipants)

Thread authorized participants
Those are the participants who are authorized to join the thread.

current_participantsArray of objects(M10_Response_200_CurrentParticipants)

Thread current participants
Those are the participants who have actually participated in the thread, meaning that they are either sender or receivers of at least one message of the thread.
These participants must be on the list of the authorized_participants

customer_organizationobject(M10_Response_200_CustomerOrganization)

date_createdstring(date-time)

Thread created date

date_updatedstring(date-time)

Thread updated date

entitiesArray of objects(M10_Response_200_Entities)

Thread entities

idstring

Thread id

messagesArray of objects(M10_Response_200_Messages)

Thread messages

metadataobject(M10_Response_200_Metadata)

no_store_reply_neededArray of objects(M10_Response_200_NoStoreReplyNeeded)

Thread "no store reply needed" actions.

topicobject(M10_Response_200_Topic)

Response

application/json

{
  "authorized_participants": [
    { … }
  ],
  "current_participants": [
    { … }
  ],
  "customer_organization": {
    "display_name": "string",
    "id": "string"
  },
  "date_created": "2019-08-24T14:15:22Z",
  "date_updated": "2019-08-24T14:15:22Z",
  "entities": [
    { … }
  ],
  "id": "string",
  "messages": [
    { … }
  ],
  "metadata": {
    "last_message_date": "2019-08-24T14:15:22Z",
    "last_sender": { … },
    "shop_reply_needed_since": "2019-08-24T14:15:22Z",
    "total_count": 0
  },
  "no_store_reply_needed": [
    { … }
  ],
  "topic": {
    "type": "string",
    "value": "string"
  }
}

List all threads

Request

You may want to retrieve the threads linked to a specific entity, using both entity_type and entity_id.
For example, to retrieve threads for an order, use entity_type=MMP_ORDER&entity_id=my-order-1.
Available values for entity_type are:

MMP_ORDER: for threads on product orders
MMP_OFFER: for threads on offers
MPS_ORDER: for threads on service orders
MPS_SERVICE: for threads on services
SELLER_OPERATOR: for threads between sellers and operator

This resource uses seek pagination. The default value for parameter limit is 50.

Query

entity_typestring

Entity type to include in result (default: include all).
Available values: MMP_ORDER, MMP_OFFER, MPS_ORDER, MPS_SERVICE, SELLER_OPERATOR

entity_idArray of strings

Comma separated list of Entity id to include in result (default: include all).
The entity_type must be specified to use this filter, otherwise an error 400 will be returned.
Example of an entity_id query: entity_id=order1-A,order20-A,order13-A&entity_type=MMP_ORDER

updated_sincestring(date-time)

Retrieve threads modified at or after this date.

with_messagesboolean

True to include message details. Limited to the last 100 messages received on each thread.

Default false

channel_codesArray of strings

List of the channel codes to filter with, using a comma (,) as a separator.
If specified, only order messages linked to the given channels will be returned (Whatever the value of entity_type).
Otherwise, messages will be returned regardless of their channels.

shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

page_tokenstring

Token retrieved from next_page_token or previous_page_token to get to next

sortstring

How the results should be sorted. Must follow "sort=criterion,direction" format as described in Mirakl API Documentation

curl -i -X GET \
  'https://your-instance.mirakl.net/api/inbox/threads?channel_codes=string&entity_id=string&entity_type=string&page_token=string&shop_id=0&sort=string&updated_since=2019-08-24T14%3A15%3A22Z&with_messages=false'

Responses

Bodyapplication/json

dataArray of objects(M11_Response_200_Data)

Page of data

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.

Response

application/json

{
  "data": [
    { … }
  ],
  "next_page_token": "string",
  "previous_page_token": "string"
}

Download an attachment

Request

Path

attachment_idstringrequired

The identifier of the attachment to retrieve.

Query

shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/inbox/threads/{attachment_id}/download?shop_id=0'

Responses

Bodyapplication/octet-stream

string(binary)

Offers

Operations

Orders

Operations

Incidents

Operations

Picklists

Operations

Promotions

Operations

Returns

Operations

Multiple shipments

Operations