(Quick Reference)
Service: Show an operation (order, pre-order, invoice, delivery note or delivery)
Description: Returns the requested operation in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/orders/{id}:
https://BASE_URL/api/VERSION/orders/reference/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The ID of the desired operation | Long/String | yes | 123 |
Success Output
Success case: response.status = 200
{
"id": 5,
"operationType": "ORDER",
"reference": "marie_order_2014_12_20",
"status": "PAID",
"latitude": 29.932,
"longitude": 12.101,
"checkInDate": null,
"total": 1572,
"totalExclTax": 1572,
"totalDiscounted": 1572,
"discount": null,
"taxAmount": null,
"shippingFee": 7,
"paymentDate": "2014-12-20T23:00:00Z",
"paymentTypeId": 8,
"paymentType": {
"id": 8,
"reference": "CHEQUE",
"name": "Cheque",
"href": "/api/v1.0/paymentTypes/8"
},
"advanceAmount": null,
"orderPayments": [
{
"id": 5,
"reference": "5_8_2014_12_20",
"href": "/api/v1.0/orderPayments/5"
}
],
"dueDate": null,
"customerReference": "C0959",
"customer": {
"id": 5,
"reference": "C0959",
"reference2": null,
"name": "Marie's Jewelry",
"href": "/api/v1.0/customers/5"
},
"currency": "EUR",
"exchangeRate": 1,
"employeeReference": "emp-04",
"user": {
"id": 4,
"reference": "emp-04",
"href": "/api/v1.0/users/4"
},
"deliveryStatus": "DELIVERED",
"deliveryDate": "2014-12-20T23:00:00Z",
"deliveryComment": null,
"deliveryCountry": "FR",
"deliveryCity": "Paris",
"deliveryPostalCode": null,
"deliveryAddress": null,
"orderLines": [
{
"id": 5,
"href": "/api/v1.0/orderDetails/5"
}
],
"pdfUrl": "https://BASE_URL/entity1-1450169988465/orderPDF/4_marie_order_2014_12_20.pdf",
"organization": "entity1",
"dateCreated": "2014-12-20T23:00:00Z",
"lastUpdated": "2014-12-20T23:00:00Z",
"deliveredBy": {
"id": 5,
"reference": "emp-06",
"href": "/api/v1.0/users/5"
},
"desiredDeliveryDate" : "2015-08-16T23:00:00Z",
"deliveredOn" : "2015-05-18T21:00:00Z",
"assignmentDate" : "2015-03-21T23:00:00Z"
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The order with the id 7065 doesn't exist."
}
