# Cancel consignment Cancel a consignment Endpoint: GET /consignment:cancel/{id} Version: 0.9.74 Security: bearer, apiKey, apiSecret ## Header parameters: - `Authorization` (string, required) ## Path parameters: - `id` (string, required) ## Response 200 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `consignment` (object) - `consignment.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `consignment.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. - `consignment.uuid` (string, required) - `consignment.primaryPlatformId` (string, required) - `consignment.createdAt` (string) The date and time this Entity has been created - `consignment.updatedAt` (string) The date and time this Entity has been updated - `consignment.language` (object) circular reference - `consignment.name` (string, required) Name of the Consignment. For display purposes and search only. - `consignment.consignmentNr` (string) - `consignment.description` (string) General description of consignment in Free text. e.g 20 europallets fruit. Meant for human inspection, not for automating processes. - `consignment.status` (string) Enum: "draft", "requested", "confirmed", "in_transit", "completed", "cancelled", "partially_planned", "planned", "partially_completed", "partially_in_transit", "concept" - `consignment.highValueGoods` (boolean) - `consignment.goods` (array) - `consignment.goods.associationType` (string) Enum: "inline", "reference" - `consignment.team` (object) circular reference - `consignment.combined` (boolean) - `consignment.consignment` (object) circular reference - `consignment.originalPhysicalSender` (object) circular reference - `consignment.originalLegalSender` (object) circular reference - `consignment.originalPhysicalAddressee` (object) circular reference - `consignment.originalLegalAddressee` (object) circular reference - `consignment.currentLocation` (object) circular reference - `consignment.currentLocation.administrativeReference` (object) - `consignment.currentLocation.administrativeReference.name` (string) - `consignment.currentLocation.administrativeReference.street` (string) - `consignment.currentLocation.administrativeReference.houseNumber` (string) - `consignment.currentLocation.administrativeReference.houseNumberAddition` (string) - `consignment.currentLocation.administrativeReference.postalCode` (string) - `consignment.currentLocation.administrativeReference.city` (string) - `consignment.currentLocation.administrativeReference.country` (string) - `consignment.currentLocation.lat` (number) - `consignment.currentLocation.lon` (number) - `consignment.currentLocation.speed` (object) - `consignment.currentLocation.speed.value` (string) - `consignment.currentLocation.speed.unit` (string) - `consignment.currentLocation.heading` (object) - `consignment.currentLocation.bearing` (object) - `consignment.currentLocation.bearingType` (string) Enum: "absolute", "relative" - `consignment.nextAction` (object) circular reference - `consignment.lastAction` (object) circular reference - `consignment.lastPlannedAction` (object) circular reference - `consignment.isPlannedToLastLocation` (boolean) - `consignment.type` (string) This field can be used to categorize and/or group shipments by type, depending on the needs of a specific logistic process. - `consignment.remark` (string) Remark concerning the complete consignment, to be printed on the transport document. - `consignment.documents` (array) - `consignment.actors` (array) - `consignment.actions` (array) - `consignment.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. - `consignment.identifiers` (array) - `consignment.identifiers.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `consignment.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. - `consignment.identifiers.uuid` (string, required) - `consignment.identifiers.primaryPlatformId` (string, required) - `consignment.identifiers.createdAt` (string) The date and time this Entity has been created - `consignment.identifiers.updatedAt` (string) The date and time this Entity has been updated - `consignment.identifiers.language` (object) circular reference - `consignment.identifiers.name` (string) - `consignment.identifiers.system` (string) - `consignment.identifiers.value` (string) - `consignment.identifiers.expiredAt` (string) - `consignment.attributes` (array) - `consignment.attributes.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `consignment.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. - `consignment.attributes.uuid` (string, required) - `consignment.attributes.primaryPlatformId` (string, required) - `consignment.attributes.createdAt` (string) The date and time this Entity has been created - `consignment.attributes.updatedAt` (string) The date and time this Entity has been updated - `consignment.attributes.language` (object) circular reference - `consignment.attributes.name` (string) - `consignment.attributes.color` (string) - `consignment.externalAttributes` (object) - `consignment.expectedRevenue` (object) - `consignment.expectedRevenue.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `consignment.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. - `consignment.expectedRevenue.uuid` (string, required) - `consignment.expectedRevenue.primaryPlatformId` (string, required) - `consignment.expectedRevenue.createdAt` (string) The date and time this Entity has been created - `consignment.expectedRevenue.updatedAt` (string) The date and time this Entity has been updated - `consignment.expectedRevenue.language` (object) circular reference - `consignment.expectedRevenue.amount` (number) - `consignment.expectedRevenue.currency` (object) - `consignment.expectedRevenue.currency.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `consignment.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. - `consignment.expectedRevenue.currency.uuid` (string, required) - `consignment.expectedRevenue.currency.primaryPlatformId` (string, required) - `consignment.expectedRevenue.currency.createdAt` (string) The date and time this Entity has been created - `consignment.expectedRevenue.currency.updatedAt` (string) The date and time this Entity has been updated - `consignment.expectedRevenue.currency.language` (object) circular reference - `consignment.expectedRevenue.currency.name` (string) - `consignment.expectedRevenue.currency.short` (string) - `consignment.expectedRevenue.currency.sign` (string) - `consignment.expectedRevenue.currency.decimalDelimiter` (string) - `consignment.expectedRevenue.currency.thousandDelimiter` (string) - `consignment.expectedRevenue.currency.enabled` (boolean) - `consignment.expectedRevenue.taxRate` (object) - `consignment.expectedRevenue.taxRate.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `consignment.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. - `consignment.expectedRevenue.taxRate.createdAt` (string) The date and time this Entity has been created - `consignment.expectedRevenue.taxRate.updatedAt` (string) The date and time this Entity has been updated - `consignment.expectedRevenue.taxRate.creditCode` (string) - `consignment.expectedRevenue.taxRate.debitCode` (string) - `consignment.expectedRevenue.taxRate.identifiers` (array) - `consignment.expectedRevenue.taxRate.identifiers.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `consignment.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. - `consignment.expectedRevenue.taxRate.identifiers.createdAt` (string) The date and time this Entity has been created - `consignment.expectedRevenue.taxRate.identifiers.updatedAt` (string) The date and time this Entity has been updated - `consignment.expectedRevenue.taxRate.identifiers.name` (string) - `consignment.expectedRevenue.taxRate.identifiers.system` (string) - `consignment.expectedRevenue.taxRate.identifiers.value` (string) - `consignment.expectedRevenue.taxRate.identifiers.expiredAt` (string) - `consignment.expectedRevenue.taxRate.name` (string) - `consignment.expectedRevenue.taxRate.description` (string) - `consignment.expectedRevenue.taxRate.jurisdiction` (string) - `consignment.expectedRevenue.taxRate.percentage` (number) - `consignment.expectedRevenue.taxRate.inclusive` (boolean) - `consignment.expectedRevenue.taxRate.active` (boolean) - `consignment.expectedRevenue.inclusiveOfTax` (boolean) - `consignment.expectedRevenue.moneyBuildBlocks` (array) - `consignment.expectedRevenue.moneyBuildBlocks.amount` (number) - `consignment.expectedRevenue.moneyBuildBlocks.relationship` (object) - `consignment.expectedRevenue.moneyBuildBlocks.relationship.entityId` (string) - `consignment.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" - `consignment.expectedCost` (object) - `consignment.expectedCost.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `consignment.expectedCost.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. - `consignment.expectedCost.uuid` (string, required) - `consignment.expectedCost.primaryPlatformId` (string, required) - `consignment.expectedCost.createdAt` (string) The date and time this Entity has been created - `consignment.expectedCost.updatedAt` (string) The date and time this Entity has been updated - `consignment.expectedCost.language` (object) circular reference - `consignment.expectedCost.amount` (number) - `consignment.expectedCost.currency` (object) - `consignment.expectedCost.taxRate` (object) - `consignment.expectedCost.inclusiveOfTax` (boolean) - `consignment.versionNumber` (integer) - `consignment.nextPlanFromAction` (object) circular reference ## Response 400 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `errors` (array) - `suggestion` (string)