🚗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

Create a Pud

post

/api/v3/puds

Header parameters

x-api-tokenstringrequired

Company API key

Body

pickupobjectrequired

deliveryobjectrequired

intervalobjectrequired

vehicleobjectrequired

customerobjectrequired

commentstring

Comment

Example: This is a comment

hyreBookingIdstring

Hyre booking id

Example: 123456

referenceNumberstring

Reference number

Example: 123456

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v3/puds' \
  --header 'x-api-token: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

201

401

201

{
  "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-03-12T09:34:35.802Z",
  "updatedAt": "2025-03-12T09:34:35.802Z",
  "hyreBookingId": "text",
  "referenceNumber": "text"
}

Pud created

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

x-api-tokenstringrequired

Company API key

Body

pickupobjectrequired

deliveryobjectrequired

returnDeliveryobjectrequired

intervalobjectrequired

vehicleobjectrequired

returnVehicleobjectrequired

customerobjectrequired

commentstring

Comment

Example: This is a comment

hyreBookingIdstring

Hyre booking id

Example: 123456

referenceNumberstring

Reference number

Example: 123456

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v3/puds/immediate-return' \
  --header 'x-api-token: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

201

401

201

{
  "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-03-12T09:34:35.802Z",
    "updatedAt": "2025-03-12T09:34:35.802Z",
    "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-03-12T09:34:35.802Z",
    "updatedAt": "2025-03-12T09:34:35.802Z",
    "hyreBookingId": "text",
    "referenceNumber": "text"
  }
}

Immediate return Pud created

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

idstringrequired

Header parameters

x-api-tokenstringrequired

Company API key

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v3/puds/{id}' \
  --header 'x-api-token: text'

200

400

401

404

200

{
  "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-03-12T09:34:35.802Z",
  "updatedAt": "2025-03-12T09:34:35.802Z",
  "hyreBookingId": "text",
  "referenceNumber": "text"
}

Pud successfully cancelled

---

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

idstringrequired

Header parameters

x-api-tokenstringrequired

Company API key

Body

customerobject

pickupobject

deliveryobject

vehicleobject

commentstring

Comment

Example: Please handle with care

referenceNumberstring

Reference number

Example: REF123456

hyreBookingIdstring

Hyre booking id

Example: 123456

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/api/v3/puds/{id}' \
  --header 'x-api-token: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
  }'

200

401

404

200

{
  "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-03-12T09:34:35.802Z",
  "updatedAt": "2025-03-12T09:34:35.802Z",
  "hyreBookingId": "text",
  "referenceNumber": "text"
}

Pud updated

---

Get PUD

You can retrieve

Get Pud

Get Pud by id

get

/api/v3/puds/{id}

Path parameters

idstringrequired

Header parameters

x-api-tokenstringrequired

Company API key

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v3/puds/{id}' \
  --header 'x-api-token: text'

200

401

404

200

{
  "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-03-12T09:34:35.802Z",
  "updatedAt": "2025-03-12T09:34:35.802Z",
  "hyreBookingId": "text",
  "referenceNumber": "text"
}

Pud found

Get Puds

Get Puds for a company

get

/api/v3/puds

Header parameters

x-api-tokenstringrequired

Company API key

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v3/puds' \
  --header 'x-api-token: text'

200

401

200

[
  {
    "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-03-12T09:34:35.802Z",
    "updatedAt": "2025-03-12T09:34:35.802Z",
    "hyreBookingId": "text",
    "referenceNumber": "text"
  }
]

Puds found

Get Pud count

Get Pud count for a company

get

/api/v3/puds/count

Header parameters

x-api-tokenstringrequired

Company API key

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v3/puds/count' \
  --header 'x-api-token: text'

200

401

200

1

Pud count

Booking restrictions