Vehicles

These events are emitted by the Inventory API (btrz-api-inventory) when vehicles are created, updated, or deleted, or when seatmaps are assigned to or removed from vehicles.

Events

Action Event name Endpoint
Create a new vehicle vehicles.created POST /vehicles
Update an existing vehicle vehicles.updated PUT /vehicles/:vehicleId
Delete an existing vehicle vehicles.deleted DELETE /vehicles/:vehicleId
Add a seatmap to a vehicle vehicles-seatmaps.created POST /vehicles/:vehicleId/seatmaps
Remove a seatmap from a vehicle vehicles-seatmaps.deleted DELETE /vehicles/:vehicleId/seatmaps/:seatMapId

Payload example created

{
  "attemptId": "7ad024e1-ec8c-4220-a92e-9b41f89ad0f7",
  "created": 1623794744,
  "data": {
    "_id": "66856ea00e02db052335a3f2",
    "accountId": "595f9c7007ee12686d000032",
    "brand": "Mercedes",
    "capacity": 50,
    "certification": "LS123",
    "createdAt": {
      "offset": 0,
      "value": "2024-07-03T15:30:40.675Z"
    },
    "createdBy": "60a7b2205cc92c3a91136330",
    "deleted": false,
    "disabled": false,
    "garageId": null,
    "internalId": "test bus 123",
    "licensePlate": "CJQ123",
    "name": "Test bus 123",
    "updatedAt": {
      "offset": 0,
      "value": "2024-07-03T15:30:40.675Z"
    },
    "updatedBy": "60a7b2205cc92c3a91136330",
    "userId": "60a7b2205cc92c3a91136330"
  },
  "event": "vehicles.created",
  "id": "8633ddb4-bcbe-4c00-940f-de701a24636b",
  "livemode": true
}

Payload data fields (vehicles.created / vehicles.updated)

Field Type Description
_id string Vehicle id (24 hex characters).
accountId string Account id.
name string The name of the vehicle (max 50 chars).
capacity integer The capacity for the vehicle (0–10000).
licensePlate string The license plates of the vehicle.
certification string The certification for the vehicle.
brand string The brand of the vehicle.
disabled boolean Whether the vehicle is available or not.
garageId string The id of the garage where the vehicle is (ObjectId or null).
internalId string Internal identifier.
externalId string The external id (max 50 chars).
amenityGroupId string The id of the amenity group (ObjectId).
brandId string The id of the brand (ObjectId).
number integer An identifiable number for the vehicle.
deleted boolean Whether the vehicle is soft-deleted.
createdBy string User id that created this resource.
updatedBy string User id that last updated this resource.
userId string User id.
createdAt object BzDate — when the object was created.
updatedAt object BzDate — when the object was last updated.

Payload example updated

{
  "attemptId": "457e1f4e-e685-4d08-9738-818fb38829a7",
  "created": 1623794744,
  "data": {
    "_id": "66856ea00e02db052335a3f2",
    "accountId": "595f9c7007ee12686d000032",
    "brand": "Mercedes",
    "capacity": 56,
    "certification": "LS123",
    "createdAt": {
      "offset": 0,
      "value": "2024-07-03T15:30:40.675Z"
    },
    "createdBy": "60a7b2205cc92c3a91136330",
    "deleted": false,
    "disabled": false,
    "garageId": null,
    "internalId": "test bus 123",
    "licensePlate": "CJQ123",
    "name": "Test bus 123",
    "updatedAt": {
      "offset": 0,
      "value": "2024-07-03T15:32:06.928Z"
    },
    "updatedBy": "60a7b2205cc92c3a91136330",
    "userId": "60a7b2205cc92c3a91136330"
  },
  "event": "vehicles.updated",
  "id": "ed4ee811-064e-478f-b39b-035d4debb53a",
  "livemode": true
}

Payload example deleted

{
  "attemptId": "d395e790-8a46-4135-b5c9-2a8296586260",
  "created": 1623794746,
  "data": {
    "vehicleId": "60c9240ee722473f73196c7b"
  },
  "event": "vehicles.deleted",
  "id": "76e936d2-f3a3-4618-8446-062e609f18ea",
  "livemode": true
}

Payload data fields (vehicles.deleted)

Field Type Description
vehicleId string Id of the deleted vehicle (24 hex).

Payload example seatmap added

{
  "attemptId": "d395e790-8a46-4135-b5c9-2a8296586260",
  "created": 1623794746,
  "data": {
    "vehicleId": "60c9240ee722473f73196c7b",
    "seatMapId": "60c9240ee722473f73196c7d",
  },
  "event": "vehicles-seatmaps.created",
  "id": "76e936d2-f3a3-4618-8446-062e609f18ea",
  "livemode": true
}

Payload data fields (vehicles-seatmaps.created / vehicles-seatmaps.deleted)

Field Type Description
vehicleId string Vehicle id (24 hex).
seatMapId string Seatmap id (24 hex).

Payload example seatmap removed

{
  "attemptId": "d395e790-8a46-4135-b5c9-2a8296586260",
  "created": 1623794746,
  "data": {
    "vehicleId": "60c9240ee722473f73196c7b",
    "seatMapId": "60c9240ee722473f73196c7d"
  },
  "event": "vehicles-seatmaps.deleted",
  "id": "76e936d2-f3a3-4618-8446-062e609f18ea",
  "livemode": true
}