Place Order


Place Order Sample

Last Update Date 27.02.2017

Request Sample


v1/booking/placeOrder
├── travellers              ───> Array
│   ├── travellerNo              ───> TravellerNo(String) GUID
│   ├── type                     ───> Traveller Type(String) e.g "adult"
│   ├── title                    ───> Title(String) e.g "Mr"
│   ├── name                     ───> Traveller Name(String)
│   ├── surname                  ───> Traveller Surname(String)
│   ├── birthDate                ───> Traveller Birthdate(DateTime?)
│   ├── isLead                   ───> is Lead(Boolean) (True/False)
│   ├── email                    ───> Traveller Email(String)
│   ├── phone                    ───> Traveller Phone(String) e.g "5354443322"
│   ├── mobile                   ───> Traveller Mobile(String) e.g "5354443322"
│   └── nationality              ───> Traveller Nationality(String) e.g "TR"
├── hotelbookings                     ───> Array
    ├── offerId                   ───> Adult counts(String)
    ├── reservationNote           ───> Reservation Note (String)
    └── rooms
        ├── roomId                ───> Room Id(String)
        ├── travellers            ───> TravellerNo Array (String[])

 {
    "travellers": [{
        "travellerNo": "d6231437-c77d-43bb-adc8-73d9bcf72df8",
        "type": "adult",
        "title": "Mr",
        "name": "Name",
        "surname": "Surname",
        "birthDate": "1985-01-01T00:00:00Z",
        "isLead": true,
        "email": "test@test.com",
        "phone": "5354443322",
        "mobile": "4545454545",
        "nationality": "TR"
    },
    {
        "travellerNo": "b22c9033-9385-44ea-8b86-af8ddcb3c243",
        "type": "adult",
        "title": "Mr",
        "name": "Name 2",
        "surname": "Surname 2",
        "birthDate": "1988-09-11T00:00:00Z",
        "isLead": false,
        "nationality": "TR"
    }],
    "hotelBookings": [{
        "offerId": "206d0428-48fe-4f23-ac85-e5bc8953c10a",
        "reservationNote": "",
        "rooms": [{
            "roomId": "4059da97-9128-4e8a-8bad-3ad4b17aadb5",
            "travellers": ["d6231437-c77d-43bb-adc8-73d9bcf72df8",
            "b22c9033-9385-44ea-8b86-af8ddcb3c243"]
        }]
    }]

Response Sample


├── orderId         ───> orderId(String)
├── OrderNumber     ───> OrderNumber(String)
├── bookings             ───> Array
    ├── id               ───> Booking Id(String)
    ├── bookingNumber    ───> Booking Number(String)
    ├── documentUrl      ───> Document Url(String)
    ├── price            ───> Array
        ├── amount            ───> (Decimal)
        ├── currency          ───> (String)
    ├── cancellationPolicies  ───> Array
        ├── roomId            ───> Room Id (String)
        ├── permittedDate     ───> Permitted Date (DateTime)
        ├── feeType           ───> CancellationFeeType  Enum{Amount, Percent, Night}
        ├── fee               ───> Array
            ├── amount             ───> (Decimal)
            ├── currency           ───> (String)
        ├── buyingFeePrice    ───> Array
            ├── amount             ───> (Decimal)
            ├── currency           ───> (String)
        ├── description      ───> (String)
        ├── roomId           ───> (String)
    ├── status           ───> BookingStatus Enum{Pending, Confirmed, Cancelled, OnRequest, Rejected}
    ├── type             ───> (String)
    ├── checkIn          ───> (DateTime)
    ├── checkOut         ───> (DateTime)
    ├── cancellationDeadline   ───> (DateTime)

{
  "orderId": "84cbbe21-0d48-404e-ac5e-da1586fe6d4e",
  "orderNumber": "6563",
  "bookings": [
    {
      "id": "ecddf69c-0fc6-4057-963e-b4a7b4b8ed2f",
      "bookingNumber": "7536",
      "offerId": "206d0428-48fe-4f23-ac85-e5bc8953c10a",
      "documentUrl": "https://s3-eu-west-1.amazonaws.com/document.dev.paximum.com/Voucher/ecddf69c-0fc6-4057-963e-b4a7b4b8ed2f.pdf?AWSAccessKeyId=ASIAJLHRR2W4MHVXJNLQ&Expires=1448439175&x-amz-security-token=AQoDYXdzEEEasAItdhmoGnrWEhhNsY%2FKueTFFm6j4daw0suRUAiLWt%2FOm5RwvKXaGLwmG07bF25mjBiSZeJ3ehjoriLfNyE%2FHokhE0Ro2nJDIviYSvcfTc3%2BCnzv%2FvFyki5luwFoW5ekqn%2B0CFKp5xmrZNv7kibsGp0ra8d8J1jX5D9MLC95cgOZAAmq6Kcn1iK%2FBkpHfmzXLOwmKw%2FrWEmFCeGAFulBtoMg0d5Fs8jFxD8xwv2iNgKWRcBRE6YMHBvucDRd2BnHALjt7JDssV4oKKCuzd5Bhwtx8GBSYmc3%2FHTNbHd8S58jlvsNBQ1Z4%2BWMygU84ZruvBLOmHWwZR5c0bzkaybqnABsPmacVnDdnYlggY5BMUOOaWqzBjYFVIjh8HXZUqalcJkyBchiVRjJp0xCELb0rnDlIKLK1bIF&Signature=7t2k5uGNj6yTCL2cEIqkvaA4hOg%3D",
      "price": {
        "amount": 127.0,
        "currency": "EUR"
      },
      "cancellationPolicies": [
        {
          "roomId": "4059da97-9128-4e8a-8bad-3ad4b17aadb5",
          "permittedDate": "2013-02-28T07:51:56.911Z",
          "feeType": "Percent",
          "fee": {
            "amount": 100.0,
            "currency": "EUR"
          },
          "buyingFeePrice": {
            "amount": 127.0,
            "currency": "EUR"
          },
          "description": "This booking cannot be changed. If you need to make an amendment, please cancel and re-book for the new dates or room type. Before cancelling please be aware of the cancellation policy which was accepted at the time of booking.Know Before You Go   This property offers transfers from the airport (surcharges may apply). Guests must contact the property with arrival details 48 hours prior to arrival, using the contact information on the booking confirmation.  Reservations are required for massage services and spa treatments. Reservations can be made by contacting the resort prior to arrival, using the contact information on the booking confirmation. A fee for a mandatory Christmas Eve gala dinner is included in the total price displayed for stays on 24 December. A fee for a mandatory New Year's Eve gala dinner is included in the total price displayed for stays on 31 December.  One child 12 years old or younger stays free when occupying the parent or guardian's room, using existing bedding. No pets and no service animals are allowed at this property.  Mandatory Fees and Taxes   The charges below are included in your overall room price:New Year's Eve gala dinner feeChristmas Eve gala dinner fee We have included all charges provided to us by the property. However, charges can vary, for example, based on length of stay or the room you book. . Tourist/local/city taxes which generally include the use of local services needs to be paid at the hotel."
        },
        {
          "roomId": "4059da97-9128-4e8a-8bad-3ad4b17aadb5",
          "permittedDate": "2015-11-26T07:51:56.911Z",
          "feeType": "Percent",
          "fee": {
            "amount": 100.0,
            "currency": "EUR"
          },
          "buyingFeePrice": {
            "amount": 127.0,
            "currency": "EUR"
          },
          "description": "Tourist/local/city taxes which generally include the use of local services needs to be paid at the hotel."
        }
      ],
      "status": "Confirmed",
      "type": "Hotel",
      "checkIn": "0001-01-01T00:00:00Z",
      "checkOut": "0001-01-01T00:00:00Z",
      "cancellationDeadline": "0001-01-01T00:00:00Z"
    }
  ]
}

{
  "orderId": "84cbbe21-0d48-404e-ac5e-da1586fe6d4e",
  "bookingIds": [
    "ecddf69c-0fc6-4057-963e-b4a7b4b8ed2f"
  ]
}