deliveries

Update delivery

Send only the fields to change.

patch/deliveries/{id}

Request

  • Base URL: https://api.vepathos.com
  • URL: https://api.vepathos.com/deliveries/{id}
  • Auth: API key in header Authorization

Path parameters

idinteger required

Request body

destinationstring nullable

Stop location. Coordinates in ISO 6709 decimal degrees, latitude then longitude with signs, e.g. +40.7128-74.0060.

method'DELIVERY' | 'PICKUP' | 'SIGNATURE'
schedulesstring[] nullable

Time windows. RFC 5545 VEVENT: DTSTART plus DTEND or DURATION, optionally RRULE. Join lines with \n.

widthinteger nullable

Package width, in length_unit. Integer.

heightinteger nullable

Package height, in length_unit. Integer.

depthinteger nullable

Package depth, in length_unit. Integer.

length_unit'CENTIMETER' | 'METER' | 'KILOMETER' | 'INCH' | 'FEET' | 'MILE'
volumeinteger nullable

Package volume, in volume_unit. Integer.

volume_unit'CUBIC_CENTIMETER' | 'CUBIC_METER' | 'LITER' | 'CUBIC_INCH' | 'CUBIC_FEET' | 'GALLON'
weightinteger nullable

Package weight, in weight_unit. Integer; use GRAMS for fractional kilograms.

weight_unit'GRAMS' | 'KILOGRAMS' | 'OUNCES' | 'POUNDS'
packaging'BOX' | 'ENVELOPE' | 'BAG' | 'CARTON' | 'PALLET' | 'SHRINK_WRAP'
handlingSpecialHandling[] nullable
value_centsinteger nullable

Declared value in minor units (5000 is 50.00).

value_currencystring nullable

ISO 4217 currency code.

extraunknown
milestone_idstring nullable

Milestone the package leaves from.

Response

The updated delivery.

destinationstring required

Stop location. Coordinates in ISO 6709 decimal degrees, latitude then longitude with signs, e.g. +40.7128-74.0060.

method'DELIVERY' | 'PICKUP' | 'SIGNATURE'
schedulesstring[] nullable

Time windows. RFC 5545 VEVENT: DTSTART plus DTEND or DURATION, optionally RRULE. Join lines with \n.

widthinteger nullable

Package width, in length_unit. Integer.

heightinteger nullable

Package height, in length_unit. Integer.

depthinteger nullable

Package depth, in length_unit. Integer.

length_unit'CENTIMETER' | 'METER' | 'KILOMETER' | 'INCH' | 'FEET' | 'MILE'
volumeinteger nullable

Package volume, in volume_unit. Integer.

volume_unit'CUBIC_CENTIMETER' | 'CUBIC_METER' | 'LITER' | 'CUBIC_INCH' | 'CUBIC_FEET' | 'GALLON'
weightinteger nullable

Package weight, in weight_unit. Integer; use GRAMS for fractional kilograms.

weight_unit'GRAMS' | 'KILOGRAMS' | 'OUNCES' | 'POUNDS'
packaging'BOX' | 'ENVELOPE' | 'BAG' | 'CARTON' | 'PALLET' | 'SHRINK_WRAP'
handlingSpecialHandling[] nullable
value_centsinteger nullable

Declared value in minor units (5000 is 50.00).

value_currencystring nullable

ISO 4217 currency code.

extraunknown

Changes

No recorded changes to this operation across all 1 revision of this API.