🚗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.

Pickup interval

Delivery interval

Create Pud

post

Create a Pud

Header parameters

x-api-tokenstringRequired

Company API key

Body

pickupobjectRequired

deliveryobjectRequired

intervalobjectRequired

vehicleobjectRequired

customerobjectRequired

commentstringOptional

Comment

Example: This is a comment

hyreBookingIdstringOptional

Hyre booking id

Example: 123456

referenceNumberstringOptional

Reference number

Example: 123456

Responses

application/json

objectOptional

application/json

post

HTTPcURLJavaScriptPython

POST /api/v3/puds HTTP/1.1
Host: 
x-api-token: text
Content-Type: application/json
Accept: */*
Content-Length: 664

{
  "pickup": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]"
  },
  "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",
    "type": "pickup"
  },
  "vehicle": {
    "model": "Volkswagen Passat",
    "regNumber": "AB12345",
    "temporaryPlates": true
  },
  "customer": {
    "name": "John Doe",
    "phone": "[phone]",
    "email": "[e-mail]"
  },
  "comment": "This is a comment",
  "hyreBookingId": "123456",
  "referenceNumber": "123456"
}

{
  "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-04-18T16:58:08.528Z",
  "updatedAt": "2025-04-18T16:58:08.528Z",
  "hyreBookingId": "text",
  "referenceNumber": "text"
}

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

pickupobjectRequired

deliveryobjectRequired

returnDeliveryobjectRequired

intervalobjectRequired

vehicleobjectRequired

returnVehicleobjectRequired

customerobjectRequired

commentstringOptional

Comment

Example: This is a comment

hyreBookingIdstringOptional

Hyre booking id

Example: 123456

referenceNumberstringOptional

Reference number

Example: 123456

Responses

application/json

objectOptional

application/json

post

HTTPcURLJavaScriptPython

POST /api/v3/puds/immediate-return HTTP/1.1
Host: 
x-api-token: text
Content-Type: application/json
Accept: */*
Content-Length: 924

{
  "pickup": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]"
  },
  "delivery": {
    "address": "Møllergata 6",
    "postalCode": "0159",
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]"
  },
  "returnDelivery": {
    "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",
    "type": "pickup"
  },
  "vehicle": {
    "model": "Volkswagen Passat",
    "regNumber": "AB12345",
    "temporaryPlates": true
  },
  "returnVehicle": {
    "model": "Volkswagen Passat",
    "regNumber": "AB12345",
    "temporaryPlates": true
  },
  "customer": {
    "name": "John Doe",
    "phone": "[phone]",
    "email": "[e-mail]"
  },
  "comment": "This is a comment",
  "hyreBookingId": "123456",
  "referenceNumber": "123456"
}

{
  "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-04-18T16:58:08.528Z",
    "updatedAt": "2025-04-18T16:58:08.528Z",
    "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-04-18T16:58:08.528Z",
    "updatedAt": "2025-04-18T16:58:08.528Z",
    "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

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

application/json

objectOptional

application/json

application/json

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v3/puds/{id} HTTP/1.1
Host: 
x-api-token: text
Accept: */*

{
  "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-04-18T16:58:08.528Z",
  "updatedAt": "2025-04-18T16:58:08.528Z",
  "hyreBookingId": "text",
  "referenceNumber": "text"
}

---

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

customerobjectOptional

pickupobjectOptional

deliveryobjectOptional

vehicleobjectOptional

commentstringOptional

Comment

Example: Please handle with care

referenceNumberstringOptional

Reference number

Example: REF123456

hyreBookingIdstringOptional

Hyre booking id

Example: 123456

Responses

application/json

objectOptional

application/json

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v3/puds/{id} HTTP/1.1
Host: 
x-api-token: text
Content-Type: application/json
Accept: */*
Content-Length: 469

{
  "customer": {
    "name": "John Doe",
    "phone": "[phone]",
    "email": "[e-mail]"
  },
  "pickup": {
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]"
  },
  "delivery": {
    "comment": "Please collect keys at the reception.",
    "contactName": "John Doe",
    "contactPhone": "[phone]"
  },
  "vehicle": {
    "model": "Volkswagen Passat",
    "regNumber": "AB12345"
  },
  "comment": "Please handle with care",
  "referenceNumber": "REF123456",
  "hyreBookingId": "123456"
}

{
  "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-04-18T16:58:08.528Z",
  "updatedAt": "2025-04-18T16:58:08.528Z",
  "hyreBookingId": "text",
  "referenceNumber": "text"
}

---

Get PUD

You can retrieve

Get Pud

get

Get Pud by id

Path parameters

idstringRequired

Header parameters

x-api-tokenstringRequired

Company API key

Responses

application/json

objectOptional

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /api/v3/puds/{id} HTTP/1.1
Host: 
x-api-token: text
Accept: */*

{
  "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-04-18T16:58:08.528Z",
  "updatedAt": "2025-04-18T16:58:08.528Z",
  "hyreBookingId": "text",
  "referenceNumber": "text"
}

Get Puds

get

Get Puds for a company

Header parameters

x-api-tokenstringRequired

Company API key

Responses

application/json

object[]Optional

application/json

get

HTTPcURLJavaScriptPython

GET /api/v3/puds HTTP/1.1
Host: 
x-api-token: text
Accept: */*

[
  {
    "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-04-18T16:58:08.528Z",
    "updatedAt": "2025-04-18T16:58:08.528Z",
    "hyreBookingId": "text",
    "referenceNumber": "text"
  }
]

Get Pud count

get

Get Pud count for a company

Header parameters

x-api-tokenstringRequired

Company API key

Responses

application/json

numberOptional

application/json

get

HTTPcURLJavaScriptPython

GET /api/v3/puds/count HTTP/1.1
Host: 
x-api-token: text
Accept: */*

1

Booking restrictions