Orders
/
Accept an order in <code>WAITING_ACCEPTANCE</code> state

Mirakl Platform for Services APIs (latest-release)

Languages
Servers
URL to be replaced by your Mirakl instance URL
https://your-instance.mirakl.net/

Platform Settings

Operations

Invoicing and Accounting

Operations

Stores

Operations

Services

Operations

Orders

Operations

Update an order

Request

Note: closed or cancelled order cannot be updated.

Path
order_idstringrequired

The identifier of the order to be updated

Bodyapplication/json
bookingobject(SOR04_Request_Booking)

Booking information to update for this order.

custom_attribute_valuesArray of objects(SOR04_Request_CustomAttributeValues)

Order custom attribute values to update.
Only specified custom attribute values will be updated. In order to delete a custom attribute value, set it to null.

priceobject(SOR04_Request_Price)

New price for this order.

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/mms/orders/{order_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "booking": {
      "type": "string"
    },
    "custom_attribute_values": [
      {
        "code": "string",
        "type": "string",
        "value": {}
      }
    ],
    "price": {
      "options": [
        {
          "code": "string",
          "type": "string"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
bookingobject(SOR04_Response_200_Booking)
can_evaluateboolean

Indicates if the order can be evaluated by the customer

commercial_order_idstring

Order commercial ID

commissionobject(SOR04_Response_200_Commission)
consumptionobject(SOR04_Response_200_Consumption)
currency_codestring

Order currency ISO Code

custom_attribute_valuesArray of objects(SOR04_Response_200_CustomAttributeValues)

Custom attribute values defined on the order

customerobject(SOR04_Response_200_Customer)
date_acceptedstring(date-time)

Order acceptance date

date_createdstring(date-time)

Order creation date

date_updatedstring(date-time)

Order last modification date

has_open_incidentboolean

true if order has an incident open

idstring

Order ID

imprint_numberstring

Order imprint number

locationobject(SOR04_Response_200_Location)
payment_typestring

Order payment type

priceobject(SOR04_Response_200_Price)
refundsArray of objects(SOR04_Response_200_Refunds)

The list of refunds, sorted by creation date in ascending order

serviceobject(SOR04_Response_200_Service)
shopobject(SOR04_Response_200_Shop)
statestring

Order state

warningsArray of strings

A list of warnings that should be checked before validating the order

workflowobject(SOR04_Response_200_Workflow)
Response
application/json
{
  "booking": {
    "type": "string"
  },
  "can_evaluate": true,
  "commercial_order_id": "string",
  "commission": {
    "amount_excluding_taxes": 0,
    "amount_including_taxes": 0,
    "commission_taxes": [ … ]
  },
  "consumption": {
    "type": "string"
  },
  "currency_code": "string",
  "custom_attribute_values": [
    { … }
  ],
  "customer": {
    "billing_address": { … },
    "civility": "string",
    "email": "string",
    "first_name": "string",
    "id": "string",
    "last_name": "string",
    "locale": "string",
    "phone_number": "string"
  },
  "date_accepted": "2019-08-24T14:15:22Z",
  "date_created": "2019-08-24T14:15:22Z",
  "date_updated": "2019-08-24T14:15:22Z",
  "has_open_incident": true,
  "id": "string",
  "imprint_number": "string",
  "location": {
    "type": "string"
  },
  "payment_type": "string",
  "price": {
    "options": [ … ],
    "type": "string"
  },
  "refunds": [
    { … }
  ],
  "service": {
    "category": { … },
    "code": "string",
    "custom_attribute_values": [ … ],
    "description": "string",
    "medias": [ … ],
    "model": { … },
    "title": "string"
  },
  "shop": {
    "id": 0,
    "name": "string"
  },
  "state": "string",
  "warnings": [
    "string"
  ],
  "workflow": {
    "type": "string"
  }
}

Accept an order in <code>WAITING_ACCEPTANCE</code> state

Request

Path
order_idstringrequired

The identifier of the order to be accepted.

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/mms/orders/{order_id}/accept'

Responses

No Content

Refuse an order in <code>WAITING_ACCEPTANCE</code> state

Request

Path
order_idstringrequired

The identifier of the order to be refused.

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/mms/orders/{order_id}/refuse'

Responses

No Content

Consume an order in <code>ORDER_PENDING</code> state

Request

Path
order_idstringrequired

The identifier of the order to be consumed.

Bodyapplication/json
date_consumedstring(date-time)

Service consumption date. Required only when the Order consumption must be confirmed by Shop

voucher_codestring

Service voucher code. Required only when the Order consumption requires a voucher

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/mms/orders/{order_id}/consume' \
  -H 'Content-Type: application/json' \
  -d '{
    "date_consumed": "2019-08-24T14:15:22Z",
    "voucher_code": "string"
  }'

Responses

No Content

Get the evaluation of an order

Request

Path
order_idstringrequired
Query
localestring

<ISO-639>_<ISO-3166> ("en_US") or <ISO-639> ("en") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/mms/orders/{order_id}/evaluation?locale=string'

Responses

OK

Bodyapplication/json
assessmentsArray of objects(SOR51_Response_200_Assessments)

List of assessments

commentstring

Evaluation comment

customer_idstring

Identifier of the customer who posted the evaluation

datestring(date-time)

Evaluation creation date

firstnamestring

First name of the customer who posted the evaluation

gradeinteger(int32)

Evaluation grade

last_updated_datestring(date-time)

Evaluation last updated date

lastnamestring

Last name of the customer who posted the evaluation

replyobject(SOR51_Response_200_Reply)
visibleboolean

Whether the evaluation is visible or not

Response
application/json
{
  "assessments": [
    { … }
  ],
  "comment": "string",
  "customer_id": "string",
  "date": "2019-08-24T14:15:22Z",
  "firstname": "string",
  "grade": 0,
  "last_updated_date": "2019-08-24T14:15:22Z",
  "lastname": "string",
  "reply": {
    "comment": "string",
    "date": "2019-08-24T14:15:22Z",
    "type": "string"
  },
  "visible": true
}