v1

latestOpenAPI 3.0.02026-07-243271291.7 MB

CheckoutPortal Bookings

GET checkout_portal_bookings

Returns a checkout portal bookings of the current channel

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

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, de, de-AT, de-CH, en, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr. Default: 'en'.

Response

CheckoutPortalBookingCollectionResponse