PUDs

A PUD (pickup-and-delivery) is what we call a booking at Gire Mobility.

Create a test account to get started.

Test Account Setup

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 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
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
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
delete
/api/v3/puds/{id}

Update a PUD

You can update certain information about a PUD, like contact and vehicle information.

Update Pud

patch

Update a Pud by id

Path parameters
idstringRequired
Header parameters
x-api-tokenstringRequired

Company API key

Body
commentstringOptional

Comment

Example: Please handle with care
referenceNumberstringOptional

Reference number

Example: REF123456
hyreBookingIdstringOptional

Hyre booking id

Example: 123456
Responses
200

Pud updated

application/json
patch
/api/v3/puds/{id}

Get PUD

You can retrieve

Get Pud

get

Get Pud by id

Path parameters
idstringRequired
Header parameters
x-api-tokenstringRequired

Company API key

Responses
200

Pud found

application/json
get
/api/v3/puds/{id}

Get PUD list

get

Get PUD list for a company

Query parameters
pagenumberOptional

The page number to return

Default: 1Example: 1
pageSizenumberOptional

The number of items to return per page

Default: 10Example: 10
pickupDateFromstring · date-timeOptional

The date to filter by pickup date from

Example: 2025-01-01T00:00:00.000Z
pickupDateTostring · date-timeOptional

The date to filter by pickup date to

Example: 2025-12-01T00:00:00.000Z
searchstringOptional

The search query to filter by

Example: 123456
statusstringOptional

The status to filter by

Example: completed
sortBystringOptional

The field to sort by

Default: createdAtExample: createdAt
sortDirectionstringOptional

The direction to sort by

Default: descExample: desc
Header parameters
x-api-tokenstringRequired

Company API key

Responses
200

Pud list

application/json
get
/api/v3/puds/list
Deprecated

Get Puds

get

Get Puds for a company

Header parameters
x-api-tokenstringRequired

Company API key

Responses
200

Puds found

application/json
get
/api/v3/puds

Get Pud count

get

Get Pud count for a company

Header parameters
x-api-tokenstringRequired

Company API key

Responses
200

Pud count

application/json
get
/api/v3/puds/count
Booking restrictions

Last updated