🚗PUDs

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

NOTE: V3 is currently in the beta phase and is subject to change.

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.

Pickup interval

Delivery interval

Create Pud

Create a Pud

POST/api/v3/puds

Header parameters

Body

application/json

pickup*LocationReq (object)

delivery*LocationReq (object)

interval*IntervalReq (object)

vehicle*Vehicle (object)

customer*Customer (object)

commentstring

Comment

Example: "This is a comment"

hyreBookingIdstring

Hyre booking id

Example: "123456"

referenceNumberstring

Reference number

Example: "123456"

Response

201401

Pud created

Body

application/json

id*string

id

pickup*LocationRes (object)

delivery*LocationRes (object)

vehicle*Vehicle (object)

driver*Driver (object)

price*Price (object)

customer*Customer (object)

tripDetails*TripDetails (object)

status*enum

Status of the trip

Example: "completed"

newdelegatedin_progressmissed_tripcompletedcancelled

pickupCode*string (string)

Pickup code

Example: "ej8f"

createdAt*string (date-time)

Created at

updatedAt*string (date-time)

Updated at

hyreBookingIdstring

Hyre booking id

referenceNumberstring

Reference number

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/puds', {
    method: 'POST',
    headers: {
      "x-api-token": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pickup": {
        "address": "Møllergata 6",
        "postalCode": "0159"
      },
      "delivery": {
        "address": "Møllergata 6",
        "postalCode": "0159"
      },
      "interval": {
        "start": "2021-08-13T12:00:00Z",
        "end": "2021-08-13T14:00:00Z",
        "type": "pickup"
      },
      "vehicle": {
        "model": "Volkswagen Passat",
        "regNumber": "AB12345",
        "temporaryPlates": true
      },
      "customer": {
        "name": "John Doe",
        "phone": "[phone]"
      }
    }),
});
const data = await response.json();

Response

201401

{
  "id": "text",
  "pickup": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]",
    "interval": {
      "start": "2021-08-13T12:00:00Z",
      "end": "2021-08-13T14:00:00Z"
    }
  },
  "delivery": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]",
    "interval": {
      "start": "2021-08-13T12:00:00Z",
      "end": "2021-08-13T14:00:00Z"
    }
  },
  "vehicle": {
    "model": "Volkswagen Passat",
    "regNumber": "AB12345",
    "temporaryPlates": true
  },
  "driver": {
    "name": "The Stig",
    "phone": "[phone]",
    "photo": "https://example.com/photo.jpg"
  },
  "price": {
    "price": 1234,
    "currency": "NOK",
    "outOfArea": false
  },
  "customer": {
    "name": "John Doe",
    "phone": "[phone]",
    "email": "[e-mail]"
  },
  "tripDetails": {
    "preDrive": {
      "comment": "Car required a jump start",
      "mileage": 12345,
      "photos": [
        {
          "original": "https://example.com/original.jpg",
          "thumbnail": "https://example.com/thumbnail.jpg"
        }
      ]
    },
    "postDrive": {
      "comment": "Car required a jump start",
      "mileage": 12345,
      "photos": [
        {
          "original": "https://example.com/original.jpg",
          "thumbnail": "https://example.com/thumbnail.jpg"
        }
      ]
    },
    "startedAt": "2021-08-13T12:00:00Z",
    "endedAt": "2021-08-13T12:00:00Z"
  },
  "status": "completed",
  "pickupCode": "ej8f",
  "createdAt": "2025-01-21T04:08:50.001Z",
  "updatedAt": "2025-01-21T04:08:50.001Z",
  "hyreBookingId": "text",
  "referenceNumber": "text"
}

Create immediate return Pud

Create a Pud with immediate return. The interval type is for the outbound leg.

POST/api/v3/puds/immediate-return

Header parameters

Body

application/json

pickup*LocationReq (object)

delivery*LocationReq (object)

returnDelivery*LocationReq (object)

interval*IntervalReq (object)

vehicle*Vehicle (object)

returnVehicle*Vehicle (object)

customer*Customer (object)

commentstring

Comment

Example: "This is a comment"

hyreBookingIdstring

Hyre booking id

Example: "123456"

referenceNumberstring

Reference number

Example: "123456"

Response

201401

Immediate return Pud created

Body

application/json

outboundPud*Pud (object)

returnPud*Pud (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/puds/immediate-return', {
    method: 'POST',
    headers: {
      "x-api-token": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pickup": {
        "address": "Møllergata 6",
        "postalCode": "0159"
      },
      "delivery": {
        "address": "Møllergata 6",
        "postalCode": "0159"
      },
      "returnDelivery": {
        "address": "Møllergata 6",
        "postalCode": "0159"
      },
      "interval": {
        "start": "2021-08-13T12:00:00Z",
        "end": "2021-08-13T14:00:00Z",
        "type": "pickup"
      },
      "vehicle": {
        "model": "Volkswagen Passat",
        "regNumber": "AB12345",
        "temporaryPlates": true
      },
      "returnVehicle": {
        "model": "Volkswagen Passat",
        "regNumber": "AB12345",
        "temporaryPlates": true
      },
      "customer": {
        "name": "John Doe",
        "phone": "[phone]"
      }
    }),
});
const data = await response.json();

Response

201401

{
  "outboundPud": {
    "id": "text",
    "pickup": {
      "address": "Møllergata 6",
      "postalCode": "0159",
      "comment": "Please collect keys at the reception.",
      "contactName": "John Doe",
      "contactPhone": "[phone]",
      "interval": {
        "start": "2021-08-13T12:00:00Z",
        "end": "2021-08-13T14:00:00Z"
      }
    },
    "delivery": {
      "address": "Møllergata 6",
      "postalCode": "0159",
      "comment": "Please collect keys at the reception.",
      "contactName": "John Doe",
      "contactPhone": "[phone]",
      "interval": {
        "start": "2021-08-13T12:00:00Z",
        "end": "2021-08-13T14:00:00Z"
      }
    },
    "vehicle": {
      "model": "Volkswagen Passat",
      "regNumber": "AB12345",
      "temporaryPlates": true
    },
    "driver": {
      "name": "The Stig",
      "phone": "[phone]",
      "photo": "https://example.com/photo.jpg"
    },
    "price": {
      "price": 1234,
      "currency": "NOK",
      "outOfArea": false
    },
    "customer": {
      "name": "John Doe",
      "phone": "[phone]",
      "email": "[e-mail]"
    },
    "tripDetails": {
      "preDrive": {
        "comment": "Car required a jump start",
        "mileage": 12345,
        "photos": [
          {
            "original": "https://example.com/original.jpg",
            "thumbnail": "https://example.com/thumbnail.jpg"
          }
        ]
      },
      "postDrive": {
        "comment": "Car required a jump start",
        "mileage": 12345,
        "photos": [
          {
            "original": "https://example.com/original.jpg",
            "thumbnail": "https://example.com/thumbnail.jpg"
          }
        ]
      },
      "startedAt": "2021-08-13T12:00:00Z",
      "endedAt": "2021-08-13T12:00:00Z"
    },
    "status": "completed",
    "pickupCode": "ej8f",
    "createdAt": "2025-01-21T04:08:50.001Z",
    "updatedAt": "2025-01-21T04:08:50.001Z",
    "hyreBookingId": "text",
    "referenceNumber": "text"
  },
  "returnPud": {
    "id": "text",
    "pickup": {
      "address": "Møllergata 6",
      "postalCode": "0159",
      "comment": "Please collect keys at the reception.",
      "contactName": "John Doe",
      "contactPhone": "[phone]",
      "interval": {
        "start": "2021-08-13T12:00:00Z",
        "end": "2021-08-13T14:00:00Z"
      }
    },
    "delivery": {
      "address": "Møllergata 6",
      "postalCode": "0159",
      "comment": "Please collect keys at the reception.",
      "contactName": "John Doe",
      "contactPhone": "[phone]",
      "interval": {
        "start": "2021-08-13T12:00:00Z",
        "end": "2021-08-13T14:00:00Z"
      }
    },
    "vehicle": {
      "model": "Volkswagen Passat",
      "regNumber": "AB12345",
      "temporaryPlates": true
    },
    "driver": {
      "name": "The Stig",
      "phone": "[phone]",
      "photo": "https://example.com/photo.jpg"
    },
    "price": {
      "price": 1234,
      "currency": "NOK",
      "outOfArea": false
    },
    "customer": {
      "name": "John Doe",
      "phone": "[phone]",
      "email": "[e-mail]"
    },
    "tripDetails": {
      "preDrive": {
        "comment": "Car required a jump start",
        "mileage": 12345,
        "photos": [
          {
            "original": "https://example.com/original.jpg",
            "thumbnail": "https://example.com/thumbnail.jpg"
          }
        ]
      },
      "postDrive": {
        "comment": "Car required a jump start",
        "mileage": 12345,
        "photos": [
          {
            "original": "https://example.com/original.jpg",
            "thumbnail": "https://example.com/thumbnail.jpg"
          }
        ]
      },
      "startedAt": "2021-08-13T12:00:00Z",
      "endedAt": "2021-08-13T12:00:00Z"
    },
    "status": "completed",
    "pickupCode": "ej8f",
    "createdAt": "2025-01-21T04:08:50.001Z",
    "updatedAt": "2025-01-21T04:08:50.001Z",
    "hyreBookingId": "text",
    "referenceNumber": "text"
  }
}

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

Cancel a Pud by id. If Pud is part of an immediate return Pud, both legs will be cancelled.

DELETE/api/v3/puds/{id}

Path parameters

id*string

Header parameters

Response

200400401404

Pud successfully cancelled

Body

application/json

id*string

id

pickup*LocationRes (object)

delivery*LocationRes (object)

vehicle*Vehicle (object)

driver*Driver (object)

price*Price (object)

customer*Customer (object)

tripDetails*TripDetails (object)

status*enum

Status of the trip

Example: "completed"

newdelegatedin_progressmissed_tripcompletedcancelled

pickupCode*string (string)

Pickup code

Example: "ej8f"

createdAt*string (date-time)

Created at

updatedAt*string (date-time)

Updated at

hyreBookingIdstring

Hyre booking id

referenceNumberstring

Reference number

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/puds/{id}', {
    method: 'DELETE',
    headers: {
      "x-api-token": "text"
    },
});
const data = await response.json();

Response

200400401404

{
  "id": "text",
  "pickup": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]",
    "interval": {
      "start": "2021-08-13T12:00:00Z",
      "end": "2021-08-13T14:00:00Z"
    }
  },
  "delivery": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]",
    "interval": {
      "start": "2021-08-13T12:00:00Z",
      "end": "2021-08-13T14:00:00Z"
    }
  },
  "vehicle": {
    "model": "Volkswagen Passat",
    "regNumber": "AB12345",
    "temporaryPlates": true
  },
  "driver": {
    "name": "The Stig",
    "phone": "[phone]",
    "photo": "https://example.com/photo.jpg"
  },
  "price": {
    "price": 1234,
    "currency": "NOK",
    "outOfArea": false
  },
  "customer": {
    "name": "John Doe",
    "phone": "[phone]",
    "email": "[e-mail]"
  },
  "tripDetails": {
    "preDrive": {
      "comment": "Car required a jump start",
      "mileage": 12345,
      "photos": [
        {
          "original": "https://example.com/original.jpg",
          "thumbnail": "https://example.com/thumbnail.jpg"
        }
      ]
    },
    "postDrive": {
      "comment": "Car required a jump start",
      "mileage": 12345,
      "photos": [
        {
          "original": "https://example.com/original.jpg",
          "thumbnail": "https://example.com/thumbnail.jpg"
        }
      ]
    },
    "startedAt": "2021-08-13T12:00:00Z",
    "endedAt": "2021-08-13T12:00:00Z"
  },
  "status": "completed",
  "pickupCode": "ej8f",
  "createdAt": "2025-01-21T04:08:50.001Z",
  "updatedAt": "2025-01-21T04:08:50.001Z",
  "hyreBookingId": "text",
  "referenceNumber": "text"
}

---

Update a PUD

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

Update Pud

Update a Pud by id

PATCH/api/v3/puds/{id}

Path parameters

id*string

Header parameters

Body

application/json

customerUpdateCustomer (object)

pickupUpdateLocation (object)

deliveryUpdateLocation (object)

vehicleUpdateVehicle (object)

commentstring

Comment

Example: "Please handle with care"

referenceNumberstring

Reference number

Example: "REF123456"

hyreBookingIdstring

Hyre booking id

Example: "123456"

Response

200401404

Pud updated

Body

application/json

id*string

id

pickup*LocationRes (object)

delivery*LocationRes (object)

vehicle*Vehicle (object)

driver*Driver (object)

price*Price (object)

customer*Customer (object)

tripDetails*TripDetails (object)

status*enum

Status of the trip

Example: "completed"

newdelegatedin_progressmissed_tripcompletedcancelled

pickupCode*string (string)

Pickup code

Example: "ej8f"

createdAt*string (date-time)

Created at

updatedAt*string (date-time)

Updated at

hyreBookingIdstring

Hyre booking id

referenceNumberstring

Reference number

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/puds/{id}', {
    method: 'PATCH',
    headers: {
      "x-api-token": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401404

{
  "id": "text",
  "pickup": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]",
    "interval": {
      "start": "2021-08-13T12:00:00Z",
      "end": "2021-08-13T14:00:00Z"
    }
  },
  "delivery": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]",
    "interval": {
      "start": "2021-08-13T12:00:00Z",
      "end": "2021-08-13T14:00:00Z"
    }
  },
  "vehicle": {
    "model": "Volkswagen Passat",
    "regNumber": "AB12345",
    "temporaryPlates": true
  },
  "driver": {
    "name": "The Stig",
    "phone": "[phone]",
    "photo": "https://example.com/photo.jpg"
  },
  "price": {
    "price": 1234,
    "currency": "NOK",
    "outOfArea": false
  },
  "customer": {
    "name": "John Doe",
    "phone": "[phone]",
    "email": "[e-mail]"
  },
  "tripDetails": {
    "preDrive": {
      "comment": "Car required a jump start",
      "mileage": 12345,
      "photos": [
        {
          "original": "https://example.com/original.jpg",
          "thumbnail": "https://example.com/thumbnail.jpg"
        }
      ]
    },
    "postDrive": {
      "comment": "Car required a jump start",
      "mileage": 12345,
      "photos": [
        {
          "original": "https://example.com/original.jpg",
          "thumbnail": "https://example.com/thumbnail.jpg"
        }
      ]
    },
    "startedAt": "2021-08-13T12:00:00Z",
    "endedAt": "2021-08-13T12:00:00Z"
  },
  "status": "completed",
  "pickupCode": "ej8f",
  "createdAt": "2025-01-21T04:08:50.001Z",
  "updatedAt": "2025-01-21T04:08:50.001Z",
  "hyreBookingId": "text",
  "referenceNumber": "text"
}

---

Get PUD

You can retrieve

Get Pud

Get Pud by id

GET/api/v3/puds/{id}

Path parameters

id*string

Header parameters

Response

200401404

Pud found

Body

application/json

id*string

id

pickup*LocationRes (object)

delivery*LocationRes (object)

vehicle*Vehicle (object)

driver*Driver (object)

price*Price (object)

customer*Customer (object)

tripDetails*TripDetails (object)

status*enum

Status of the trip

Example: "completed"

newdelegatedin_progressmissed_tripcompletedcancelled

pickupCode*string (string)

Pickup code

Example: "ej8f"

createdAt*string (date-time)

Created at

updatedAt*string (date-time)

Updated at

hyreBookingIdstring

Hyre booking id

referenceNumberstring

Reference number

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/puds/{id}', {
    method: 'GET',
    headers: {
      "x-api-token": "text"
    },
});
const data = await response.json();

Response

200401404

{
  "id": "text",
  "pickup": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]",
    "interval": {
      "start": "2021-08-13T12:00:00Z",
      "end": "2021-08-13T14:00:00Z"
    }
  },
  "delivery": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]",
    "interval": {
      "start": "2021-08-13T12:00:00Z",
      "end": "2021-08-13T14:00:00Z"
    }
  },
  "vehicle": {
    "model": "Volkswagen Passat",
    "regNumber": "AB12345",
    "temporaryPlates": true
  },
  "driver": {
    "name": "The Stig",
    "phone": "[phone]",
    "photo": "https://example.com/photo.jpg"
  },
  "price": {
    "price": 1234,
    "currency": "NOK",
    "outOfArea": false
  },
  "customer": {
    "name": "John Doe",
    "phone": "[phone]",
    "email": "[e-mail]"
  },
  "tripDetails": {
    "preDrive": {
      "comment": "Car required a jump start",
      "mileage": 12345,
      "photos": [
        {
          "original": "https://example.com/original.jpg",
          "thumbnail": "https://example.com/thumbnail.jpg"
        }
      ]
    },
    "postDrive": {
      "comment": "Car required a jump start",
      "mileage": 12345,
      "photos": [
        {
          "original": "https://example.com/original.jpg",
          "thumbnail": "https://example.com/thumbnail.jpg"
        }
      ]
    },
    "startedAt": "2021-08-13T12:00:00Z",
    "endedAt": "2021-08-13T12:00:00Z"
  },
  "status": "completed",
  "pickupCode": "ej8f",
  "createdAt": "2025-01-21T04:08:50.001Z",
  "updatedAt": "2025-01-21T04:08:50.001Z",
  "hyreBookingId": "text",
  "referenceNumber": "text"
}

Get Puds

Get Puds for a company

GET/api/v3/puds

Header parameters

Response

200401

Puds found

Body

application/json

id*string

id

pickup*LocationRes (object)

delivery*LocationRes (object)

vehicle*Vehicle (object)

driver*Driver (object)

price*Price (object)

customer*Customer (object)

tripDetails*TripDetails (object)

status*enum

Status of the trip

Example: "completed"

newdelegatedin_progressmissed_tripcompletedcancelled

pickupCode*string (string)

Pickup code

Example: "ej8f"

createdAt*string (date-time)

Created at

updatedAt*string (date-time)

Updated at

hyreBookingIdstring

Hyre booking id

referenceNumberstring

Reference number

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/puds', {
    method: 'GET',
    headers: {
      "x-api-token": "text"
    },
});
const data = await response.json();

Response

200401

[
  {
    "id": "text",
    "pickup": {
      "address": "Møllergata 6",
      "postalCode": "0159",
      "comment": "Please collect keys at the reception.",
      "contactName": "John Doe",
      "contactPhone": "[phone]",
      "interval": {
        "start": "2021-08-13T12:00:00Z",
        "end": "2021-08-13T14:00:00Z"
      }
    },
    "delivery": {
      "address": "Møllergata 6",
      "postalCode": "0159",
      "comment": "Please collect keys at the reception.",
      "contactName": "John Doe",
      "contactPhone": "[phone]",
      "interval": {
        "start": "2021-08-13T12:00:00Z",
        "end": "2021-08-13T14:00:00Z"
      }
    },
    "vehicle": {
      "model": "Volkswagen Passat",
      "regNumber": "AB12345",
      "temporaryPlates": true
    },
    "driver": {
      "name": "The Stig",
      "phone": "[phone]",
      "photo": "https://example.com/photo.jpg"
    },
    "price": {
      "price": 1234,
      "currency": "NOK",
      "outOfArea": false
    },
    "customer": {
      "name": "John Doe",
      "phone": "[phone]",
      "email": "[e-mail]"
    },
    "tripDetails": {
      "preDrive": {
        "comment": "Car required a jump start",
        "mileage": 12345,
        "photos": [
          {
            "original": "https://example.com/original.jpg",
            "thumbnail": "https://example.com/thumbnail.jpg"
          }
        ]
      },
      "postDrive": {
        "comment": "Car required a jump start",
        "mileage": 12345,
        "photos": [
          {
            "original": "https://example.com/original.jpg",
            "thumbnail": "https://example.com/thumbnail.jpg"
          }
        ]
      },
      "startedAt": "2021-08-13T12:00:00Z",
      "endedAt": "2021-08-13T12:00:00Z"
    },
    "status": "completed",
    "pickupCode": "ej8f",
    "createdAt": "2025-01-21T04:08:50.001Z",
    "updatedAt": "2025-01-21T04:08:50.001Z",
    "hyreBookingId": "text",
    "referenceNumber": "text"
  }
]

Get Pud count

Get Pud count for a company

GET/api/v3/puds/count

Header parameters

Response

200401

Pud count

Body

application/json

number

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/puds/count', {
    method: 'GET',
    headers: {
      "x-api-token": "text"
    },
});
const data = await response.json();

Response

200401

0

Booking restrictions