# Update vehicle movement request

Updates specific details of a vehicle movement request by id. Omitting a property will leave it unchanged.

Endpoint: PATCH /movement-requests/{requestId}
Version: 1.0.0-alpha
Security: JigcarAPIAuth

## Path parameters:

  - `requestId` (string, required)
    Identifier for a movement request
    Example: "01K4NNVBR6J323BY6X26J62WA5"

## Request fields (application/json):

  - `origin` (object)
    The origin of the movement request

  - `origin.location` (any)
    The location the vehicle should be collected from

  - `origin.readyToCollectFromTimeslot` (string)
    The time of day the vehicle should be collected on
    Enum: "ANYTIME", "AM", "PM"

  - `origin.readyToCollectFromDate` (string)
    The date the vehicle can be collected from

  - `destination` (object)
    The destination of the movement request

  - `destination.location` (any)
    The location the vehicle should be delivered to

  - `destination.deliveryByTimeslot` (string)
    The time of day the vehicle should be delivered on
    Enum: "ANYTIME", "AM", "PM"

  - `destination.deliveryByDate` (string)
    The date the vehicle should be delivered by

  - `destination.deliverOnSpecifiedDate` (boolean)
    Whether the vehicle should be delivered on the specified date.

  - `notes` (string)
    Any important notes relating to the movement request
    Example: "I left snacks in the glove compartment"

## Response 200 fields (application/json):

  - `id` (string, required)
    The identifier for the vehicle movement request
    Example: "01K4NNVBR6J323BY6X26J62WA5"

  - `vehicle` (object, required)

  - `vehicle.vin` (string)
    The chassis number of the vehicle

  - `vehicle.vrm` (string)
    The car reg of the vehicle

  - `vehicle.make` (string)
    The make of the vehicle
    Example: "Mercedes-Benz"

  - `vehicle.model` (string)
    The model of the vehicle
    Example: "A-Class"

  - `vehicle.modelVariant` (string)
    the extended description of the vehicle
    Example: "A 180 AMG Line Executive Hatchback"

  - `origin` (object, required)
    The origin of the movement request

  - `origin.location` (any, required)
    The location the vehicle should be collected from

  - `origin.readyToCollectFromTimeslot` (string, required)
    The time of day the vehicle should be collected on
    Enum: "ANYTIME", "AM", "PM"

  - `origin.readyToCollectFromDate` (string, required)
    The date the vehicle can be collected from

  - `origin.estimatedCollectionTimeslot` (string)
    The estimated collection timeslot for the vehicle
    Enum: "ANYTIME", "AM", "PM"

  - `origin.estimatedCollectionDate` (string)
    The estimated collection date for the vehicle

  - `destination` (object, required)
    The destination of the movement request

  - `destination.location` (any, required)
    The location the vehicle should be delivered to

  - `destination.deliveryByTimeslot` (string, required)
    The time of day the vehicle should be delivered on
    Enum: "ANYTIME", "AM", "PM"

  - `destination.deliveryByDate` (string, required)
    The date the vehicle should be delivered by

  - `destination.deliverOnSpecifiedDate` (boolean)
    Whether the vehicle should be delivered on the specified date. Defaults to false.

  - `destination.estimatedDeliveryTimeslot` (string)
    The estimated delivery timeslot for the vehicle
    Enum: "ANYTIME", "AM", "PM"

  - `destination.estimatedDeliveryDate` (string)
    The estimated delivery date for the vehicle

  - `status` (string, required)
    The status of the movement request
    Enum: "CREATED", "SENT_TO_DRIVER", "SENT_TO_3PL", "SENT_TO_MARKETPLACE", "SENT_TO_MULTIPLE_DRIVERS", "ACCEPTED", "ACCEPTED_SENT_TO_DRIVER", "ACCEPTED_SENT_TO_3PL", "ACCEPTED_SENT_TO_MARKETPLACE", "PARTIALLY_PLANNED", "PLANNED", "IN_PROGRESS", "DELIVERED", "ABORTED"

  - `completedOn` (string)
    The date that the movement request was completed, if applicable

  - `businessArea` (string, required)
    Enum: "Retail", "Fleet"

  - `notes` (string)
    Any important notes relating to the movement request
    Example: "Talk to Kevin for keys"

  - `externalId` (string)
    Any external identifier you want to link with this movement request
    Example: "some-external-identifier"

  - `moDelInformation` (object)
    Key information for linking a Jigcar movement request to a MoDel job

  - `moDelInformation.pin` (string, required)
    the associated MoDel job pin
    Example: "some-model-pin"

  - `transportMethod` (string, required)
    Enum: "DRIVEN", "TRANSPORTED"

  - `provider` (any)

## Response 400 fields (application/problem+json):

  - `code` (string)
    Machine-readable error code
    Example: "INVALID_VRM"

  - `message` (string)
    Human-readable error message
    Example: "The provided VRM is invalid"

## Response 404 fields (application/problem+json):

  - `code` (string)
    Machine-readable error code
    Example: "VEHICLE_MOVEMENT_REQUEST_NOT_FOUND"

  - `message` (string)
    Human-readable error message
    Example: "A vehicle movement request with the provided ID cannot be found"

## Response 500 fields (application/json):

  - `code` (string, required)
    Enum: "INTERNAL_SERVER_ERROR"

  - `message` (string, required)
    Example: "We encountered an unexpected error trying to service your request. Please try again later."