(Quick Reference)
62 Operation lines - Reference Documentation
Version: 2.1
62 Operation lines
62.1 List
Service: List order details Description: This web service return the list of order lines in JSON format. URL: https://BASE_URL/api/VERSION/orderDetails : GET Parameters: Pagination parameters: | Name | Description | Type | Required | Possible values |
|---|
| offset | Tells where to start returning records from the entire set of results. | Integer | No | | | max | Limits the number of resources requested to return. | Integer | No | | | sort | Orders the results by the specified field. | String | No | | | order | Orders ascending or descending | Integer | No | asc, desc |
Filters parameters: | Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z | | dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | | | dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | | | dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | | | lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | | | lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | | | lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | | | lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | | | orderReference | Wildcard search by the order's reference | String | no | orderReference=Ref-6* | | itemReference | Wildcard search by the resource's item reference | String | no | itemReference=Ref-6* , itemReference=*ef-6 , itemReference=*ef-6* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ) Success Output Success case: response.status=200 {
"paging": {
"total": 1,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"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,
"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"
},
{
"id": 1108,
"operationType": "INVOICE",
"orderReference": "invoice_2016-11-07",
"order": {
"id": 1109,
"reference": "invoice_2016-11-07",
"href": "/api/v1.0/orders/1109"
},
"itemReference": "eliteBook_g2",
"unitReference": "pcs",
"item": {
"id": 775,
"reference": "eliteBook_g2",
"name": "HP EliteBook 820 G2",
"href": "/api/v1.0/items/775"
},
"unit": {
"id": 1,
"reference": "pcs",
"name": "pieces",
"href": "/api/v1.0/units/1"
},
"discount": null,
"customerDiscount": null,
"finalPrice": 1750,
"unitPrice": 1750,
"tax": 77,
"quantity": 1,
"type": "REGULAR",
"comment": null,
"soldSerialNumbers": [
{
"id": 2703547,
"value": "8f8c-d43d7ead5d58",
"href": "/api/v1.0/serialNumbers/2703547"
}
],
"organization": "entity1",
"dateCreated": "2016-11-07T14:40:48Z",
"lastUpdated": "2016-11-07T14:40:48Z"
},
…
]
} Failure Output Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}62.2 Show
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."
}
|
|
