(Quick Reference)
79 Delivery Assignment - Reference Documentation
Version: 2.1
79 Delivery Assignment
79.1 List
Service: List delivery assignments Description: This web service returns a json list of delivery assignments. URL: https://BASE_URL/api/VERSION/assignDelivery : 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 | | | 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": 11,
"max": 1,
"offset": 0,
"previous": null,
"next": "/valomniav2/api/v2.1/assignDelivery?max=1&offset=1&sort=dateCreated&order=asc"
},
"data": [
{
"id": 1145,
"operationType": "DELIVERY",
"reference": "testDelivery",
"status": "ADVANCE",
"latitude": null,
"longitude": null,
"checkInDate": null,
"total": 3097.5,
"totalExclTax": 1750,
"totalDiscounted": 1750,
"discount": 0,
"taxAmount": null,
"shippingFee": null,
"paymentDate": "2016-03-23T17:07:00Z",
"paymentTypeId": 7,
"paymentType": {
"id": 7,
"reference": "CASH",
"name": "Cash",
"href": "/valomniav2/api/v2.1/paymentTypes/7"
},
"advanceAmount": 2018.85,
"orderPayments": [
{
"id": 2381,
"reference": null,
"href": "/valomniav2/api/v2.1/orderPayments/2381"
},
{
"id": 2382,
"reference": null,
"href": "/valomniav2/api/v2.1/orderPayments/2382"
}
],
"orderPrepayments": [],
"dueDate": null,
"customerReference": "cust_A0",
"customer": {
"id": 1,
"reference": "cust_A0",
"reference2": "cust_A0",
"name": "Siemens_A0",
"categoryReference": "60837-122",
"href": "/valomniav2/api/v2.1/customers/1"
},
"currency": "EUR",
"exchangeRate": 1,
"employeeReference": "emp-00",
"user": {
"id": 4,
"reference": "emp-00",
"href": "/valomniav2/api/v2.1/users/4"
},
"billingCountry": null,
"billingCity": null,
"billingPostalCode": null,
"billingAddress": null,
"deliveryStatus": "PENDING",
"deliveryDate": "2017-02-03T11:00:00Z",
"deliveryComment": null,
"deliveryCountry": null,
"deliveryCity": null,
"deliveryPostalCode": null,
"deliveryAddress": null,
"orderLines": [
{
"id": 1512,
"href": "/valomniav2/api/v2.1/orderDetails/1512"
}
],
"pdfUrl": null,
"organization": "entity1",
"dateCreated": "2016-06-29T11:12:00Z",
"lastUpdated": "2018-05-22T13:22:44Z",
"dateAddToBo": "2017-02-02T14:23:54Z",
"deliveredBy": {
"id": 4,
"reference": "emp-00",
"href": "/valomniav2/api/v2.1/users/4"
},
"desiredDeliveryDate": "2016-03-23T17:07:00Z",
"deliveredOn": "2016-03-23T17:07:00Z",
"assignmentDate": null,
"parentItemCategory": {
"id": 2,
"reference": "Ref-01",
"name": "Home",
"href": "/valomniav2/api/v2.1/itemCategories/2"
}
}
]
} 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..."
}79.2 Assign
Service: Assign a delivery to an employee Description: Returns the assigned operation in json format when successful. Returns a json response, describing the failure condition when unsuccessful. URL: https://BASE_URL/api/VERSION/assignDelivery : POST Request content type: application/x-www-form-urlencoded or multipart/form-data Parameters: | Name | Description | Type | Required | Example values |
|---|
| orderId | Order should be not already delivered or assigned to an employee | Long/String | yes | | | userId | The numerical ID of user to assign | Long/String | yes | | | desiredDeliveryDate | | Date | yes | 2016-04-12T19:30:48Z | | useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
Success Output Success case: response.status=201 {
"id": 1260,
"operationType": "ORDER",
"reference": "1234567",
"status": "PAID",
"latitude": null,
"longitude": null,
"checkInDate": null,
"total": 3097.5,
"totalExclTax": 1750,
"totalDiscounted": 1750,
"discount": 0,
"taxAmount": null,
"shippingFee": null,
"paymentDate": "2016-03-23T17:07:00Z",
"paymentTypeId": 7,
"paymentType": {
"id": 7,
"reference": "CASH",
"name": "Cash",
"href": "/valomniav2/api/v2.1/paymentTypes/7"
},
"advanceAmount": 1000,
"orderPayments": [
{
"id": 1988,
"reference": null,
"href": "/valomniav2/api/v2.1/orderPayments/1988"
},
{
"id": 1989,
"reference": null,
"href": "/valomniav2/api/v2.1/orderPayments/1989"
},
{
"id": 1990,
"reference": "the_last",
"href": "/valomniav2/api/v2.1/orderPayments/1990"
}
],
"orderPrepayments": [],
"dueDate": null,
"customerReference": "100",
"customer": {
"id": 100,
"reference": "100",
"reference2": "",
"name": "Camimbo 100",
"categoryReference": "Ref-01",
"href": "/valomniav2/api/v2.1/customers/100"
},
"currency": "EUR",
"exchangeRate": 1,
"employeeReference": "emp-00",
"user": {
"id": 4,
"reference": "emp-00",
"href": "/valomniav2/api/v2.1/users/4"
},
"billingCountry": null,
"billingCity": null,
"billingPostalCode": null,
"billingAddress": null,
"deliveryStatus": "PENDING",
"deliveryDate": "2017-02-13T10:25:00Z",
"deliveryComment": null,
"deliveryCountry": null,
"deliveryCity": null,
"deliveryPostalCode": null,
"deliveryAddress": null,
"orderLines": [
{
"id": 1361,
"href": "/valomniav2/api/v2.1/orderDetails/1361"
}
],
"pdfUrl": null,
"organization": "entity1",
"dateCreated": "2016-06-29T11:12:00Z",
"lastUpdated": "2018-05-15T17:24:46Z",
"dateAddToBo": "2017-02-10T08:43:09Z",
"deliveredBy": {
"id": 4,
"reference": "emp-00",
"href": "/valomniav2/api/v2.1/users/4"
},
"desiredDeliveryDate": "2018-07-10T16:00:00Z",
"deliveredOn": null,
"assignmentDate": "2018-07-10T11:41:43Z",
"parentItemCategory": {
"id": 2,
"reference": "Ref-01",
"name": "Home",
"href": "/valomniav2/api/v2.1/itemCategories/2"
}
} Failure Output Failure case:response.status = 400 {
"error": "save_failed",
"error_description": "Failed to save instance."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime format for desiredDeliveryDate it must be in this format : yyyy-MM-dd'T'HH:mm:ss'Z'"
}{
"error": "not_found",
"error_description": "The Order with the reference 1234567 doesn't exist."
}{
"error": "missing_param",
"error_description": "userId parameter is missing"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}79.3 Unassign
Service: Unassign a pending order to an employee Description: this web service is used in order to delete an existing delivery assignment URL: https://BASE_URL/api/VERSION/assignDelivery/{id}: https://BASE_URL/api/VERSION/assignDelivery/reference/{id}: DELETE Parameters: | Name | Description | Type | Required | Example values |
|---|
| id | The ID of the delivery assignment to delete | Long/String | yes | 123 | | useExternalId | By default, it is set to false. set it to true if you want to use external ids. | Boolean | no | true , false |
The order should be assigned to an employee and not already delivered Success Output Success case: response.status=200 {
"success": "true",
"success_description": "Instance deleted successfully"
} Failure Output
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The Delivery assignment with the id 1796 doesn't exist."
} Failure case:response.status = 400 {
"error": "delete_failed",
"error_description": "Failed to delete instance."
}{
"error":"invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
|
|
