Gire Public API
Customers of Gire can order Pickup and Delivery of cars (PUDs) using this API. The documentation should help you set up the integration. If you have any questions, reach out to tech@giremobility.com
Create a new PUD
POST
https://giremobility.com/api/v2/puds
Create one Pickup and Delivery (PUD) in the Gire platform. This method is great if you need to move a car from A to B.
Headers
Name | Type | Description |
---|---|---|
x-api-token* | string | auth api token |
Request Body
Name | Type | Description |
---|---|---|
pickup_name | string | pickup person name |
customer_phone* | string | customer person phone |
customer_name* | string | customer person name |
pickup_phone | string | pickup person phone |
pickup_datetime_from* | string datetime ISO format | The pick-up time interval starts from. We need a minimum 1 hour pickup time interval. |
pickup_datetime_to | string datetime ISO format | The pick-up time interval ends. If the value is not provided, the default interval is 1 hour. |
delivery_datetime* | string datetime ISO format | DateTime by when the car must be delivered |
car_model* | string | car model |
delivery_postal_code* | string | delivery address |
delivery_address* | string | delivery address |
pickup_postal_code* | string | pickup postal code |
pickup_address* | string | pickup address |
reg_number* | string | registration car number |
reference_number | string | reference order id |
comment | string | comment |
delivery_name | string | delivery person name |
delivery_phone | string | delivery person phone |
test_sign | boolean | set true if test sign is needed |
pickup_comment | String | location comment for drivers |
delivery_comment | String | location comment for drivers |
Get PUD by ID
GET
https://giremobility.com/api/v2/puds/{:id}
Path Parameters
Name | Type | Description |
---|---|---|
id* | String | PUD id |
Headers
Name | Type | Description |
---|---|---|
x-api-token* | String | auth api token |
Edit PUD
PUT
https://giremobility.com/api/v2/puds
You can change the contact information and car data in the PUD before it starts
Request Body
Name | Type | Description |
---|---|---|
id* | String Required | PUD id |
car_model | String Optional | car model |
comment | String Optional | comment |
delivery_phone | String Optional | delivery person phone |
delivery_name | String Optional | delivery person name |
pickup_phone | String Optional | pick-up person phone |
pickup_name | String Optional | pick-up person name |
customer_phone | String Optional | customer person phone |
customer_name | String Optional | customer person name |
reference_number | String Optional | reference order id |
reg_number | String Optional | registration car number |
Get list of PUDs
GET
https://giremobility.com/api/v2/puds
Query Parameters
Name | Type | Description |
---|---|---|
status | string enum | new | delegated | in_progress | missed_trip | completed | cancelled |
month | number | month filter (january = 1, february = 2, and etc.. ) This filter works only if set month and year |
year | number | year filter (example 2022). This filter works only if set month and year |
search | string | Search by reg. number, car model |
limit | number | Page Size. By default limit = 10, max = 50 |
page | number | Page number |
sort_by | string | Sort by field, possible values: created_at | pickup_date |
sort_order | number | 1 or -1 |
Headers
Name | Type | Description |
---|---|---|
x-api-token* | string | auth api token |
Get count of PUDs for selected filters, returns number
GET
https://giremobility.com/api/v2/puds_qty
This method is needed for pagination
Query Parameters
Name | Type | Description |
---|---|---|
status | string enum | new | delegated | in_progress | missed_trip | completed | cancelled |
search | string | search by car model, reg number |
year | number | year filter (example 2022). This filter works only if set month and year |
month | number | month filter (january = 1, february = 2, and etc.. ) This filter works only if set month and year |
Headers
Name | Type | Description |
---|---|---|
x-api-token* | string | auth api token |
PUD Cancellation
DELETE
https://giremobility.com/api/v2/puds/{:id}
You might need to cancel a PUD either because you don't longer need transportation, or you have booked a PUD with the wrong details and you need to create a new PUD with correct details.
To cancel a PUD it needs to have one of the two statuses:
-new
-delegated
Also, if pickup datetime is less than 12 hours from current datetime and the PUD is delegated to a driver, it will be considered as "missed_trip" and you will be charged.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string | PUD id |
Headers
Name | Type | Description |
---|---|---|
x-api-token* | string | auth api token |
Price Estimation
GET
https://giremobility.com/api/v2/price_estimation
Returns the price for trips inside and outside our standard delivery area. Inside our standard delivery area the prices are fixed based on zip codes. For trips outside, the price is only an estimate and it might have smaller variation based on travel time.
Query Parameters
Name | Type | Description |
---|---|---|
pickup_address* | string | pickup address |
pickup_postal_code* | string | pickup postal code |
delivery_address* | string | delivery address |
delivery_postal_code* | string | delivery postal code |
immediate_return | boolean | immediate return trip |
Headers
Name | Type | Description |
---|---|---|
x-api-token* | string | auth api token |
NOTE: For immediate_return bookings, the duration_in_seconds and distance_in_meters is for one direction.
Note: Please don't forget to use url encoding when you send any text as query params (like search, address etc)
We can also set up a dev environment for you for developing and testing. Please contact tech@giremobility.com
Last updated