Place Order

Last Update Date	13.07.2023

Request Url

http://api.stage.paximum.com/v1/booking/placeorder

Request Model

Attribute	Type	Required	Description
Travellers	Array (Object)	Yes	Travellers of the booking
Attribute Type Required Description TarvellerNO String Yes Unique no for traveller, this value should add booking rooms travellers Type String Yes Traveller type (Adult, Child or Infant) Title String Yes Traveller title (Mr, Ms, Mrs, Mss, Chd or Inf) Name String Yes Traveller name Surname String Yes Traveller surname BirthDate String Yes Traveller age, optional for adults Islead Bool Yes One of the travellers must be the leader Email String No Mandatory for the leader Phone String No Mandatory for the leader Mobil String No Mobil Nationality String Yes Traveller nationality
HotelBookings	Array (Object)	Yes	Bookings
Attribute Type Required Description OfferId String Yes Selected offer id ReservationNote String No Customer note for booking Rooms Array (Object) Yes Rooms of the offer Attribute Type Required Description RoomId String Yes Room id Travellers Array (String) Yes The TarvellerNO of the travellers in the room, these numbers should be defined in request travellers
AgencyReferenceNumber	String	Yes	Your reference number

You must make a request before the offer expired
You must send the room Id we have provided
We can return a response in up to 2 minutes, usually under 1 minute.
Confirmed is the only expected status when placeOrder is successful.

Request Sample

    
 {
    "travellers": [
        {
            "travellerNo": "1",
            "type": "adult",
            "title": "Mr",
            "name": "Name",
            "surname": "Surname",
            "isLead": true,
            "email": "name.surname@paximum.com",
            "phone": "15225215125",
            "mobile": "15225215125",
            "nationality": "DE"
        },
        {
            "travellerNo": "2",
            "type": "adult",
            "title": "Mr",
            "name": "Name",
            "surname": "Surname",
            "isLead": false,
            "phone": null,
            "mobile": null,
            "nationality": "DE"
        }
    ],
    "hotelBookings": [
        {
            "offerId": "12fb5389-d500-4b56-a887-3b08708d85fb",
            "rooms": [
                {
                    "roomId": "811a69ef-a561-4d72-a7d3-dc721ccce589",
                    "travellers": [
                        "1",
                        "2"
                    ]
                }
            ]
        }
    ],
    "AgencyReferenceNumber":"ARN123"
}

Response Model

Attribute	Type	Description
OrderId	String
OrderNumber	String
Bookings	Array (Object)
Attribute Type Description Id String Booking id, this id will be used for retrieve and cancellation BookingNumber String Booking Number OfferId String DocumentUrl String Status String Bookig status(Confirmed,OnRequest,Rejected,Cancelled,Pending) Price Object Booking selling price Attribute Type Description Amount Decimal Currency String CancellationPolicy Object Booking cancellation policy Attribute Type Description PermitedDate String Penalty start date Fee Object Penalty Fee Attribute Type Description Amount Decimal Currency String

Response Sample

    
{
    "orderId": "826d3ab4-6ec8-4f33-b68d-c18dbd3f8465",
    "orderNumber": "148471",
    "bookings": [
        {
            "id": "58a47e23-8e35-4f3b-b7d9-be69e6315cb2",
            "bookingNumber": "158725",
            "offerId": "12fb5389-d500-4b56-a887-3b08708d85fb",
            "documentUrl": "https://s3.eu-west-1.amazonaws.com/document.stage.paximum.com/Voucher/58a47e23-8e35-4f3b-b7d9-be69e6315cb2.pdf?X-Amz-Expires=1200&X-Amz-Security-Token=FwoGZXIvYXdzEIb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDOmrnO6UIX9y8CyqMyLEAcwWzYfM288EODeDMFLVh9UhCfpbUFxfLYj4lCDFfW%2F3cB%2B6PeU0QjqobVaUQyLwOuEEJSb5zH3tx7iD5uSA3UMWuJou5ODmJWS9J%2B38cw2q%2BZweQsNqNPKMceGqd%2Fr7pskDxwszhHE2XhYToNERTVEgkGXwjqwJidjbUWDGaDAwhysZ8qsQRtk2zBgiDdRKOMphVqRO%2Fz%2BlLJYh3Qaar6jaFin4YGen3pOnJ3J5zadl1nwv1qcE3PyslPLBenyVyXwRw2MooeW%2FpQYyLff%2B1Zn%2BxZr9LakBc6Hd28%2Fz1I78jsJLdZZ5vKipWs3PEe33byRM8hhANxZjOA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA45B6TOULW3U5PEVJ/20230713/eu-west-1/s3/aws4_request&X-Amz-Date=20230713T130530Z&X-Amz-SignedHeaders=host&X-Amz-Signature=3af7d3a716b96fb9e38caad4b895b2e49f6eef496f92e9cbfe6c46cfde95689f",
            "price": {
                "amount": 104.1433,
                "currency": "EUR"
            },
            "cancellationPolicies": [
                {
                    "permittedDate": "2023-08-29T10:00:00Z",
                    "fee": {
                        "amount": 104.1433,
                        "currency": "EUR"
                    }
                }
            ],
            "status": "Confirmed",
            "paymentStatus": "Unpaid",
            "type": "Hotel",
            "checkIn": "2023-09-02T00:00:00Z",
            "checkOut": "2023-09-03T00:00:00Z",
            "cancellationDeadline": "2023-08-29T10:00:00Z"
        }
    ]
}