OR42 - Post a message on an order

OR42 - Post a message on an order
⚠️ No Integration Allowed ⚠️

deprecated

Request

Deprecated endpoint

This API will be removed in a future version. Use OR43 and M12 instead.

Description

Maximum of 1000 messages on a thread

Call Frequency

Recommended usage: At each new message posted on an order

Maximum usage: At each new message posted on an order

Path

order_idstringrequired

Order identifier

Bodyapplication/json

bodystring, [ 3 .. 50000 ] charactersrequired

Body of the message

customer_emailstringrequired

Email of the customer who sent the message.
Required only if the customer sent the message. Otherwise, do not define.

customer_firstnamestringrequired

First name of the customer who sent the message. Required only if the customer sent the message. Otherwise, do not define.

customer_idstringrequired

Id of the customer who sent the message. Required only if the customer sent the message. Otherwise, do not define.

customer_lastnamestringrequired

Last name of the customer who sent the message. Required only if the customer sent the message. Otherwise, do not define.

customer_localestring

Locale of the customer who sent the message

document_idsArray of integers, (int64)

Message's attachments. List of document ids already linked to the order. Use OR74 to upload new documents and OR72 to retrieve their ids. NB: If one of those document_id have already been linked to a previous message, it will be ignored.

subjectstring, [ 3 .. 200 ] charactersrequired

Subject of the message

to_customerbooleanrequired

Boolean to indicate the message will be sent to the customer associated with the order.

to_operatorbooleanrequired

Boolean to indicate the message will be sent to the operator.

to_shopbooleanrequired

Boolean to indicate the message will be sent to the shop associated with the order

curl -i -X POST \
  'https://your-instance.mirakl.net/api/orders/{order_id}/messages' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "body": "I don'\''t receive my product! Could you please tell me when should i received it?",
    "customer_email": "customer@mail.com",
    "customer_firstname": "Smith",
    "customer_id": "Customer_id_001",
    "customer_lastname": "Taylor",
    "customer_locale": "en_EN",
    "document_ids": [
      "2032"
    ],
    "subject": "Item not received",
    "to_customer": false,
    "to_operator": false,
    "to_shop": true
  }'

Responses

Created

Bodyapplication/json

idinteger, (int64)required

Identifier of the message created

Response

{
  "id": 2038
}