Skip to content
Products
/
/
/
OR12 - Get information ab...

OR12 - Get information about an order
⚠️ No Integration Allowed ⚠️
deprecated

Request

Deprecated endpoint

This API is going to be removed in a future update, please use OR11 with the query parameter 'order_ids' instead.

Call Frequency
Recommended usage: On each order page view
Maximum usage: On each order page view
Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMIN)
Path
order_idstringrequired

Order's identifier

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

Responses

OK

Bodyapplication/json
acceptance_decision_datestring, (date-time)required

The date when the shop decided to accept or refuse the order

commercial_idstringrequired

Commercial's identifier of the order

created_datestring, (date-time)required

Order's creation date

customerobject

Information of the customer who ordered

has_customer_messagebooleanrequired

Indicate if the customer has sent a message related to this order

has_incidentbooleanrequired

Indicate if order has an incident on at least one order line

has_invoicebooleanrequired

Is an invoice available for this order.

last_updated_datestring, (date-time)required

Last update date of the order

order_idstringrequired

Order's identifier

order_linesArray of objectsrequired

Order lines

order_statestringrequired

Order's state

Enum: "STAGING", "WAITING_ACCEPTANCE", "WAITING_DEBIT", "WAITING_DEBIT_PAYMENT", "SHIPPING", "SHIPPED", "TO_COLLECT", "RECEIVED", "CLOSED", "REFUSED", "CANCELED"

See deprecated values

Deprecated values: "WAITING_REFUND", "WAITING_REFUND_PAYMENT"

order_state_reason_codestringrequired

Reason code of the order state

order_state_reason_labelstringrequired

Reason label of the order state

payment_typestringrequired

Payment's type used by the customer to pay this order

pricenumber, (with decimals)required

Order's price (sum of order line price)

shipping_companystring

Shipping company

shipping_pricenumber, (with decimals)required

Order's shipping price (sum of order line shipping price)

shipping_trackingstring

Shipping tracking

shipping_tracking_urlstring

Shipping tracking url

shipping_type_codestringrequired

Code of shipping's type

shipping_type_labelstringrequired

Label of shipping's type

shipping_zone_codestringrequired

Code of shipping's zone

shipping_zone_labelstringrequired

Label of shipping's zone

total_commissionnumber, (with decimals)required

Order's total commission (sum of the order line total commission)

total_pricenumber, (with decimals)required

Order's total price (sum of the order price and the order shipping price)

paymentTypestringrequireddeprecated

Payment's type used by the customer to pay this order

This field has been replaced by "payment_type" and will be removed soon.

Response
{
  "acceptance_decision_date": "2019-04-15T14:29:22Z",
  "commercial_id": "MIR-YCCYX80B",
  "created_date": "2019-04-15T14:29:09Z",
  "customer": {
    "billing_address": { … },
    "civility": "Ms.",
    "customer_id": "689-03-2780",
    "firstname": "Donna",
    "lastname": "Ford",
    "shipping_address": { … }
  },
  "has_customer_message": false,
  "has_incident": false,
  "has_invoice": false,
  "last_updated_date": "2019-04-15T14:29:23Z",
  "order_id": "MIR-YCCYX80B-A",
  "order_lines": [
    { … },
    { … }
  ],
  "order_state": "SHIPPING",
  "order_state_reason_code": null,
  "order_state_reason_label": null,
  "payment_type": "Credit Card",
  "price": 60,
  "shipping_company": null,
  "shipping_price": 5,
  "shipping_tracking": null,
  "shipping_tracking_url": null,
  "shipping_type_code": "CLC",
  "shipping_type_label": "Click & collect",
  "shipping_zone_code": "DOM1",
  "shipping_zone_label": "Domestic 1",
  "total_commission": 10.01,
  "total_price": 65
}