(Quick Reference)
64 Return details - Reference Documentation
Version: 2.1
64 Return details
64.1 List
Service: List return details
Description: This web service return the list of return lines in JSON format.
URL:
https://BASE_URL/api/VERSION/returnDetails
: 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 | |
| returnReference | Wildcard search by the return's reference | String | no | returnReference=Ref-6* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status=200
{
"paging": {
"total": 35,
"max": 1,
"offset": 0,
"previous": null,
"next": "/api/v1.0/returnDetails?max=1&offset=1&sort=id&order=asc"
},
"data": [{
"id": 1,
"returnType": "CANCELLATION",
"returnReference": "return3",
"returnOperation": {
"id": 5,
"reference": "return3",
"href": "/api/v1.0/returns/5"
},
"serialNumber": null,
"picture": null,
"itemUnitId": 29,
"itemReference": "71663",
"unitReference": "pcs",
"item": {
"id": 41,
"reference": "71663",
"name": "Product 71663",
"href": "/api/v1.0/items/41"
},
"unit": {
"id": 1,
"reference": "pcs",
"name": "pieces",
"href": "/api/v1.0/units/1"
},
"quantity": 597,
"organization": "entity1",
"comment": "the deadline is up",
"dateCreated": null,
"lastUpdated": null
}]
} 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..."
}64.2 Show
Service: Show a return detail
Description: Returns the requested return detail in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/returnDetails/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired return detail | Long | Yes | 777 |
Success Output
Success case: response.status=200
{
"id": 40,
"returnType": "RETURN",
"returnReference": "return-1",
"returnOperation": {
"id": 44,
"reference": "return-1",
"href": "/api/v1.0/returns/44"
},
"serialNumber": "serial_number",
"picture": "BASE_URL/entity1-1450169988465/photoReturn/1476113492480_IMG_2009.PNG",
"itemUnitId": 2,
"itemReference": "ref",
"unitReference": "pcs",
"item": {
"id": 497,
"reference": "ref",
"name": "item name",
"href": "/api/v1.0/items/497"
},
"unit": {
"id": 1,
"reference": "pcs",
"name": "pieces",
"href": "/api/v1.0/units/1"
},
"quantity": 2,
"comment": "the deadline is up",
"organization": "entity1",
"dateCreated": "2016-09-22T11:12:00Z",
"lastUpdated": "2016-10-10T15:31:32Z"
} 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."
}
