Retrieve bookings

🆕
The Sandbox environment is available exclusively to new partners who begin their integration in Q4 2025.
https://api-sandbox.worldota.net/api/b2b/v3/hotel/order/info/

The call gets the order data of the successfully finished booking.

ℹ️

It is recommended that there should be a time gap between:

  • Receiving the booking confirmation.
  • Requesting the order information.

Sandbox limitations

⚠️
Use all field values and API keys obtained from the sandbox environment only within the sandbox. Don’t mix them with test or production environments.

Request

  • language. The field value is always en.

Response

  • Not supported fields:
    • orders.rooms_data.bedding_name.
    • orders.rooms_data.meal_name.
    • orders.rooms_data.taxes.name.
  • currency_code. For every object with this field, the value is always EUR.

Request example

curl --user '<KEY_ID>:<API_KEY>' 'https://api-sandbox.worldota.net/api/b2b/v3/hotel/order/info/' \
--header 'Content-Type: application/json' \
--data '{
  "ordering": {
    "ordering_type": "desc",
    "ordering_by": "created_at"
  },
  "pagination": {
    "page_size": "10",
    "page_number": "1"
  }, 
  "search": {
    "created_at": {
      "from_date": "2018-12-05T00:00"
    },
    "partner_order_ids": [
      "1c481611-6432-5157-03d6-6093g2b75gd1"
    ]
  },
  "language": "en"
}'

Request body

Response

Response example

{
  "data": {
    "current_page_number": 1,
    "found_orders": 1,
    "found_pages": 1,
    "orders": [
      {
        "agreement_number": "B2B-6",
        "amount_payable": {
          "amount": "306.00",
          "currency_code": "USD"
        },
        "amount_payable_vat": {
          "amount": "0",
          "currency_code": "USD"
        },
        "amount_payable_with_upsells": {
          "amount": "306.00",
          "currency_code": "USD"
        },
        "amount_refunded": {
          "amount": "0",
          "currency_code": "USD"
        },
        "amount_sell": {
          "amount": "306.00",
          "currency_code": "USD"
        },
        "amount_sell_b2b2c": {
          "amount": "306.00",
          "currency_code": "USD"
        },
        "amount_sell_b2b2c_commission": {
          "amount": "0",
          "currency_code": "USD"
        },
        "api_auth_key_id": 6,
        "cancellation_info": {
          "free_cancellation_before": "2025-04-25T00:00:00",
          "policies": [
            {
              "end_at": "2025-04-25T00:00:00",
              "penalty": {
                "amount": "0",
                "amount_info": null,
                "currency_code": "USD"
              },
              "start_at": null
            }
          ]
        },
        "cancelled_at": null,
        "checkin_at": "2025-04-25",
        "checkout_at": "2025-04-26",
        "contract_slug": "e816ddc4-b1f9-4b49-971e-12bf8ff7b8b0",
        "created_at": "2025-03-14T12:52:21",
        "has_tickets": false,
        "hotel_data": {
          "hid": null,
          "id": "arbatapart_apartments",
          "order_id": null
        },
        "invoice_id": "00006-00039",
        "is_cancellable": true,
        "is_checked": false,
        "meta_data": {
          "voucher_order_comment": null
        },
        "modified_at": "2025-03-14T12:52:31",
        "nights": 1,
        "order_id": 138,
        "order_type": "hotel",
        "partner_data": {
          "order_comment": null,
          "order_id": "1c481611-6432-5157-03d6-6093g2b75gd1"
        },
        "payment_data": {
          "invoice_id": 71,
          "invoice_id_v2": "00006-00039",
          "paid_at": null,
          "payment_by": null,
          "payment_due": "2025-04-25",
          "payment_pending": "2025-04-22",
          "payment_type": "deposit"
        },
        "roomnights": 1,
        "rooms_data": [
          {
            "bedding_name": [
              "nobedding"
            ],
            "guest_data": {
              "adults_number": 2,
              "children_number": 0,
              "guests": [
                {
                  "age": null,
                  "first_name": "Martin",
                  "first_name_original": null,
                  "is_child": false,
                  "last_name": "Smith",
                  "last_name_original": null
                },
                {
                  "age": null,
                  "first_name": "Eliot",
                  "first_name_original": null,
                  "is_child": false,
                  "last_name": "Smith",
                  "last_name_original": null
                }
              ]
            },
            "has_breakfast": false,
            "meal_name": "unknown",
            "no_child_meal": false,
            "room_idx": 0,
            "room_name": "Double Junior Suite"
          }
        ],
        "source": "b2b-api",
        "status": "completed",
        "supplier_data": {
          "confirmation_id": null,
          "name": null,
          "order_id": "a4d65cf8-39a5-4e7c-ab63-7f17cd5ad2c0"
        },
        "taxes": [],
        "total_vat": {
          "amount": "0",
          "currency_code": "USD",
          "included": false
        },
        "upsells": [],
        "user_data": {
          "arrival_datetime": null,
          "email": "[email protected]",
          "user_comment": null
        }
      }
    ],
    "total_orders": 41,
    "total_pages": 5
  },
  "debug": null,
  "error": null,
  "status": "ok"
}