Finished deliveries

get

https://customer_id.prod.smartlane.io/api/finisheddeliveries

Returns a list of all finished ('delivered' or 'undelivered') deliveries filtered by time and status.

Query Params

start

date-time

Start time for query, defaults to midnight of today.

end

date-time

End time for query, defaults to now.

status

string

Defaults to both

Status filter for deliveries (delivered or undelivered or both).

code

int32

Code for delivery status details (e.g. delivered to neighbor or recipient not at home). Available codes are available via GET /deliverycode. Defaults to 1 (delivered to recipient) if status is delivered, else to 4 (recipient not present).

allundelivered

boolean

Defaults to true

Indicates if date and time filter are ignored for undelivered deliveries. Often, all deliveries that are still undelivered should be displayed regardless of when the delivery attempt failed and regardless of the date filter for the successfully delivered deliveries. Defaults to true (all undelivered deliveries are returned).

Responses

Language

Credentials

Header

Response

Choose an example:

application/json

200OK.

403An error message caused by missing authorization (403 forbidden).

422An error message caused by unprocessable input (e.g. no data found for input parameters).

defaultUnexpected error.