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 Pud
post
Create a Pud
Header parameters
x-api-tokenstringRequired
Company API key
Body
commentstringOptional
Comment
Example: This is a comment
hyreBookingIdstringOptional
Hyre booking id
Example: 123456
referenceNumberstringOptional
Reference number
Example: 123456
Responses
201
Pud created
application/json
400
VALIDATION_ERROR
application/json
401
UNAUTHORIZED
application/json
403
BOOKING_BAN
application/json
409
BOOKING_BLOCKED
application/json
422
Unprocessable entity, multiple error types possible. See examples.
application/json
post
/api/v3/puds
Create immediate return Pud
post
Create a Pud with immediate return. The interval type is for the outbound leg.
Header parameters
x-api-tokenstringRequired
Company API key
Body
commentstringOptional
Comment
Example: This is a comment
hyreBookingIdstringOptional
Hyre booking id
Example: 123456
referenceNumberstringOptional
Reference number
Example: 123456
Responses
201
Immediate return Pud created
application/json
400
VALIDATION_ERROR
application/json
401
UNAUTHORIZED
application/json
403
BOOKING_BAN
application/json
409
BOOKING_BLOCKED
application/json
422
Unprocessable entity, multiple error types possible. See examples.
application/json
post
/api/v3/puds/immediate-return
Immediate return bookings are eligible for a 25% discount:
✅ A-B-A bookings
✅ A-B-C bookings (within standard delivery area)
❌ A-B-C bookings (one or more locations outside standard delivery area)
For an immediate return PUD, the interval type specified is for the first leg of the trip.
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 Pud
delete
Cancel a Pud by id. If Pud is part of an immediate return Pud, both legs will be cancelled.
Path parameters
idstringRequired
Header parameters
x-api-tokenstringRequired
Company API key
Responses
200
Pud successfully cancelled
application/json
401
UNAUTHORIZED
application/json
404
NOT_FOUND
application/json
409
CANNOT_CANCEL_PUD
application/json
delete
/api/v3/puds/{id}
Update a PUD
You can update certain information about a PUD, like contact and vehicle information.