{"info":{"_postman_id":"c3c9f70b-343c-4ec3-8925-1bf772d2cec8","name":"CAB9 Gett API","description":"

Gett API integration for Cab9.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4475931","collectionId":"c3c9f70b-343c-4ec3-8925-1bf772d2cec8","publishedId":"S1M3wkxf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-02-20T17:30:27.000Z"},"item":[{"name":"GetToken","event":[{"listen":"test","script":{"id":"bb2d38f1-4583-4c87-bf2d-ecb415bcf8f7","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"token\",jsonData.access_token);"],"type":"text/javascript"}}],"id":"9d90a77c-9bb1-427e-a871-b3c882a808c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{username}}","description":"

[Required] The username of the user.

\n","type":"text"},{"key":"password","value":"{{password}}","description":"

[Required] The password of the user.

\n","type":"text"},{"key":"grant_type","value":"password","description":"

[Required]

\n","type":"text"}]},"url":"{{domain}}/token","description":"

The endpoint is used to get the authorisation token which will enable user gain access to the CAB9 Api.\n

\nA specific username and password will have to be used to login to the API to get the token. Each token will be live only for a period of 8 hours, after which the user has to hit this API again to get a new token. \n

\nThe token provided by the API needs be passed in the authorisation header of the other APIs as: Bearer {token}.

\n","urlObject":{"path":["token"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d90a77c-9bb1-427e-a871-b3c882a808c5"},{"name":"Create Staff","id":"f72084b6-f928-4fc3-99da-ccae6c0cf1a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"

[Required] The authorization header including the token received earlier to gain access to the API.

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Firstname\":\"Dwane\",\r\n \"Surname\":\"Bravo\",\r\n \"Mobile\":\"+447545989496\",\r\n \"Email\":\"Dwane.Bravo@gmail.com\",\r\n \"Phone\":null, \r\n \"Fax\":null\r\n}\r\n"},"url":"{{domain}}/api/integrations/gett/staff","description":"

The endpoint is used to add a new Client Staff to CAB9. \n

\nEvery booking needs a ClientStaffId. \n

\nClient Staff in CAB9 are treated as bookers. For web bookings we recommend creating a single booker and attaching it to all the bookings.

Body Parameters

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n

Sl.No	Property	Type	Required	Description
1	Firstname	String	true	Firstname of the staff.
2	Surname	String	true	Surname of the staff.
3	Mobile	String	true	Mobile number the staff.
4	Email	String	true	Email id of the staff.
5	Phone	String	false	Phone number of the staff.
6	Fax	String	false	Fax number of the staff.

","urlObject":{"path":["api","integrations","gett","staff"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f72084b6-f928-4fc3-99da-ccae6c0cf1a5"},{"name":"Create Passenger","id":"e27cdf85-3450-4c06-b1c8-1d12725423ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"

[Required] The authorization header including the token received earlier to gain access to the API.

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Firstname\":\"Tarpit\",\r\n \"Surname\":\"Grover\",\r\n \"Mobile\":\"+447512085158\",\r\n \"Email\":\"tg@e9.co.uk\",\r\n \"Phone\": null,\r\n \"VIP\": true\r\n}\r\n"},"url":"{{domain}}/api/integrations/gett/passenger","description":"

The endpoint is used to add a new passenger to CAB9.\n

\nPassengers are required while creating a new booking and needs to be attached to the property LeadPassengerId. \n

\nPlease reuse the PassengerId for same passengers instead of creating a new passenger everytime.

Body Parameters

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n

Sl.No	Property	Type	Required	Description
1	Firstname	String	true	Firstname of the passenger.
2	Surname	String	true	Surname of the passenger.
3	Mobile	String	true	Mobile number of the passenger.
4	Email	String	true	Email id of the passenger.
5	Phone	String	false	Phone number of the passenger.
6	Fax	String	false	Fax number of the passenger.
6	VIP	Boolean	false	VIP Status of the passenger.

","urlObject":{"path":["api","integrations","gett","passenger"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e27cdf85-3450-4c06-b1c8-1d12725423ee"},{"name":"Vehicle Types","id":"dd0cc91b-6d0a-48e8-a2d0-8f12005e7f53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"

[Required] The authorization header including the token received earlier to gain access to the API.

\n"}],"url":"{{domain}}/api/integrations/gett/vehicletypes","description":"

The endpoint is used to get the list of vehicles available to book at a given time. \n

\nDetails also include the maximum number of passengers and bags one can accomodate.

\n","urlObject":{"path":["api","integrations","gett","vehicletypes"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd0cc91b-6d0a-48e8-a2d0-8f12005e7f53"},{"name":"Nearby Drivers","id":"834e8926-b401-4fbc-9f97-08b0075981b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"

[Required] The authorization header including the token received earlier to gain access to the API.

\n"},{"key":"Content-Type","value":"application/json"}],"url":"{{domain}}/api/integrations/gett/driversnearby?latitude=51.504770&longitude=0.024190","description":"

The endpoint is used to retrieve the list of 5 nearest drivers for the given coordinate in latitude and longitude.

\n","urlObject":{"path":["api","integrations","gett","driversnearby"],"host":["{{domain}}"],"query":[{"description":{"content":"

[Required] The latitude of the location.

\n","type":"text/plain"},"key":"latitude","value":"51.504770"},{"description":{"content":"

[Required] The longitude of the location.

\n","type":"text/plain"},"key":"longitude","value":"0.024190"}],"variable":[]}},"response":[],"_postman_id":"834e8926-b401-4fbc-9f97-08b0075981b5"},{"name":"Quote","id":"ca11e506-a235-44a6-8299-f6141db7a7b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"

[Required] The authorization header including the token received earlier to gain access to the API.

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"VendorRef\": \"59edb04400d3a705fd398496\",\n \"BookedDateTime\": \"2020-06-25T17:40:17.603+0530\",\n \"VehicleTypeCode\": \"MPV\",\n \"BookingStops\": [\n {\n \"StopOrder\": 1,\n \"StopSummary\": \"20, Maybank Avenue, Wembley, HA0 2TH\",\n \"Postcode\": \"HA0 2TH\",\n \"Country\": \"United Kingdom\",\n \"Latitude\": 51.5558,\n \"Longitude\": -0.3286\n },\n {\n \"StopOrder\": 5,\n \"StopSummary\": \"Royal Hospital Chelsea, Royal Hospital Road, London, SW3 4SR\",\n \"Postcode\": \"SW3 4SR\",\n \"Country\": \"United Kingdom\",\n \"Latitude\": 51.4868,\n \"Longitude\": -0.1591\n }\n ]\n}"},"url":"{{domain}}/api/integrations/gett/quote","description":"

The endpoint is used for retreiving the quote of the vehicle type provided by the user.

Body Parameters

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Sl.No	Property	Type	Required	Description
1	VendorRef	String	true	Guid supplied by CAB9.
2	BookedDateTime	DateTime	true	The time and day of the booking.
3	VehicleTypeCode	String	true	The vehicletype retrieved from endpoint (/api/heremaps/vehicletypes) to generate the quote.
4	BookingStops	Array	true	List of the pickup and the dropoff locations.

\n
\nBooking Stops:\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n

Sl.No	Property	Type	Required	Descrription
1	Type	String	true	Type of stop(Pickup or dropoff).
2	Address1	String	false	The line1 of the address.
3	Address2	String	false	The line2 of the address.
4	TownCity	String	false	The town of city of the address.
5	Postcode	String	false	The postcode of the address.
6	StopSummary	String	true	The viewable summary of the address.
7	Longitude	Decimal	true	Longitude of the pickup and the dropoff.
8	Latitude	Decimal	true	Latitude of the pickup and the dropoff.
9	StopOrder	Int	true	Order of the stops where stoporder 1 corresponds to a pickup and the others as dropoff.

","urlObject":{"path":["api","integrations","gett","quote"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ca11e506-a235-44a6-8299-f6141db7a7b4"},{"name":"Booking (New/Amend)","id":"eb44f556-0651-4082-9e10-25aa5cea9c6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"

[Required] The authorization header including the token received earlier to gain access to the API.

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"BookingRef\":\"9999993232322321A104ZZZA\", \r\n \"VendorRef\":\"59edb04400d3a705fd3sdsds232323398496\", \r\n \"BookedDateTime\": \"2023-12-22T01:00:00+00:00\",\r\n \"ClientStaffId\": \"d043aaf7-6887-e911-abc4-28187825271e\", \r\n \"VehicleTypeCode\": \"Saloon\", \r\n \"Pax\": 3, \r\n \"Bax\": 2, \r\n \"LeadPassengerId\": \"c77aaa17-a912-ea11-828b-28187824c69e\",\r\n \"ActualCost\": 66.70,\r\n \"BookingStops\": [\r\n {\r\n \"StopOrder\": 2,\r\n \"StopSummary\": \"20, Maybank Avenue, Wembley, HA0 2TH\",\r\n \"Postcode\": \"HA0 2TH\",\r\n \"Country\": \"United Kingdom\",\r\n \"Latitude\": 51.5558,\r\n \"Longitude\": -0.3286\r\n },\r\n {\r\n \"StopOrder\": 1,\r\n \"StopSummary\": \"Royal Hospital Chelsea, Royal Hospital Road, London, SW3 4SR\",\r\n \"Postcode\": \"SW3 4SR\",\r\n \"Country\": \"United Kingdom\",\r\n \"Latitude\": 51.4868,\r\n \"Longitude\": -0.1591\r\n }\r\n ],\r\n \"DriverNotes\": \"Do not talk with the passenger.\"\r\n}"},"url":"{{domain}}/api/integrations/gett/booking","description":"

The endpoint is used for both creating new bookings and amending bookings.

Body Parameters

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Sl.No	Property	Type	Required	Description
1	BookingRef	String	true	GETT's unique ID for the booking.
2	VendorRef	String	true	Vendor reference supplied by CAB9.
3	BookedDateTime	DateTime	true	The ISO2601 format time and date of the booking with timezone information e.g, `2019-05-20T20:15:00+01:00` .
4	ClientStaffId	String	true	The ClientStaffId for this booking.
5	VehicleTypeCode	String	true	The name of the vehicle that the booking needs to be made for.
6	Pax	Int	true	The number of passengers for the booking.
7	Bax	Int	true	The number of bags for the booking.
8	LeadPassengerId	String	true	The passenger for whom the booking is created.
9	ActualCost	Decimal	false	The price for this booking set by GETT.
10	EstimatedDistance	Decimal	false	The estimated distance for this booking set by GETT.
11	FlightNo	String	false	The flight number on the booking. If the flight number matches the pickup airport and the booking date it will be tracked live by CAB9.
12	BookingStops	Array	true	List of dropoff and pickup locations.
13	DriverNotes	String	false	The notes for the driver to whom the booking is assigned.

\n\n\n

Booking Stops:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n

Sl.No	Property	Type	Required	Descrription
1	Type	String	true	Type of stop(Pickup or dropoff).
2	Address1	String	false	The line1 of the address.
3	Address2	String	false	The line2 of the address.
4	TownCity	String	false	The town of city of the address.
5	Postcode	String	false	The postcode of the address.
6	StopSummary	String	true	The viewable summary of the address.
7	Longitude	Decimal	true	Longitude of the pickup and the dropoff.
8	Latitude	Decimal	true	Latitude of the pickup and the dropoff.
9	StopOrder	Int	true	Order of the stops where stoporder 1 corresponds to a pickup and the others as dropoff.

","urlObject":{"path":["api","integrations","gett","booking"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eb44f556-0651-4082-9e10-25aa5cea9c6a"},{"name":"Booking","id":"9d045e78-bbc9-4ece-b6f9-cb35af2a5e67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"

[Required] The authorization header including the token received earlier to gain access to the API.

\n"}],"url":"{{domain}}/api/integrations/gett/booking?bookingId=e74666f1-847a-e911-80d7-14187728d133","description":"

The endpoint is used to get the details of the booking by its Id

\n","urlObject":{"path":["api","integrations","gett","booking"],"host":["{{domain}}"],"query":[{"description":{"content":"

[Required]The Id of the booking in CAB9. The complete details for the booking is provided in the response for its bookingId.

\n","type":"text/plain"},"key":"bookingId","value":"e74666f1-847a-e911-80d7-14187728d133"}],"variable":[]}},"response":[],"_postman_id":"9d045e78-bbc9-4ece-b6f9-cb35af2a5e67"},{"name":"Get Booking Status","id":"2d33a54c-f586-4c20-91da-b1f1eb12ad6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"

[Required] The authorization header including the token received earlier to gain access to the API.

\n"}],"url":"{{domain}}/api/integrations/gett/bookingstatus?bookingId=9597124b-8398-ee11-8925-6045bd0cec8f","description":"

The endpoint is used for retrieving the status of a booking by its Id

\n","urlObject":{"path":["api","integrations","gett","bookingstatus"],"host":["{{domain}}"],"query":[{"description":{"content":"

[Required]The Id of the booking in CAB9. Id is provided in the response when a booking is created/amended.

\n","type":"text/plain"},"key":"bookingId","value":"9597124b-8398-ee11-8925-6045bd0cec8f"}],"variable":[]}},"response":[],"_postman_id":"2d33a54c-f586-4c20-91da-b1f1eb12ad6a"},{"name":"Get Driver Location","id":"9c2d47ed-c5a4-4893-b0c5-e84e2c3849d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"

[Required] The authorization header including the token received earlier to gain access to the API.

\n"}],"url":"{{domain}}/api/integrations/gett/driverlocation?bookingId=9597124b-8398-ee11-8925-6045bd0cec8f","description":"

This endpoint is used in retrieving the last known location of the driver for a booking in latitude and longitude.

\n","urlObject":{"path":["api","integrations","gett","driverlocation"],"host":["{{domain}}"],"query":[{"description":{"content":"

[Required]The Id of the booking in CAB9. Id is provided in the response when a booking is created/amended.

\n","type":"text/plain"},"key":"bookingId","value":"9597124b-8398-ee11-8925-6045bd0cec8f"}],"variable":[]}},"response":[],"_postman_id":"9c2d47ed-c5a4-4893-b0c5-e84e2c3849d4"},{"name":"Cancel Booking","id":"783c38ce-89ab-4855-9dfe-ffc2f59e7e2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"

[Required] The authorization header including the token received earlier to gain access to the API.

\n","key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{domain}}/api/integrations/gett/booking?VendorRef=59edb04400d3a705fd398496&BookingId=9597124b-8398-ee11-8925-6045bd0cec8f&BookingRef=172535663","description":"

The endpoint is used to cancel an already existing booking by its VendorRef and Cab9 BookingId or Gett BookingRef. You can pass either BookingId or Gett BookingRef or both.

\n","urlObject":{"path":["api","integrations","gett","booking"],"host":["{{domain}}"],"query":[{"description":{"content":"

[Required] The vendor reference provided by CAB9.

\n","type":"text/plain"},"key":"VendorRef","value":"59edb04400d3a705fd398496"},{"description":{"content":"

[Optional] The vendor reference provided by CAB9.

\n","type":"text/plain"},"key":"BookingId","value":"9597124b-8398-ee11-8925-6045bd0cec8f"},{"description":{"content":"

[Optional] The Gett reference for the booking.

\n","type":"text/plain"},"key":"BookingRef","value":"172535663"}],"variable":[]}},"response":[],"_postman_id":"783c38ce-89ab-4855-9dfe-ffc2f59e7e2c"}],"event":[{"listen":"prerequest","script":{"id":"9e144690-b680-4d3b-a4f7-34ec31a6ac9a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f1f8d82b-94a1-46c9-8382-b33b0d1eb9fc","type":"text/javascript","exec":[""]}}]}