BObookingexperts
CheckoutPortal Bookings

GET checkout_portal_bookings

Changed on

Returns a checkout portal bookings of the current channel

get/v3/checkout_portal/channels/{channel_id}/bookings

Request

Path parameters

channel_idstring required

Channel ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, created_at, updated_at

fields[checkout_portal_booking]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[locale]string

Filter on locale

filter[is_option]string

Filter on is_option

filter[promotion_token]string

Filter on promotion_token

filter[referrer]string

Filter on referrer

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[booking]string

Filter on booking. Specify a comma separated list of IDs to filter on.

filter[checkout_portal_reservations]string

Filter on checkout_portal_reservations. Specify a comma separated list of IDs to filter on.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: 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. Default: 'en'.

Response

CheckoutPortalBookingCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "checkout_portal_booking",
      "attributes": {
        "locale": "cs",
        "currency": "EUR"
      },
      "relationships": {
        "booking": {
          "data": {
            "type": "booking"
          }
        },
        "checkout_portal_reservations": {
          "data": [
            {
              "type": "checkout_portal_reservation"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "booking",
      "attributes": {
        "customer_desires_downpayment": true,
        "booker_desires_downpayment": true,
        "option_validity": 3,
        "locale": "cs",
        "currency": "EUR"
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer"
          }
        },
        "owner": {
          "data": {
            "type": "owner"
          }
        },
        "traffic_source": {
          "data": {
            "type": "traffic_source"
          }
        },
        "conversation": {
          "data": {
            "type": "conversation"
          }
        },
        "credit_cards": {
          "data": [
            {
              "type": "credit_card"
            }
          ]
        },
        "security_deposits": {
          "data": [
            {
              "type": "security_deposit"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "channel": {
          "data": {
            "type": "channel"
          }
        },
        "guest_invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "customer_invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "channel_invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "reservations": {
          "data": [
            {
              "type": "reservation"
            }
          ]
        },
        "payments": {
          "data": [
            {
              "type": "payment"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • warning

      added the new da-DK enum value to the /// response property for the response status

    • warning

      added the new da-DK enum value to the /////// response property for the response status

    • warning

      added the new en-GB enum value to the /// response property for the response status

    • warning

      added the new en-GB enum value to the /////// response property for the response status

    • warning

      added the new en-US enum value to the /// response property for the response status

    • warning

      added the new en-US enum value to the /////// response property for the response status

    • info

      added the optional property /////// to the response with the status