Orders
/
Get the evaluation of an order

Mirakl Marketplace APIs (latest-release)

Languages
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

Offers

Operations

Orders

Operations

Adjust order line

Request

Update order line actual measurement: it will create a refund or cancelation associated to the order line.

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.

Bodyapplication/json
order_linesArray of objects(OR32_Request_OrderLines)[ 1 .. 100 ] items

Order lines to be updated, maximum number of order lines per call: 100

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/orders/adjust?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_lines": [
      {
        "actual_measurement": 0,
        "order_line_id": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
order_lines_adjustedArray of objects(OR32_Response_200_OrderLinesAdjusted)

A list of updated order lines and orders in error objects

Response
application/json
{
  "order_lines_adjusted": [
    { … }
  ]
}

Get the evaluation of an order

Request

Path
order_idstringrequired
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.

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/orders/{order_id}/evaluation?locale=string&shop_id=0'

Responses

OK

Bodyapplication/json
assessmentsArray of objects(OR51_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(OR51_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
}

Lists order's documents

Request

Returns a list of all the documents available on the order

Query
order_idsstring<= 100

the orders' identifiers, using comma as separator

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/documents?order_ids=string&shop_id=0'

Responses

OK

Bodyapplication/json
order_documentsArray of objects(OR72_Response_200_OrderDocuments)

The document details

Response
application/json
{
  "order_documents": [
    { … }
  ]
}

Incidents

Operations

Picklists

Operations

Promotions

Operations

Returns

Operations

Multiple shipments

Operations