jayride-1-integration-api

There are 6 endpoints to integrate :

  1. Price Quote
  2. Validate Booking
  3. Create Booking
  4. Cancel Booking
  5. Update Validate Booking
  6. Update Booking

Elife-Limo integration api postman collection.zip

1. Price Quote Request & Response

NOTE : System should be able to handle Oneway & Return trip

Sample Request:

{
  "quote_request_id": "21eaf2b1-7ffb-4663-ac05-726db66961a8",
  "passenger_count": 2,
  "include_return_trip": false,
  "flight_date_time_local": "2025-02-26T15:15:00",
  "flight_date_time_local_return": null,
  "flight_date_time_utc": "2025-02-26T05:15:00Z",
  "flight_date_time_utc_return": null,
  "from_location": {
    "type": "airport-terminal",
    "description": "Jorge Chavez International Airport (LAP), Terminal 1",
    "lat": 24.078709787798754,
    "lng": -110.36742434973287
  },
  "to_location": {
    "type": "hotel",
    "description": "Marina View Villa (C. Cabo San Lucas Sn, Centro, 23410 Cabo San Lucas, B.C.S., Mexico)",
    "lat": 22.881918,
    "lng": -109.914927
  }
}

Sample Response:

{
  "quote_request_id": "21eaf2b1-7ffb-4663-ac05-726db66961a8",
  "fare_currency_code": "USD",
  "oneway_trip_quote_results": [
    {
      "supplier_quote_id": "d3b5457b-b0e6-49b6-992c-b2c6c93a1bb6",
      "service_type": "private",
      "service_class": "economy",
      "vehicle_type": "sedan",
      "meeting_instructions": null,
      "price": 85.72,
      "min_pax": 1,
      "max_pax": 3,
      "inclusive_luggage_allowance": "3 carry-on & 3 check-in bags included",
      "extras": [
        {
          "type": "MEET_AND_GREET",
          "included": false,
          "price": 9.99,
          "description": "Meet and greet is available. Your driver will meet you in the terminal holding a sign and escort you to your ride."
        }
      ]
    },
    {
      "supplier_quote_id": "a0cf6e55-51db-4774-af73-df260e260b59",
      "service_type": "private",
      "service_class": "business",
      "vehicle_type": "sedan",
      "meeting_instructions": null,
      "price": 125.72,
      "min_pax": 1,
      "max_pax": 3,
      "inclusive_luggage_allowance": "3 carry-on & 3 check-in bags included",
      "extras": [
        {
          "type": "MEET_AND_GREET",
          "included": true,
          "price": 0,
          "description": "Meet and greet is available. Your driver will meet you in the terminal holding a sign and escort you to your ride."
        }
      ]
      }
  ],
  "return_trip_quote_results": null,
  "quote_expire_datetime_utc": "2025-02-26T03:26:00Z"
}

2. Validate Booking Request & Response

Sample Request:

{
  "booking_id": 123456,
  "supplier_quote_id": "d3b5457b-b0e6-49b6-992c-b2c6c93a1bb6",
  "from_location": {
    "type": "airport-terminal",
    "description": "Jorge Chavez International Airport (LAP), Terminal 1",
    "lat": 24.078709787798754,
    "lng": -110.36742434973287
  },
  "to_location": {
    "type": "hotel",
    "description": "Marina View Villa (C. Cabo San Lucas Sn, Centro, 23410 Cabo San Lucas, B.C.S., Mexico)",
    "lat": 22.881918,
    "lng": -109.914927
  },
  "flight_number": "QF123",
  "flight_date_time_local": "2024-09-20T07:10",
  "flight_date_time_utc": "2024-09-20T13:10",
  "vehicle_type": "sedan",
  "service_class": "economy",
  "price": 121.0,
  "fare_currency_code": "USD",
  "passenger_count": 2,
  "inclusive_luggage_allowance": "2 carry-on & 2 check-in bag included",
  "primary_contact": {
    "name": "John Smith",
    "email": "john@smith.com",
    "mobile": "+61 411111111",
    "phone": ""
  },
  "selected_extras": [
    {
      "type": "MEET_AND_GREET",
      "included": false,
      "price": 9.99,
      "description": "Meet and greet is available. Your driver will meet you in the terminal holding a sign and escort you to your ride."
    }
  ],
  "additional_notes": "I need a child booster seat and"
}

Sample Response:

{
}

3. Create Booking Request & Response

NOTE : When a booking is created, if the customer account is not created, system will need to create the customer record

Sample Request:

{
  "booking_id": 123456,
  "supplier_quote_id": "d3b5457b-b0e6-49b6-992c-b2c6c93a1bb6",
  "from_location": {
    "type": "airport-terminal",
    "description": "Jorge Chavez International Airport (LAP), Terminal 1",
    "lat": 24.078709787798754,
    "lng": -110.36742434973287
  },
  "to_location": {
    "type": "hotel",
    "description": "Marina View Villa (C. Cabo San Lucas Sn, Centro, 23410 Cabo San Lucas, B.C.S., Mexico)",
    "lat": 22.881918,
    "lng": -109.914927
  },
  "flight_number": "QF123",
  "flight_date_time_local": "2024-09-20T07:10",
  "flight_date_time_utc": "2024-09-20T13:10",
  "vehicle_type": "sedan",
  "service_class": "economy",
  "price": 121.0,
  "fare_currency_code": "USD",
  "passenger_count": 2,
  "inclusive_luggage_allowance": "2 carry-on & 2 check-in bag included",
  "primary_contact": {
    "name": "John Smith",
    "email": "john@smith.com",
    "mobile": "+61 411111111",
    "phone": ""
  },
  "selected_extras": [
    {
      "type": "MEET_AND_GREET",
      "included": false,
      "price": 9.99,
      "description": "Meet and greet is available. Your driver will meet you in the terminal holding a sign and escort you to your ride."
    }
  ],
  "additional_notes": "I need a child booster seat and"
}

Sample Response:

{
  "supplier_booking_id": "12345678"
}

4. Cancel Booking Request & Response

Sample Request:

{
  "booking_id": 1234567,
  "supplier_booking_id": "supplier-booking-ref",
  "cancellation_details": "no service provided. vendor confirmed refund"
}

Sample Response:

{
  "booking_id": 1234567,
  "supplier_booking_id": "supplier-booking-ref"
}

5. Update Validate Booking Request & Response

Sample Request:

{
  "booking_id": "2212717",
  "supplier_booking_id": "d1db3cf7efbd4f30aa554f7e562adb97-v1",
  "supplier_requote_id": "d3b5457b-b0e6-49b6-992c-b2c6c93a1bb6",
  "original_booking": {
    "from_location": {
      "type": "Airport",
      "description": "San Francisco Airport (SFO), International A Terminal",
      "lat": 37.614605,
      "lng": -122.388609
    },
    "to_location": {
      "type": "Address",
      "description": "4 Season Organic Carpet Cleaning (156 San Felipe Ave, San Bruno, CA 94066, USA)",
      "lat": 37.6182225,
      "lng": -122.4074329
    },
    "flight_number": "QF123",
    "flight_date_time_local": "2025-01-01T17:10:00",
    "flight_date_time_utc": "2025-01-02T01:10:00Z",
    "passeger_count": 1,
    "primary_contact": {
      "name": "Agent Name",
      "email": "agent@email.com",
      "phone": null,
      "mobile": null
    },
    "selected_extras": [],
    "additional_notes": "I need a child booster seat and ...\n-- Extra items requested --\nEXTRA LUGGAGE: A 6 ft surfboard and 1 extra check-in bag.",
    "price": 130.00,
    "fare_currency_code": "USD",
    "vehicle_type": "sedan",
    "service_class": "economy"
  },
  "updated_booking": {
    "from_location": {
      "type": "Airport",
      "description": "San Francisco Airport (SFO), International A Terminal",
      "lat": 37.614605,
      "lng": -122.388609
    },
    "to_location": {
      "type": "Address",
      "description": "4 Season Organic Carpet Cleaning (156 San Felipe Ave, San Bruno, CA 94066, USA)",
      "lat": 37.6182225,
      "lng": -122.4074329
    },
    "flight_number": "QF333",
    "flight_date_time_local": "2025-01-02T17:10:00",
    "flight_date_time_utc": "2025-01-03T01:10:00Z",
    "passeger_count": 1,
    "primary_contact": {
      "name": "Agent Name",
      "email": "agent@email.com",
      "phone": "02 11111111",
      "mobile": "0411111111"
    },
    "selected_extras": [
      {
        "type": "MEET_AND_GREET",
        "included": false,
        "price": 9.99,
        "description": "Meet and greet is available. Your driver will meet you in the terminal holding a sign and escort you to your ride."
      }
    ],
    "additional_notes": "Can you please call us the day before travel to confirm all is well?\n-- Extra items requested --\nEXTRA LUGGAGE: Extra Check-in Luggage n2 Skis or Snowboard\nSurfboard\nCHILD SEATS: Please provide 1 Toddler Seat (9 months 4 years)",
    "price": 140.00,
    "fare_currency_code": "USD",
    "vehicle_type": "sedan",
    "service_class": "economy"
  }
}

Sample Response:

{
}

6. Update Booking Request & Response

Sample Request:

{
  "booking_id": "2212717",
  "supplier_booking_id": "d1db3cf7efbd4f30aa554f7e562adb97-v1",
  "supplier_requote_id": "d3b5457b-b0e6-49b6-992c-b2c6c93a1bb6",
  "original_booking": {
    "from_location": {
      "type": "Airport",
      "description": "San Francisco Airport (SFO), International A Terminal",
      "lat": 37.614605,
      "lng": -122.388609
    },
    "to_location": {
      "type": "Address",
      "description": "4 Season Organic Carpet Cleaning (156 San Felipe Ave, San Bruno, CA 94066, USA)",
      "lat": 37.6182225,
      "lng": -122.4074329
    },
    "flight_number": "QF123",
    "flight_date_time_local": "2025-01-01T17:10:00",
    "flight_date_time_utc": "2025-01-02T01:10:00Z",
    "passeger_count": 1,
    "primary_contact": {
      "name": "Agent Name",
      "email": "agent@email.com",
      "phone": null,
      "mobile": null
    },
    "selected_extras": [],
    "additional_notes": "I need a child booster seat and ...\n-- Extra items requested --\nEXTRA LUGGAGE: A 6 ft surfboard and 1 extra check-in bag.",
    "price": 130.00,
    "fare_currency_code": "USD",
    "vehicle_type": "sedan",
    "service_class": "economy"
  },
  "updated_booking": {
    "from_location": {
      "type": "Airport",
      "description": "San Francisco Airport (SFO), International A Terminal",
      "lat": 37.614605,
      "lng": -122.388609
    },
    "to_location": {
      "type": "Address",
      "description": "4 Season Organic Carpet Cleaning (156 San Felipe Ave, San Bruno, CA 94066, USA)",
      "lat": 37.6182225,
      "lng": -122.4074329
    },
    "flight_number": "QF333",
    "flight_date_time_local": "2025-01-02T17:10:00",
    "flight_date_time_utc": "2025-01-03T01:10:00Z",
    "passeger_count": 1,
    "primary_contact": {
      "name": "Agent Name",
      "email": "agent@email.com",
      "phone": "02 11111111",
      "mobile": "0411111111"
    },
    "selected_extras": [
      {
        "type": "MEET_AND_GREET",
        "included": false,
        "price": 9.99,
        "description": "Meet and greet is available. Your driver will meet you in the terminal holding a sign and escort you to your ride."
      }
    ],
    "additional_notes": "Can you please call us the day before travel to confirm all is well?\n-- Extra items requested --\nEXTRA LUGGAGE: Extra Check-in Luggage n2 Skis or Snowboard\nSurfboard\nCHILD SEATS: Please provide 1 Toddler Seat (9 months 4 years)",
    "price": 140.00,
    "fare_currency_code": "USD",
    "vehicle_type": "sedan",
    "service_class": "economy"
  }
}

Sample Response:

{
  "booking_id": 1234567,
  "supplier_booking_id": "supplier-booking-ref"
}