Shipment

Shipment status “upcoming”

Field name	Updatable
`shipmentExternalId`	no - used for identification

Apart from the shipmentExternalId, all fields are updatable as long as the shipment is in status “upcoming”

Shipment status “in_progress”

Field name	Updatable
`shipmentExternalId`	no - used for identification
`truckLicensePlate`	only if no location present, otherwise needs to be triggered via changeAsset
`trailerLicensePlate`	only if no location present, otherwise needs to be triggered via changeTrailer
`carrierDripNumber`	only if no location present, otherwise needs to be triggered via changeAsset
`carrierVatNumber`	only if no location present, otherwise needs to be triggered via changeAsset
`customerField1`	yes
`realtimeVisibilityProviders`	yes

Stops

Stops are updated based on their index. Stops, which are not in upcoming anymore, may not be moved anymore. It until the shipment is not finished, stops can be added to the shipment.

Stop status “upcoming”

Field name	updatable
`$type`	yes
`address`	yes
`coordinates`	yes
`matchCode`	yes
`stopInfo`	yes
`name`	yes
`timeWindow`	yes
`duration`	yes
tasks	yes

Stop status “arrived”

Field name	updatable
`$type`	no
`address`	no
`coordinates`	no
`matchCode`	yes
`stopInfo`	yes
`name`	no
`timeWindow`	yes - only end date
`duration`	yes
tasks	yes

Stop status “left”

Field name	updatable
`$type`	no
`address`	no
`coordinates`	no
`matchCode`	yes
`stopInfo`	no
`name`	no
`timeWindow`	no
`duration`	no
tasks	yes

Consignments

Consignments are updated based on their id. Unless the shipment is not finished, consignments can be added to the shipment.

Consignment status “scheduled”

Field name	updatable
`consignmentExternalId`	no - used for identification
`customerReferenceText`	yes
`load`	yes
`sender`	yes
`receiver`	yes
`payer`	yes

Consignment status “loaded”

Field name	updatable
`consignmentExternalId`	no - used for identification
`customerReferenceText`	yes
`load`	no
`sender`	no
`receiver`	yes
`payer`	yes

Consignment status “in_transit”

Field name	updatable
`consignmentExternalId`	no - used for identification
`customerReferenceText`	yes
`load`	no
`sender`	no
`receiver`	yes
`payer`	yes

Consignment status “delivered”

Field name	updatable
`consignmentExternalId`	no - used for identification
`customerReferenceText`	yes
`load`	no
`sender`	no
`receiver`	no
`payer`	yes

Tasks concerning the consignments can always be added to stops, even if the stops are already left.

Return-Codes

Authorization
1001	no Authorization header
1002	api-token missing
1003	invalid token
Errors
2001	not a valid JSON
2002	body must not be null
2003	Shipment does not contain any stops
2004	Stop[%d]: Either address or coordinates are required
2005	Consignment load name too long. Maximum number of characters allowed: 255
2006	Failed to resolve address via PTV
2007	Can't map to shipment
2008	Shipment with id '%s' not found
2009	Unable to set status to %s while shipment in status %s
2999	< dynamic error message based on validation result >
Warnings
3001	Drip number %s not found or not a partner
3002	Stop[%d]: Address resolution score below 90%% -> %2.0f%%
3003	Truck license plate %s is too short to match
3004	Truck license plate %s not found
3005	Multiple vehicles found for truck license plate %s - using most actual one
3006	Vehicle found for truck license plate %s but not shared by partner
3007	Stop[%d]: No corresponding coordinates found for given address.
3008	%s is not a valid profile
3009	Trailer license plate %s is too short to match
3010	Trailer license plate %s not found
3011	Multiple vehicles found for trailer license plate %s - using most actual one
3012	Vehicle found for trailer license plate %s but not shared by partner
Others
9001	< Unexpected error occurred >