# Update consignment

Update a consignment

Endpoint: PUT /consignment
Version: 0.9.74
Security: bearer, apiKey, apiSecret

## Header parameters:

  - `Authorization` (string, required)

## Request fields (application/json):

  - `nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `uuid` (string, required)

  - `primaryPlatformId` (string, required)

  - `language` (object)
    circular reference

  - `name` (string, required)
    Name of the Consignment. For display purposes and search only.

  - `consignmentNr` (string)

  - `description` (string)
    General description of consignment in Free text. e.g 20 europallets fruit. Meant for human inspection, not for automating processes.

  - `status` (string)
    Enum: "draft", "requested", "confirmed", "in_transit", "completed", "cancelled", "partially_planned", "planned", "partially_completed", "partially_in_transit", "concept"

  - `highValueGoods` (boolean)

  - `goods` (array)

  - `goods.associationType` (string)
    Enum: "inline", "reference"

  - `team` (object)
    circular reference

  - `combined` (boolean)

  - `consignment` (object)
    circular reference

  - `originalPhysicalSender` (object)
    circular reference

  - `originalLegalSender` (object)
    circular reference

  - `originalPhysicalAddressee` (object)
    circular reference

  - `originalLegalAddressee` (object)
    circular reference

  - `currentLocation` (object)
    circular reference

  - `currentLocation.administrativeReference` (object)

  - `currentLocation.administrativeReference.name` (string)

  - `currentLocation.administrativeReference.street` (string)

  - `currentLocation.administrativeReference.houseNumber` (string)

  - `currentLocation.administrativeReference.houseNumberAddition` (string)

  - `currentLocation.administrativeReference.postalCode` (string)

  - `currentLocation.administrativeReference.city` (string)

  - `currentLocation.administrativeReference.country` (string)

  - `currentLocation.lat` (number)

  - `currentLocation.lon` (number)

  - `currentLocation.speed` (object)

  - `currentLocation.speed.value` (string)

  - `currentLocation.speed.unit` (string)

  - `currentLocation.heading` (object)

  - `currentLocation.bearing` (object)

  - `currentLocation.bearingType` (string)
    Enum: "absolute", "relative"

  - `nextAction` (object)
    circular reference

  - `lastAction` (object)
    circular reference

  - `lastPlannedAction` (object)
    circular reference

  - `isPlannedToLastLocation` (boolean)

  - `type` (string)
    This field can be used to categorize and/or group shipments by type, depending on the needs of a specific logistic process.

  - `remark` (string)
    Remark concerning the complete consignment, to be printed on the transport document.

  - `documents` (array)

  - `actors` (array)

  - `actions` (array)

  - `constraints` (array)
    In the context of a Consignment, constraints can be used to e.g. define minimum or maximum temperatures for consignments, or date time constraints for delivery.

  - `identifiers` (array)

  - `identifiers.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `identifiers.uuid` (string, required)

  - `identifiers.primaryPlatformId` (string, required)

  - `identifiers.language` (object)
    circular reference

  - `identifiers.name` (string)

  - `identifiers.system` (string)

  - `identifiers.value` (string)

  - `identifiers.expiredAt` (string)

  - `attributes` (array)

  - `attributes.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `attributes.uuid` (string, required)

  - `attributes.primaryPlatformId` (string, required)

  - `attributes.language` (object)
    circular reference

  - `attributes.name` (string)

  - `attributes.color` (string)

  - `externalAttributes` (object)

  - `expectedRevenue` (object)

  - `expectedRevenue.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `expectedRevenue.uuid` (string, required)

  - `expectedRevenue.primaryPlatformId` (string, required)

  - `expectedRevenue.language` (object)
    circular reference

  - `expectedRevenue.amount` (number)

  - `expectedRevenue.currency` (object)

  - `expectedRevenue.currency.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `expectedRevenue.currency.uuid` (string, required)

  - `expectedRevenue.currency.primaryPlatformId` (string, required)

  - `expectedRevenue.currency.language` (object)
    circular reference

  - `expectedRevenue.currency.name` (string)

  - `expectedRevenue.currency.short` (string)

  - `expectedRevenue.currency.sign` (string)

  - `expectedRevenue.currency.decimalDelimiter` (string)

  - `expectedRevenue.currency.thousandDelimiter` (string)

  - `expectedRevenue.currency.enabled` (boolean)

  - `expectedRevenue.taxRate` (object)

  - `expectedRevenue.taxRate.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `expectedRevenue.taxRate.creditCode` (string)

  - `expectedRevenue.taxRate.debitCode` (string)

  - `expectedRevenue.taxRate.identifiers` (array)

  - `expectedRevenue.taxRate.identifiers.nonce` (string)
    Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

  - `expectedRevenue.taxRate.identifiers.name` (string)

  - `expectedRevenue.taxRate.identifiers.system` (string)

  - `expectedRevenue.taxRate.identifiers.value` (string)

  - `expectedRevenue.taxRate.identifiers.expiredAt` (string)

  - `expectedRevenue.taxRate.name` (string)

  - `expectedRevenue.taxRate.description` (string)

  - `expectedRevenue.taxRate.jurisdiction` (string)

  - `expectedRevenue.taxRate.percentage` (number)

  - `expectedRevenue.taxRate.inclusive` (boolean)

  - `expectedRevenue.taxRate.active` (boolean)

  - `expectedRevenue.inclusiveOfTax` (boolean)

  - `expectedRevenue.moneyBuildBlocks` (array)

  - `expectedRevenue.moneyBuildBlocks.amount` (number)

  - `expectedRevenue.moneyBuildBlocks.relationship` (object)

  - `expectedRevenue.moneyBuildBlocks.relationship.entityId` (string)

  - `expectedRevenue.moneyBuildBlocks.relationship.entityType` (string)
    Enum: "action", "attachTransportEquipmentAction", "detachTransportEquipmentAction", "stopAction", "loadAction", "unloadAction", "waitAction", "consignment", "extendedConsignment", "transportEquipment", "extendedTransportEquipment", "items", "goods", "constraint", "actor", "location", "route", "sensor", "vehicle", "extendedVehicle", "trip", "fleet", "transportOrder", "extendedTransportOrder", "business", "event", "locationUpdateEvent", "startMovingEvent", "startWaitingEvent", "stopEngineEvent", "stopMovingEvent", "message", "document", "chauffeur", "extendedChauffeur", "chauffeurTimeslot", "chat", "user", "administration", "fleetVehicle", "messageAutomation", "capacity_contract", "booking", "invoice", "invoice_line", "quote", "quote_line", "integration", "calendarEvent", "to_do"

  - `hasAgreedToPrice` (boolean)
    Set this value to 'true' if the user has agreed to the pricing of this element. Only needed once the NeedsBillingApproval Exception is thrown

  - `versionNumber` (integer)

  - `nextPlanFromAction` (object)
    circular reference

## Response 200 fields (application/json):

  - `success` (boolean)

  - `message` (string)

  - `code` (integer)

  - `consignment` (object)

## Response 400 fields (application/json):

  - `success` (boolean)

  - `message` (string)

  - `code` (integer)

  - `errors` (array)

  - `suggestion` (string)