Rentlz Booking API

Created by Moveinsync Help, Modified on Sun, 27 Apr at 9:22 PM by Moveinsync Help

POSTBooking Creation

https://api.moveinsync.com/spot-service/{{Client BUID}}/intergation/booking

This API is used to create a new booking in the system. A booking can include requester and booker details, multiple riders, a defined vehicle type, pickup and drop-off stops, and other related trip metadata. This supports spot booking types which are predefined in the system.

Key Points:

requester and booker can be different individuals.
spotBookingType supports values like Airport PickUp, Drop, Intercity, etc.
riders array must include gender for each rider.
stops must be ordered using priorityOrder and can include pickup, intermediate, and drop points.
riderMailIds should be attached to corresponding stops if the stop is associated with a rider.
If vendor is not assigned, pass null.
bunit will be shared during production onboarding.

HEADERS

Authorization

Bearer {{access_token}}

Bodyraw (json)

{
  "requester": {
    "name": "{{requesterName}}",
    "email": "{{requesterEmail}}",
    "mobile": "{{requesterMobile}}"
  },
  "booker": {
    "name": "{{bookerName}}",
    "email": "{{bookerEmail}}",
    "mobile": "{{bookerMobile}}"
  },
  "spotBookings": {
    "city": "{{bookingCity}}",
    "spotBookingType": "{{spotBookingType}}",
    "destinationCity": "{{destinationCity}}",
    "vehicleType": "{{vehicleType}}",
    "reason": "{{bookingReason}}",
    "flightDetails": "{{flightDetails}}",
    "vendor": "{{vendor}}",
    "guardReq": "{{guardRequired}}",
    "riders": [
      {
        "name": "{{riderName}}",
        "email": "{{riderEmail}}",
        "phoneCode": "{{riderPhoneCode}}",
        "mobile": "{{riderMobile}}",
        "gender": "{{riderGender}}"
      }
    ],
    "stops": [
      {
        "address": "{{stop1Address}}",
        "time": "{{stop1Time}}",
        "priorityOrder": 1,
        "geoCord": "{{stop1GeoCoordinates}}",
        "landmark": "{{stop1Landmark}}",
        "pointType": "START",
        "riderMailIds": [
          {
            "email": "{{riderEmail}}",
            "boardingType": "{{boardingType}}"
          }
        ]
      },
      {
        "address": "{{stop2Address}}",
        "time": "{{stop2Time}}",
        "priorityOrder": 2,
        "geoCord": "{{stop2GeoCoordinates}}",
        "landmark": "{{stop2Landmark}}",
        "addressType": "{{stop2AddressType}}",
        "riderMailIds": "{{riderMailIds}}"
      },
      {
        "address": "{{stop3Address}}",
        "time": "{{stop3Time}}",
        "priorityOrder": 3,
        "geoCord": "{{stop3GeoCoordinates}}",
        "landmark": "{{stop3Landmark}}",
        "addressType": "{{stop3AddressType}}",
        "pointType": "END",
        "riderMailIds": [
          {
            "email": "{{riderEmail}}",
            "boardingType": "{{boardingType}}"
          }
        ]
      }
    ]
  },
  "bunit": "{{businessUnit}}",
  "bookingReferenceId": "{{bookingReferenceId}}"
}

POSTBooking Cancellation

https://api.moveinsync.com/spot-service/{{Client BUID}}/intergation/booking

This API allows authorized users to cancel an existing booking in the MoveInSync system. The user must provide the booking ID, their identity (email), and a reason for cancellation.

Field Details:

modifier: Email address of the user requesting the cancellation.
bookingId: Unique MoveInSync booking ID to be canceled.
reason: Reason provided for the cancellation (e.g., "change of plan", "duplicate booking", etc.).

HEADERS

Authorization

Bearer {{access_token}}

Bodyraw (json)

{
  "modifier": "{{requestingUserEmail}}",
  "bookingId": "{{bookingId}}",
  "reason": "{{cancellationReason}}"
}

POSTBooking Edit

https://api.moveinsync.com/spot-service/{{Client BUID}}/intergation/booking

This API allows users to modify an existing booking in the MoveInSync system. It enables the modification of booking details, including the booker and rider information, trip stops, and vehicle-related data.

Field Details:

booker: Contains information about the person who booked the service.
- name: The name of the booker.
- email: Email address of the booker.
- mobile: Mobile number of the booker.
modifier: Contains information about the user requesting the booking modification.
- name: The name of the modifier.
- email: Email address of the modifier.
- mobile: Mobile number of the modifier.
bookingId: The unique identifier for the booking that is being edited.
reason: The reason for the modification (e.g., "update pickup time," "change vehicle type").
spotBookings: Contains the details of the spot booking being edited.
- city: The city where the booking is taking place.
- spotBookingType: Type of booking (e.g., Airport PickUp).
- destinationCity: The destination city if applicable (e.g., for intercity bookings).
- vehicleType: The type of vehicle (e.g., Mercedes C-Class).
- reason: Reason for the specific booking (e.g., booking creation test).
- flightDetails: Flight information if it's an airport pickup/drop booking.
- vendor: Vendor information if applicable.
- guardReq: Whether an escort is required or not (boolean).
- riders: List of riders associated with the booking.
  - name: Rider’s name.
  - email: Rider’s email.
  - phoneCode: Country code for the phone number.
  - mobile: Rider’s mobile number.
stops: List of stops during the trip. Each stop includes:
- address: The stop's address.
- time: Time of the stop.
- priorityOrder: Priority order of the stop.
- geoCord: Geographical coordinates of the stop.
- pointType: Type of stop (e.g., "START," "END").
- riderMailIds: List of rider emails associated with the stop (used for pickups/drops).

HEADERS

Authorization

Bearer {{access_token}}

Bodyraw (json)

{
  "booker": {
    "name": "{{bookerName}}",
    "email": "{{bookerEmail}}",
    "mobile": "{{bookerMobile}}"
  },
  "modifier": {
    "name": "{{modifierName}}",
    "email": "{{modifierEmail}}",
    "mobile": "{{modifierMobile}}"
  },
  "bookingId": "{{bookingId}}",
  "reason": "{{modificationReason}}",
  "spotBookings": [
    {
      "city": "{{bookingCity}}",
      "spotBookingType": "{{spotBookingType}}",
      "destinationCity": "{{destinationCity}}",
      "vehicleType": "{{vehicleType}}",
      "reason": "{{bookingReason}}",
      "flightDetails": "{{flightDetails}}",
      "vendor": "{{vendor}}",
      "guardReq": {{guardRequired}},
      "riders": [
        {
          "name": "{{riderName}}",
          "email": "{{riderEmail}}",
          "phoneCode": "{{riderPhoneCode}}",
          "mobile": "{{riderMobile}}"
        }
      ],
      "stops": [
        {
          "address": "{{stop1Address}}",
          "time": "{{stop1Time}}",
          "priorityOrder": 1,
          "geoCord": "{{stop1GeoCoordinates}}",
          "pointType": "START",
          "riderMailIds": [
            {
              "email": "{{riderEmail}}",
              "boardingType": "{{boardingType}}"
            }
          ]
        },
        {
          "address": "{{stop2Address}}",
          "time": "{{stop2Time}}",
          "priorityOrder": 2,
          "geoCord": "{{stop2GeoCoordinates}}",
          "addressType": "{{stop2AddressType}}",
          "riderMailIds": "{{riderMailIds}}"
        },
        {
          "address": "{{stop3Address}}",
          "time": "{{stop3Time}}",
          "priorityOrder": 3,
          "geoCord": "{{stop3GeoCoordinates}}",
          "addressType": "{{stop3AddressType}}",
          "pointType": "END",
          "riderMailIds": [
            {
              "email": "{{riderEmail}}",
              "boardingType": "{{boardingType}}"
            }
          ]
        }
      ]
    }
  ]
}