Delivery

patch

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

Edit any field of the delivery information.

Body Params

Delivery object.

int32

deprecated - will be removed!

pdt_from

date-time

Planned delivery time from.

pdt_to

date-time

Planned delivery time to.

pdt_break_starts

array of date-times

If multiple time windows are given, then this is the start of the timewindow break.

pdt_break_starts

pdt_break_ends

array of date-times

If multiple time windows are given, then this is the end of the timewindow break.

pdt_break_ends

ppt_from

date-time

Planned pickup time from (deprecated, reference via pickup_id instead).

ppt_to

date-time

Planned pickup time to (deprecated, reference via pickup_id instead).

eta_from

date-time

Estimated time of arrival time window start.

eta_to

date-time

Estimated time of arrival time window end.

tdt_from

date-time

Target delivery time from (relevant for the driver).

tdt_to

date-time

Target delivery time to (relevant for the driver).

ddt_from

date-time

Driver delivery target time from.

ddt_to

date-time

Driver delivery target time to.

return_time

date-time

Desired return time of this shipment to the depot.

ata

date-time

Actual time of arrival.

atd

date-time

Actual time of delivery.

fixed_els_seconds

int32

Fixed estimated length of stay in seconds.

variable_els_seconds_per_load

array of int32s

Variable estimated length of stay per load for all three load dimensions.

variable_els_seconds_per_load

als_seconds

int32

Actual length of stay in seconds.

tfp

int32

Driving time from preceding delivery in minutes.

tfp_seconds

int32

Driving time from preceding delivery in seconds.

dist_from_prev_stop_m

int32

Driving distance from preceding stop in meters.

creationtime

date-time

deliverprio

string

deprecated

(DEPRECATED. Please use shipment_priority) Priority value, can either be low, medium or high.

shipment_priority

integer

≥ 0

Priority value, can be any integer greater or equal to 0.

orderindex

int32

A global ordering index (for route sequence, see {order_in_tour}).

load

int32

Defaults to 1

Amount of load on this vehicle (first dimension, e.g. pallet spaces).

load_2

int32

Amount of load on this vehicle (second dimension, e.g. weight).

load_3

int32

Amount of load on this vehicle (third dimension, e.g. volume).

load_text

string

An optional description of the load.

notes

string

custom_id

string | null

Optional identifier (e.g. shipment ID) from the user. Must be unique or null.

custom_tour

string

process_id

string

overload_ref

string

Reference to another delivery overtaking overloads of this delivery.

vehicletype_name

string

scancode

string

deliverylocation_id

int32

Reference to Address ID.

supplier_address

object

supplierlocation_id

int32

Reference to Address ID.

delivery_address

object

route_id

int32

Reference to Route ID.

status

int32

Reference to Deliverystatus.

code

int32

Reference to Deliverycode.

distances

string

Deprecated. JSON object containing distances to other deliveries on the same route.

deliverytype_id

int32

Reference to Deliverytype ID.

delivery_delay

int32

Delay at this delivery location.

eta

date-time

estimated time of arrival - deprecated!

height

float

Height of delivered item to check if it fits with the load height of a vehicle.

load_class_ids

array of int32s

List of IDs of potentially assigned load classes of this delivery (e.g. heavy load).

load_class_ids

order_in_tour

int32

Sequence number of ths delivery within a route (only if part of a route result).

recipientname

string

Name of a recipient if not the original consignee (deprecated)

recipienttype

string

Type of a recipient if not the original consignee (deprecated)

pickup_id

string

If this is a pickup corresponding to a delivery, this ID is referenced by the (other) delivery.

pickup_ref_id

string

If this is a delivery which was picked up before, this ID is referencing the respective pickup (which has this value as pickup_id assigned).

same_stop_unit

string

Unit ID of a stop at this location which is combined by multiple deliveries.

update_notes

string

Notes originating from an update of an initial optimization.

unit

string

ID of a potentially pre-defined delivery unit.

waiting_time_seconds

int32

Waiting time before this delivery in seconds.

liftgate_needed

boolean

Defaults to false

Needs to be delivered by a vehicle with a liftgate?

trailer_needed

boolean

Defaults to false

Needs to be delivered by a trailer?

adr_needed

boolean

Defaults to false

deprecated

DEPRECATED. Will be removed, please use adr_points instead.

possible_vehicles

array of int32s

A list of vehicle ids that are allowed to handle this delivery.

possible_vehicles

territory

string

The name of the territory the delivery is located in.

effective_loads

array of int32s

The final calculated loads of the delivery.

effective_loads

shipment_type

string

Can either be a "delivery" or a "pickup".

adr_points

int32

ADR points of the shipment.

Responses

200

OK.

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.