Update one mission

post

https://api.geoconcept.com/delivery/api/nd/missions/updateMission

Update one mission. Only the properties present in the request body are applied: anything left out keeps the value it has in the database, so a partial payload carrying just the mission id and the properties to change is enough. Sending a property with an explicit null value clears it. Some modifications are not possible if the mission is already planned in a route. This update will not be traced in the mission log.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Mission information to update in the specified fields

agencyId

string

Agency identifier. This is a mandatory field. Agencies are defined in UI config menu. Depending on the type of the mission, pikup address or consignee address, if not provided, will be automatically filled from agency address.

articles

array of objects

List of articles amounts.

articles

assignedPersonId

string

Person identifier (email) of the person in charge of handling the route containing the mission. This value will readable after route creation. It can be filled on mission creation if routes are already prepared. positionInRoute must be provided in this case.

cashOnDelivery

double

Cash on Delivery.

comment

string

Some general comment on the mission. Comment fields are also available on the pickup and consignee addresses.

consignee

object

New location of the sub-contractor. Leave it null to let unchanged.

containerCode

string

For pickup missions, code of the container that must be used to store the picked object. This code will be scanned through the mobile app during the pickup operation.

containerType

string

Container type can be PALLET, CARDOARD, PARCEL or anyone of the custom containers types defined in UI config menu.

contractorId

string

Contractor identifier. A specific contractor will only see the missions having his id.

customData

object

Map of [id,value] or [name,value] (depending on the value you set for CustomFieldRepresentation) data. Custom data types must be defined in UI configuration menu.

deliveryAddressId

string

Id of an address from user's address list, which allows to automatically choose delivery address.

deliveryAgent

string

Delivery agent id for leg missions.

deliveryAskedDate

date-time | null

Asked date (for delivery missions).

deliveryAskedEndDate

date-time | null

Asked end date (for delivery missions).

deliveryOrPickup

string

enum

Specifies wether the mission is a DELIVERY (default value) or a PICKUP. A DELIVERY must be loaded at the pickup address (or angency address) and delivered at the consignee address. A PICKUP must be picked at the pickup address and returned at the consignee address (or agency address).

Allowed:

deliveryPrice

double

Delivery price.

deliveryPudoAddressId

string

This is the id of the delivery PUDO address

deliverySubContractor

string

Sub-contractor id for the delivery leg missions.

deliveryZone

string

Pickup zone(sector) id for leg missions.

destinationAgency

string

Destination agency id for leg missions.

freeMotive

string

Motive text.

groupingId

string

Grouping identifier used when several package should be delivered at once. This grouping id can be generated through the groupMissions webservice.

height

double

height indication

string

Mission identifier. The bar code will be a presentation of this identifier. If this field is not provided, an id will be generated automatically.

isBookingConfirmed

boolean | null

Whether the booking for this mission has been confirmed. Left unset (null) when the information is not applicable or not yet known, which is distinct from an explicit false.

key

string

Text information about the keys needed to perform the mission.

leg

string

enum

Leg value for the cross docking mission, it can be a value between COLLECTION, DISTRIBUTION or DELIVERY

Allowed:

length

double

length indication

maxTemperature

double

Maximum temperature reading for this mission's temperature-compliance requirement, in Celsius. Must be >= medianTemperature and >= minTemperature, whichever of these are also provided.

medianTemperature

double

Median temperature reading for this mission's temperature-compliance requirement, in Celsius. Must be between minTemperature and maxTemperature, whichever of these are also provided.

minTemperature

double

Minimum temperature reading for this mission's temperature-compliance requirement, in Celsius. Must be <= medianTemperature and <= maxTemperature, whichever of these are also provided.

missionDuration

string

Time, can be expressed in minutes or in hh:mm:ss format.

motiveId

string

Motive identifier.

notificationConfig

string

Notification configuration identifier. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeNoticationConfig flag to automatically update the notification configuration based on the new mission information.

oneTimePassword

string

One time password value. Depending on the policy, a value can be automatically generated.

oneTimePasswordPolicy

string

enum

One time password policy for this mission.

Allowed:

openingDays

array of strings

Days where the customer can be visited. Day 1 monday, day 7 is sunday. You can provide up to 4 days patterns. A days pattern can be a comma separated list of days ('1,3,5') or a day spread ('1-5'). Visit time windows can also be specified, with one timewindow for each days pattern.

openingDays

openingHours

array of objects

Time window where a customer can be visited. You can specify up to 4 time windows (if you defined 4 days patterns).

openingHours

originAgency

string

Origin agency id for leg missions.

originCountry

string

Country of origin

otherConstraints

object

Additionnal constraints used for optimization.

packageValue

double

Package value.

palletBoxNumber

int32

Number of cardboard boxes contained in the pallet.

palletPackageNumber

int32

Total number of packages (the may be contained in cardboard boxes) in the pallet.

parentId

string

Container mission identifier. Used If the mission package is contained in some container (Pallet, cardboard box, etc).

pickupAddress

object

New location of the sub-contractor. Leave it null to let unchanged.

pickupAddressId

string

Id of an address from user's address list, which allows to automatically choose pickup address.

pickupAgent

string

Pickup agent id for leg missions.

pickupAskedDate

date-time | null

Asked date (for pickup missions).

pickupAskedEndDate

date-time | null

Asked end date (for pickup missions).

pickupPudoAddressId

string

This is the id of the pickup PUDO address

pickupSubContractor

string

Sub-contractor id for the pickup leg missions.

pickupZone

string

Pickup zone(sector) id for leg missions.

placeInWarehouse

string

specifies where the package is stored in warehouse.

positionInRoute

int32

Position index in route. This value will readable after route creation. It can be filled on mission creation if routes are already prepared. assigendPersonId must be provided in this case.

priority

int32

Priority level. 0 is the highest priority. This value will help during route planning to know which missions should get prioritised against others.

productType

string

Information on product type.

pudoPolicy

string

enum

PUDO policy for the mission.

Allowed:

quantities

array of doubles

Quantities are used in optimization process against vehicles capacities. Logistic engine only handles one capacity for now.

quantities

senderPackageBarcode

string

External identifier that can be used in specific scenarios. Mobile app is able to retrieve the mission from both id and senderPackageBarcode.

status

string

enum

Mission status. Default status is WAITING.

statusCustomizationType

string

Type of sub-status configuration to be applied to this mission. On mission creation, if not provided, it will be automatically set based on the priority and the assignment rules defined in the back office configuration. On mission update, use the recomputeStatusConfig flag to automatically update the status configuration based on the new mission information.

subContractorId

string

Sub-contractor identifier. A specific sub-contractor will only see the missions having his id.

substatus

string

Substatus identifier.

volume

double

volume indication

weight

double

weight indication

width

double

width indication

Headers

CustomFieldRepresentation

string

enum

Allowed:

UseHTTPCodeOnError

boolean

Defaults to false

recomputeStatusConfig

boolean

Defaults to false

recomputeNotificationConfig

boolean

Defaults to false

Response

defaultJust OK or an error if the update is not possible due to current mission state