Transit
Transit tickets (bus, rail, boat, air, tram).
Create a transit template
Creates a transit template (bus, train, boat, air, tram or generic) and its Apple Wallet and Google Wallet pass template. Send the request as `multipart/form-data` with the `strip` image (required); the template's `number` is the default trip number of its passes.
List transit templates
Lists, page by page, the wallet's transit templates of a given type (`type` is required: `Bus`, `Boat`, `Train`, `Air`, `Generic` or `Tram`).
Update a transit template
Updates a transit template; passes already installed are updated. Holders are notified according to the `UPDATE_TRANSIT` notification template. Accepts `multipart/form-data` (new `strip` image) or `application/json`.
Delete a transit template
Deletes a transit template and its pass template. Deletion is refused (`400 HOTEL_HAS_PASSES`) while passes exist for this template.
Get a transit template
Returns one of the wallet's transit templates by its ID.
Create a transit pass
Creates a transit ticket for a traveller from a transit template and returns its ID, barcode and download link (`downloadLink`). With `enableSendEmailOrSms: true`, the ticket is also sent by email or SMS (`email` or `phoneNumber`).
List the passes of a transit
Lists, page by page, the passes of a transit template, with filters on status, creation date and search. Each pass includes `departureDateTime`, `arrivalDateTime` (format `dd-MM-yyyy HH:mm`) and the device types it is installed on (`devices`).
Get a transit pass
Returns a transit ticket by its ID.
Update a transit pass
Updates a transit ticket (traveller, trip, times, seat, barcode…) and the installed pass. The holder is notified according to the `UPDATE_TRANSIT` template and their preferences; a request with no change returns the pass as is.
Get a transit pass by barcode
Returns a transit ticket by its barcode, for example during a ticket check.
Update the status of a transit pass by barcode
Marks a transit ticket as used (`status: USED`) or cancels that validation (`status: UNUSED`), by its barcode. The installed pass is updated without notification; returns `PASS_ALREADY_REDEEMED` or `PASS_NOT_REDEEMED` when the status does not change.
Get transit statistics
Returns statistics on the wallet's transit tickets: total (`totalCustomers`), active (`totalActifCustomers`) and redeemed (`redeemedPassesCount`). Filter by template, transit type or creation period.
Bulk create transit passes
Processed asynchronously. Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.
Bulk update transit passes
Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.
Bulk delete transit passes
Returns a bulk operation: track its status and results with `GET /bulk-operations/{operationId}`.
Update a trip
Updates the transit passes that share this trip number.
Notify the holders of a trip
Sends a notification to the holders of the passes with this trip number.