Channel PrimaryPackages

GET primary packages

Changed on

Returns the primary packages that are available to the current channel

get/v3/channels/{channel_id}/primary_packages

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[primary_package]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[name]string

Filter on name

filter[short_description]string

Filter on short_description

filter[description]string

Filter on description

filter[start_date]string

Filter on start_date

filter[end_date]string

Filter on end_date

filter[position]string

Filter on position

filter[archived]string

Filter on archived

filter[applies_to_all_rentable_types]string

Filter on applies_to_all_rentable_types

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[administration]string

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

filter[book_period]string

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

filter[stay_period]string

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

filter[discount_action]string

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

filter[images]string

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

filter[package_entries]string

Filter on package_entries. 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

PrimaryPackageCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "primary_package",
      "relationships": {
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "book_period": {
          "data": {
            "type": "period"
          }
        },
        "stay_period": {
          "data": {
            "type": "period"
          }
        },
        "discount_action": {
          "data": {
            "type": "discount_action"
          }
        },
        "images": {
          "data": [
            {
              "type": "image"
            }
          ]
        },
        "package_entries": {
          "data": [
            {
              "type": "package_entry"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "administration",
      "relationships": {
        "city": {
          "data": {
            "type": "city"
          }
        },
        "checkin_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "checkout_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "interactive_map": {
          "data": {
            "type": "interactive_map"
          }
        },
        "payment_handlers": {
          "data": [
            {
              "type": "payment_handler"
            }
          ]
        }
      }
    }
  ]
}

Changes

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign deprecated

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign/data deprecated

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign/data/id deprecated

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign/data/meta deprecated

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign/data/meta/method deprecated

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign/data/meta/temp_id deprecated

    • info

      response property included/items/anyOf[DiscountAction]/relationships/discount_campaign/data/type deprecated