--- title: "GET checkout_portal_booking" method: GET path: "/v3/checkout_portal/channels/{channel_id}/bookings/{id}" tags: ["CheckoutPortal Bookings"] --- # GET checkout_portal_booking `GET /v3/checkout_portal/channels/{channel_id}/bookings/{id}` ## Request - Base URL: `https://api.bookingexperts.com` - URL: `https://api.bookingexperts.com/v3/checkout_portal/channels/{channel_id}/bookings/{id}` - Auth: one of: - API key in header `X-API-KEY` - OAuth 2 - Authorization code: `/oauth/authorize` - Token URL: `/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns a checkout portal booking of the current channel ## Path parameters - `channel_id` string, required - `id` string, required ## Query parameters - `fields[checkout_portal_booking]` string - `include` string ## Headers - `Accept-Language` string ## Response `200` CheckoutPortalBookingResponse - object - `data` CheckoutPortalBooking: A CheckoutPortal::Booking consists of one or more checkout_portal_reservations. It should be considered a shopping cart. A CheckoutPortal::Booking is not yet confirmed and does not block availability. Used for further processing through CheckoutPortal. Succesfully finishing CheckoutPortal proces will result in a blocking Booking. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `locale` 'cs' | 'da-DK' | 'de' | 'de-AT' | 'de-CH' | 'en-US' | 'en-GB' | 'es' | 'fr' | 'fr-BE' | 'fr-LU' | 'it' | 'nb' | 'nl' | 'nl-BE' | 'pl' | 'pt' | 'tr' | 'en' | 'da': Locale of customer. Checkout portal and other communication are done in this locale. - `currency` 'EUR' | 'USD' | 'CHF' | 'CZK' | 'TRY' | 'CVE' | 'XCG' | 'GBP' | 'NOK' | 'DKK' | 'ZAR': Depends on the configured currency on the administration - `is_option` boolean - `promotion_token` string: Optional, can be used for passing the promotion token of the owner of the accommodation. - `referrer` string: Optional, can be used for passing the reference to a channel. - `created_at` string, date-time - `updated_at` string, date-time - `total` object: The total order amount for the booking. Can be nil when the booking is not valid anymore - `currency` string - `value` string - `deposit` object - `currency` string - `value` string - `links` object: Links - `checkout_portal_url` string: Link to checkout_portal_url - `relationships` object: Relationships - `booking` object - `data` object - `id` string: booking ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `checkout_portal_reservations` object - `data` object[] - `id` string: checkout_portal_reservations ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `included` union[] - union - Booking: A Booking consists of one or more reservations. It should be considered a shopping cart. The Booking defines the total amount that needs to be paid. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `customer_desires_downpayment` boolean: DEPRECATED use booker_desires_downpayment instead - `booker_desires_downpayment` boolean: When true, only the initial downpayment will be invoiced on visiting the returned pay_url. - `after_payment_return_url` string - `redeemable_codes` string[] - `option_validity` integer: Returns the option validity in days when this is an option. Specify this attribute on create to make an option. - `remote_booking_nr` string: External booking number - `reference_nr` string: Reference number - `locale` 'cs' | 'da-DK' | 'de' | 'de-AT' | 'de-CH' | 'en-US' | 'en-GB' | 'es' | 'fr' | 'fr-BE' | 'fr-LU' | 'it' | 'nb' | 'nl' | 'nl-BE' | 'pl' | 'pt' | 'tr' | 'en' | 'da': Locale of customer. Is used for communication. - `memo` string: Returns the current content of the memo. Can be specified as input to set an initial memo. - `currency` 'EUR' | 'USD' | 'CHF' | 'CZK' | 'TRY' | 'CVE' | 'XCG' | 'GBP' | 'NOK' | 'DKK' | 'ZAR': Depends on the configured currency on the administration - `cancel_date` string, date: Date on which the reservation has been cancelled - `cancel_reason` string: Reason why the reservation is cancelled - `state` 'initial' | 'concept' | 'concept_to_be_accepted' | 'concept_option' | 'concept_to_be_accepted_option' | 'temporary' | 'temporary_to_be_accepted' | 'temporary_to_be_checked' | 'temporary_to_be_accepted_and_checked' | 'temporary_option' | 'temporary_to_be_accepted_option' | 'to_be_accepted' | 'to_be_accepted_option' | 'to_be_checked' | 'to_be_accepted_and_checked' | 'option' | 'rejected' | 'cancelling' | 'confirmed' | 'imported' | 'cancelled': Marks the state of the reservation. - `token` string: Unique token which is used to prevent tampering. Token is mostly used for all customer facing urls. - `confirmed_at` string, date-time: Moment at which the reservation has been confirmed. - `paid_by_customer` boolean: Indicates if the customer has fully paid. - `deposit_completed` boolean: Marks if the deposit fulfilled. - `booking_nr` string: Unique number to identify the booking. - `owner_reservation` boolean: Indicates if this is a reservation of the owner of the accommodation. - `original_total` object - `currency` string - `value` string - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_without_vat_without_deposit` object - `currency` string - `value` string - `guest_payment_due` object - `currency` string - `value` string - `guest_total_paid` object - `currency` string - `value` string - `deposit` object - `currency` string - `value` string - `rent_turnover` object - `currency` string - `value` string - `rent_turnover_without_vat` object - `currency` string - `value` string - `provision` object - `currency` string - `value` string - `payment_deadlines` object[] - `date` string, date - `open_amount` object - … - `paid_amount` object - … - `payment_deadlines_with_deposit` object[] - `date` string, date - `open_amount` object - … - `paid_amount` object - … - `included_security_deposits` object[] - … - `pending_vouchers` object[] - `code` string - `balance` object - … - `amount` object - … - `created_at` string, date-time - `updated_at` string, date-time - `links` object: Links - `self` string: Link to self - `url` string: Link to url - `payment_portal_url` string: URL for the booking or current guest invoice in the payment portal. Will show available payment terms when the booking has not been fully paid by the guest. - `pay_url` string: URL for collecting payments for this booking. Price can be set via query parameter `payment_request[price]`. - `relationships` object: Relationships - `customer` object: When included, returns the customer details of the booking. This relationship can be managed via sideposting. - `data` object - … - `owner` object: Returns the Owner if this is a booking for an owner. - `data` object - … - `traffic_source` object - `data` object - … - `conversation` object: Optionally create a conversation linked to this booking - `data` object - … - `credit_cards` object - `data` object[] - … - `security_deposits` object - `data` object[] - … - `administration` object - `data` object - … - `channel` object - `data` object - … - `guest_invoice` object: DEPRECATED use customer_invoice instead - `data` object - … - `customer_invoice` object - `data` object - … - `channel_invoice` object - `data` object - … - `reservations` object - `data` object[] - … - `payments` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - CheckoutPortalReservation: A CheckoutPortal::Reservation can be considered a shopping cart item. Part of a CheckoutPortal::Booking and used for processing through CheckoutPortal. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `start_date` string, date, required - `end_date` string, date, required - `amenity_ids` string[] - `extra_package_ids` string[] - `guest_group` object - `seniors` integer - `adults` integer - `adolescents` integer - `children` integer - `babies` integer - `pets` integer - `total` object: The total order amount for the reservation. Can be nil when the reservation is not valid anymore - `currency` string - `value` string - `deposit` object - `currency` string - `value` string - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `checkout_portal_booking` object: Returns the booking of the reservation. This relationship can be managed via sideposting. - `data` object - … - `category` object: DEPRECATED use rentable_type instead - `data` object - … - `rentable_type` object - `data` object - … - `fixed_rentable` object - `data` object - … - `primary_package` object - `data` object - … - `fixed_rentable_identity` object: DEPRECATED use fixed_inventory_object instead - `data` object - … - `fixed_inventory_object` object - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. ## Other responses - `429`: Error - `default`: Error ## Changes - **2026-11-03** `ff81bc4fefa9`: 6 warning, 1 info - added the new `da-DK` enum value to the `data/attributes/locale` response property for the response status `200` - added the new `da-DK` enum value to the `included/items/anyOf[#/components/schemas/Booking]/attributes/locale` response property for the response status `200` - added the new `en-GB` enum value to the `data/attributes/locale` response property for the response status `200` - added the new `en-GB` enum value to the `included/items/anyOf[#/components/schemas/Booking]/attributes/locale` response property for the response status `200` - …3 more [Operation history](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/changes/v3/checkout_portal/channels/:channel_id/bookings/:id/get.md) --- [API](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3.md) - [All operations](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/revisions/ff81bc4fefa9?raw)