PUDs
A PUD (pickup-and-delivery) is what we call a booking at Gire Mobility.
Create a PUD
To create a PUD you must specify the interval you wish to use. The opposite interval will then be calculated based on the estimated driving and handling time.


Create a Pud
Company API key
Comment
This is a commentHyre booking id
123456Reference number
123456Pud created
VALIDATION_ERROR
UNAUTHORIZED
BOOKING_BAN
BOOKING_BLOCKED
Unprocessable entity, multiple error types possible. See examples.
Create a Pud with immediate return. The interval type is for the outbound leg.
Company API key
Comment
This is a commentHyre booking id
123456Reference number
123456Immediate return Pud created
VALIDATION_ERROR
UNAUTHORIZED
BOOKING_BAN
BOOKING_BLOCKED
Unprocessable entity, multiple error types possible. See examples.
Cancel a PUD
You can cancel a PUD as long as it isn't in progress. However, you will only receive a refund if the cancellation happens more than 12 hours before the pickup time. Cancellations after this point are considered missed trips.
Cancel a Pud by id. If Pud is part of an immediate return Pud, both legs will be cancelled.
Company API key
Pud successfully cancelled
UNAUTHORIZED
NOT_FOUND
CANNOT_CANCEL_PUD
Update a PUD
You can update certain information about a PUD, like contact and vehicle information.
Update a Pud by id
Company API key
Comment
Please handle with careReference number
REF123456Hyre booking id
123456Pud updated
VALIDATION_ERROR
UNAUTHORIZED
NOT_FOUND
Get PUD
You can retrieve
Get PUD list for a company
The page number to return
1Example: 1The number of items to return per page
10Example: 10The date to filter by pickup date from
2025-01-01T00:00:00.000ZThe date to filter by pickup date to
2025-12-01T00:00:00.000ZThe search query to filter by
123456The status to filter by
completedThe field to sort by
createdAtExample: createdAtThe direction to sort by
descExample: descCompany API key
Pud list
VALIDATION_ERROR
UNAUTHORIZED
Last updated