OR41 - List messages of an order

OR41 - List messages of an order
⚠️ No Integration Allowed ⚠️

deprecated

Request

Deprecated endpoint

This API is going to be permanently removed on April 5 2027, please use M10 and M11 instead.

Description

By default, all sent and received messages are listed

Call Frequency

Recommended usage: On each message page view

Maximum usage: On each message page view

Pagination

This resource supports offset pagination (see documentation)

Sort fields

sort field can have the following values:

dateCreated (Default) - Sort by creation date (desc by default)

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMIN)

Path

order_idstringrequired

Order identifier

Query

receivedstring

If "TRUE" ("FALSE") returns only messages received by (sent to) shop.

Default:"ALL"

Enum:"TRUE""FALSE""ALL"

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/orders/{order_id}/messages?received=TRUE&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

messagesArray of objectsrequired

List of messages

total_countinteger, (int32)required

Total count of messages

Response

{
  "messages": [
    { … }
  ],
  "total_count": 1
}