(Quick Reference)
Service: List order payments
Description: This web service return the list of order payments in JSON format.
URL:
https://BASE_URL/api/VERSION/orderPayments
: 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 | |
| reference | Wildcard search by the reference of order payment | String | no | reference=ref-6* |
| orderReference | Wildcard search by the order's reference | String | no | |
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": 921,
"reference": "5_8_2014_12_20",
"orderReference": "marie_order_2014_12_20",
"order": {
"id": 5,
"reference": "marie_order_2014_12_20",
"customerReference": "C0959",
"userReference":"emp-0",
"href": "/api/v1.0/orders/5"
},
"advanceAmount": null,
"paymentDate": "2014_12_20T22:00:00Z",
"isLast": true,
"paymentTypeReference": "CHEQUE",
"paymentType": {
"id": 8,
"reference": "CHEQUE",
"name": "Cheque",
"href": "/api/v1.0/paymentTypes/8"
},
"bank": null,
"chequeNumber": null,
"desiredPaymentDate": null,
"chequeImage": null,
"dateCreated": "2014_12_20T22:00:00Z",
"lastUpdated": "2014_12_20T22:00:00Z"
}
]
} 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..."
}
