(Quick Reference)
Service: Show an order detail
Description: Returns the requested order detail in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/orderDetails/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired order detail | Long | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 5,
"operationType": "ORDER",
"orderReference": "marie_order_2014_12_20",
"order": {
"id": 5,
"reference": "marie_order_2014_12_20",
"href": "/api/v1.0/orders/5"
},
"itemReference": "bracelet-GRP09062",
"unitReference": "pcs",
"item": {
"id": 495,
"reference": "bracelet-GRP09062",
"name": "Knot Band Bracelet",
"href": "/api/v1.0/items/495"
},
"unit": {
"id": 1,
"reference": "pcs",
"name": "pieces",
"href": "/api/v1.0/units/1"
},
"discount": 0,
"customerDiscount": null,
"finalPrice": 1572,
"unitPrice": 26.2,
"tax": 0,
"quantity": 60,
"type": "REGULAR",
"comment": null,
"soldSerialNumbers": null,
"organization": "entity1",
"dateCreated": "2015-06-28T23:00:00Z",
"lastUpdated": "2015-06-28T23:00:00Z"
} Failure Output
Failure case:response.status = 404
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}
