(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/assignDelivery

Method: GET

Parameters:

Pagination parameters:

NameDescriptionTypeRequiredPossible values
maxLimits the number of resources requested to return.Integerno 
offsetTells where to start returning records from the entire set of results.Integerno 
orderOrders ascending or descending.Integernoasc,desc
sortOrders the results by the specified field.Stringno 

The max parameter is set to 100 by default.

Filters parameters:

NameDescriptionTypeRequiredExample values
dateCreated_gtFilters by the resource's creation date time and operator greater thanDateno2016-08-15T14:52:48Z
dateCreated_gteFilters by the resource's creation date time and operator greater than or equalDateno 
dateCreated_ltFilters by the resource's creation date time and operator less thanDateno 
dateCreated_lteFilters by the resource's creation date time and operator less than or equalDateno 
lastUpdated_gtFilters by the resource's last-modified date time and operator greater thanDateno 
lastUpdated_gteFilters by the resource's last-modified date time and operator greater than or equalDateno 
lastUpdated_ltFilters by the resource's last-modified date time and operator less thanDateno 
lastUpdated_lteFilters by the resource's last-modified date time and operator less than or equalDateno 
referenceWildcard search by the resource's referenceStringno 
employeeReferenceWildcard search by the resource's employee referenceStringnoemployeeReference=Ref-6* , employeeReference=*ef-6 , employeeReference=*ef-6*
customerReferenceWildcard search by the resource's customer referenceStringnocustomerReference=Ref-6* , customerReference=*ef-6 , customerReference=*ef-6*
deliveredByReferenceWildcard search by the resource's deliveredBy employee referenceStringnodeliveredByReference=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": "testDelivery1",
            "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": "DELIVERED",
            "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..."
}