Update mission status

post

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

Changes mission mission status and subStatus, with all informations needed according to subStatus configuration, including proofs.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

articles

array of objects

List of articles amounts.

articles

comment

string

general comment field

condition

string

enum

Container condition reported by the driver at scan time: GOOD or DAMAGED. Optional - absent/null means no condition was reported on this scan and leaves the container's recorded condition unchanged. May be sent alongside a RECEIVED, DELIVERED, or PICKED status update (as well as any other status). A condition reported against a containerCode that is not registered in the contractor's container registry is accepted and silently discarded - it never causes this request to fail.

Allowed:

containerCode

string

Container code reported at scan time. When non-empty, overwrites the mission's containerCode; empty/null leaves it unchanged. Free-form, not validated against configured containers.

externalMissionId

string

mission external identifier (senderPackageBarcode)

floor

int32

Floor information

latitude

double

Actual latitude when this action happened.

longitude

double

Actual longitude when this action happened.

manual

boolean

True if mission id was entered manually instead of scanning the bar code

missionId

string

Mission identifier

motiveId

string

Motive identifier, will be provided if motives are defined for the current sub-status. Motives can be defined in UI configuration menu for each sub-statuses.

motiveText

string

Motive text, will be provided if current sub-status is configured to show a free motive field.

noWebhookCall

boolean

Defaults to false

If true, no webhook call will be triggered after this status update.

personId

string

Identifier of the person performing the action

photoPathList

array of strings

Complete list of photos urls attached to this missions. The photos can have been taken at different stages of the fulfillment of the mission.

photoPathList

reserve

string

Comment entered when delivery is accepted with some reserves

signatureSvg

string

Signature of the customer in svg format

signerName

string

Name of the signer

status

string

enum

new mission status

subStatus

string

new mission sub-status

timeStamp

date-time

Mobile device time when the action is done

unloading

boolean

Defaults to false

True if this is an unloading action. For instance, if a delivery failed, when delivery mans returns to the depot, the package is unloaded from the truck. In this case, this action will have the same status and sub-status enterer when the delivery failed. The only difference will be this unloading field.

workerSignatureSvg

string

Signature of the operator in svg format

Headers

UseHTTPCodeOnError

boolean

Defaults to false

Response

defaultJust OK or an error if specified person do no have required role or agency.