# Update a shipment event

Update the event of the given event type.

Endpoint: PUT /cargosoft/shipment/{shipmentId}/event/{id}
Version: 2025.1
Security: JavaWebToken

## Path parameters:

  - `shipmentId` (integer, required)

  - `id` (string, required)
    Database id of the record you want to update.
    Enum: "DISPATCH", "PICKUP", "WAREHOUSE", "POL_ARRIVAL", "LOADING_START", "LOADING_END", "POL_DEPARTURE", "POD_ARRIVAL", "CLEARANCE_START", "CLEARANCE_END", "CUSTOMS_CLEARANCE", "AVAILABLE", "ACCEPTANCE", "FINAL_DESTINATION", "TRANSSHIPMENT", "GATE_OUT", "POD_DEPARTURE", "CUSTOMS_RELEASE", "DELIVERY_DATE", "POL_DEPARTURE_REVISED", "POD_ARRIVAL_REVISED", "TRANSSHIPMENT_ARRIVAL", "TRANSSHIPMENT_DEPARTURE", "DIFF_BL_DATE", "VGM_CLOSING"

## Query parameters:

  - `type` (string)
    The following list will give an overview about the event types and a short description.
    Enum: "ACTUAL", "ESTIMATED"

## Request fields (application/json):

  - `event` (string)
    The event code of this shipment event. The code describes the functional meaning of the event date and time.
    Enum: "DISPATCH", "PICKUP", "WAREHOUSE", "POL_ARRIVAL", "LOADING_START", "LOADING_END", "POL_DEPARTURE", "POD_ARRIVAL", "CLEARANCE_START", "CLEARANCE_END", "CUSTOMS_CLEARANCE", "AVAILABLE", "ACCEPTANCE", "FINAL_DESTINATION", "TRANSSHIPMENT", "GATE_OUT", "POD_DEPARTURE", "CUSTOMS_RELEASE", "DELIVERY_DATE", "POL_DEPARTURE_REVISED", "POD_ARRIVAL_REVISED", "TRANSSHIPMENT_ARRIVAL", "TRANSSHIPMENT_DEPARTURE", "DIFF_BL_DATE", "VGM_CLOSING"

  - `type` (string)
    The event type of this shipment event. The event type describes if the event date and time is estimated or actual.
    Enum: "ACTUAL", "ESTIMATED"

  - `shipment_id` (integer)
    The id of the Shipment.

  - `date_time` (object)
    The date and time of this event.

  - `date_time.date` (string)
    The date.

  - `date_time.time` (object)
    The time.

  - `date_time.time.hour` (integer)

  - `date_time.time.minute` (integer)

  - `date_time.time.second` (integer)

  - `date_time.time.nano` (integer)

  - `date_time.zone_offset` (object)
    The UTC time zone of this date and time.

  - `date_time.zone_offset.totalSeconds` (integer)

  - `date_time.zone_offset.id` (string)

  - `date_time.zone_offset.rules` (object)

  - `date_time.zone_offset.rules.fixedOffset` (boolean)

  - `date_time.zone_offset.rules.transitions` (array)

  - `date_time.zone_offset.rules.transitions.offsetBefore` (object)

  - `date_time.zone_offset.rules.transitions.offsetAfter` (object)

  - `date_time.zone_offset.rules.transitions.overlap` (boolean)

  - `date_time.zone_offset.rules.transitions.instant` (string)

  - `date_time.zone_offset.rules.transitions.duration` (object)

  - `date_time.zone_offset.rules.transitions.duration.seconds` (integer)

  - `date_time.zone_offset.rules.transitions.duration.zero` (boolean)

  - `date_time.zone_offset.rules.transitions.duration.negative` (boolean)

  - `date_time.zone_offset.rules.transitions.duration.positive` (boolean)

  - `date_time.zone_offset.rules.transitions.duration.units` (array)

  - `date_time.zone_offset.rules.transitions.duration.units.durationEstimated` (boolean)

  - `date_time.zone_offset.rules.transitions.duration.units.timeBased` (boolean)

  - `date_time.zone_offset.rules.transitions.duration.units.dateBased` (boolean)

  - `date_time.zone_offset.rules.transitions.gap` (boolean)

  - `date_time.zone_offset.rules.transitions.dateTimeAfter` (string)

  - `date_time.zone_offset.rules.transitions.dateTimeBefore` (string)

  - `date_time.zone_offset.rules.transitionRules` (array)

  - `date_time.zone_offset.rules.transitionRules.month` (string)
    Enum: "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"

  - `date_time.zone_offset.rules.transitionRules.timeDefinition` (string)
    Enum: "UTC", "WALL", "STANDARD"

  - `date_time.zone_offset.rules.transitionRules.standardOffset` (object)

  - `date_time.zone_offset.rules.transitionRules.dayOfWeek` (string)
    Enum: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"

  - `date_time.zone_offset.rules.transitionRules.dayOfMonthIndicator` (integer)

  - `date_time.zone_offset.rules.transitionRules.localTime` (object)

  - `date_time.zone_offset.rules.transitionRules.midnightEndOfDay` (boolean)

  - `date_time.until` (object)
    Optional time range. Only for Event types: PICKUP and FINAL_DESTINATION

  - `location` (object)
    The location of this event.

  - `location.codes` (array)
    A list of all location codes and their types of this location.

  - `location.codes.type` (string, required)
    The type of this location code.
    Enum: "CARGOSOFT", "UNLOC", "IATA", "FOREIGN", "POSTAL_CODE", "UN_COUNTRY"

  - `location.codes.code` (string, required)
    The code of this location.

  - `location.name` (string)
    The written name of this location.

  - `location.latitude` (number)
    The latitude of this location.

  - `location.longitude` (number)
    The longitude of this location.

## Response 200 fields (application/json):

  - `event` (string)
    The event code of this shipment event. The code describes the functional meaning of the event date and time.
    Enum: "DISPATCH", "PICKUP", "WAREHOUSE", "POL_ARRIVAL", "LOADING_START", "LOADING_END", "POL_DEPARTURE", "POD_ARRIVAL", "CLEARANCE_START", "CLEARANCE_END", "CUSTOMS_CLEARANCE", "AVAILABLE", "ACCEPTANCE", "FINAL_DESTINATION", "TRANSSHIPMENT", "GATE_OUT", "POD_DEPARTURE", "CUSTOMS_RELEASE", "DELIVERY_DATE", "POL_DEPARTURE_REVISED", "POD_ARRIVAL_REVISED", "TRANSSHIPMENT_ARRIVAL", "TRANSSHIPMENT_DEPARTURE", "DIFF_BL_DATE", "VGM_CLOSING"

  - `type` (string)
    The event type of this shipment event. The event type describes if the event date and time is estimated or actual.
    Enum: "ACTUAL", "ESTIMATED"

  - `shipment_id` (integer)
    The id of the Shipment.

  - `date_time` (object)
    The date and time of this event.

  - `date_time.date` (string)
    The date.

  - `date_time.time` (object)
    The time.

  - `date_time.time.hour` (integer)

  - `date_time.time.minute` (integer)

  - `date_time.time.second` (integer)

  - `date_time.time.nano` (integer)

  - `date_time.zone_offset` (object)
    The UTC time zone of this date and time.

  - `date_time.zone_offset.totalSeconds` (integer)

  - `date_time.zone_offset.id` (string)

  - `date_time.zone_offset.rules` (object)

  - `date_time.zone_offset.rules.fixedOffset` (boolean)

  - `date_time.zone_offset.rules.transitions` (array)

  - `date_time.zone_offset.rules.transitions.offsetBefore` (object)

  - `date_time.zone_offset.rules.transitions.offsetAfter` (object)

  - `date_time.zone_offset.rules.transitions.overlap` (boolean)

  - `date_time.zone_offset.rules.transitions.instant` (string)

  - `date_time.zone_offset.rules.transitions.duration` (object)

  - `date_time.zone_offset.rules.transitions.duration.seconds` (integer)

  - `date_time.zone_offset.rules.transitions.duration.zero` (boolean)

  - `date_time.zone_offset.rules.transitions.duration.negative` (boolean)

  - `date_time.zone_offset.rules.transitions.duration.positive` (boolean)

  - `date_time.zone_offset.rules.transitions.duration.units` (array)

  - `date_time.zone_offset.rules.transitions.duration.units.durationEstimated` (boolean)

  - `date_time.zone_offset.rules.transitions.duration.units.timeBased` (boolean)

  - `date_time.zone_offset.rules.transitions.duration.units.dateBased` (boolean)

  - `date_time.zone_offset.rules.transitions.gap` (boolean)

  - `date_time.zone_offset.rules.transitions.dateTimeAfter` (string)

  - `date_time.zone_offset.rules.transitions.dateTimeBefore` (string)

  - `date_time.zone_offset.rules.transitionRules` (array)

  - `date_time.zone_offset.rules.transitionRules.month` (string)
    Enum: "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"

  - `date_time.zone_offset.rules.transitionRules.timeDefinition` (string)
    Enum: "UTC", "WALL", "STANDARD"

  - `date_time.zone_offset.rules.transitionRules.standardOffset` (object)

  - `date_time.zone_offset.rules.transitionRules.dayOfWeek` (string)
    Enum: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"

  - `date_time.zone_offset.rules.transitionRules.dayOfMonthIndicator` (integer)

  - `date_time.zone_offset.rules.transitionRules.localTime` (object)

  - `date_time.zone_offset.rules.transitionRules.midnightEndOfDay` (boolean)

  - `date_time.until` (object)
    Optional time range. Only for Event types: PICKUP and FINAL_DESTINATION

  - `location` (object)
    The location of this event.

  - `location.codes` (array)
    A list of all location codes and their types of this location.

  - `location.codes.type` (string, required)
    The type of this location code.
    Enum: "CARGOSOFT", "UNLOC", "IATA", "FOREIGN", "POSTAL_CODE", "UN_COUNTRY"

  - `location.codes.code` (string, required)
    The code of this location.

  - `location.name` (string)
    The written name of this location.

  - `location.latitude` (number)
    The latitude of this location.

  - `location.longitude` (number)
    The longitude of this location.