BNbnsf
Requests

​​AddHold Request - Haulway or OEM will have the capability to add hold on VIN at Origin or Destination ("O" or "D")

post/v1/vehicles/addHold

Request

Request body

automotiveVehicleHoldChangeRequestedByIdstring required

Identifier of the entity that has requested a hold status change for automotive vehicles (by VIN). Values originate from other sources and may include SCAC, Manufacturer ID, etc.

automotiveHoldOriginDestinationCodestring required

Code that defines if the associated Automotive hold information relates to an origin or destination location.

vinListstring[] required

Comma separated list of VIN (Vehicle Identification Numbers).

Example request

{
  "automotiveVehicleHoldChangeRequestedById": "ABCD",
  "automotiveHoldOriginDestinationCode": "O (Origin)",
  "vinList": [
    "12345678901234567"
  ]
}

Response

OK

The request has succeeded.

vinHoldResponseMessageTextstring

Example response

{
  "vinHoldResponseMessageText": "ACCEPTED HOLD REQUEST"
}

Changes

No recorded changes to this operation across all 1 revision of this API.