(Quick Reference)
Service: List operations (orders,pre-orders, invoices ,delivery notes and deliveries) Description: This web service returns a json list of operations. URL: https://BASE_URL/api/VERSION/orders : GET Parameters: Pagination parameters: | Name | Description | Type | Required | Possible values |
|---|
| max | Limits the number of resources requested to return. | Integer | no | | | offset | Tells where to start returning records from the entire set of results. | Integer | no | | | order | Orders ascending or descending. | Integer | no | asc,desc | | sort | Orders the results by the specified field. | String | no | |
The max parameter is set to 100 by default. 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 | | | operationType | Search by the operation type | String | no | ORDER,PREORDER,INVOICE,DELIVERYNOTE,DELIVERY | | reference | Wildcard search by the resource's reference | String | no | | | employeeReference | Wildcard search by the resource's employee reference | String | no | employeeReference=Ref-6* , employeeReference=*ef-6 , employeeReference=*ef-6* | | customerReference | Wildcard search by the resource's customer reference | String | no | customerReference=Ref-6* , customerReference=*ef-6 , customerReference=*ef-6* | | deliveredByReference | Wildcard search by the resource's deliveredBy employee reference | String | no | deliveredByReference=Ref-6* , deliveredByReference=*ef-6 , deliveredByReference=*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": 702,
"max": 5,
"offset": 5,
"previous": "/api/v1.0/orders?sort=dateCreated&max=5&order=asc&operationType=ORDER&offset=0",
"next": "/api/v1.0/orders?sort=dateCreated&max=5&order=asc&operationType=ORDER&offset=10"
},
"data": [
{
"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": "2015-08-16T23: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",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
|
|
