DiscountActions

GET discount_actions

Changed on

Returns discount actions that are applicable to the channel

get/v3/channels/{channel_id}/discount_actions

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[discount_action]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[discount_percentage]string

Filter on discount_percentage

filter[minimum_number_of_nights]string

Filter on minimum_number_of_nights

filter[maximum_number_of_nights]string

Filter on maximum_number_of_nights

filter[days_in_advance_mode]string

Filter on days_in_advance_mode

filter[number_of_days_in_advance]string

Filter on number_of_days_in_advance

filter[coupon_codes]string

Filter on coupon_codes

filter[archived]string

Filter on archived

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[name]string

Filter on name

filter[administration]string

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

filter[discount_campaign]string

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

filter[promotion]string

Filter on promotion. 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[guest_group_limits]string

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

filter[rentable_types]string

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

filter[channels]string

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

include_archivedboolean

When true, archived discount actions are included in the response

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

DiscountActionCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "discount_action",
      "relationships": {
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "discount_campaign": {
          "data": {
            "type": "discount_campaign"
          }
        },
        "promotion": {
          "data": {
            "type": "promotion"
          }
        },
        "book_period": {
          "data": {
            "type": "period"
          }
        },
        "stay_period": {
          "data": {
            "type": "period"
          }
        },
        "guest_group_limits": {
          "data": [
            {
              "type": "guest_group_limit"
            }
          ]
        },
        "rentable_types": {
          "data": [
            {
              "type": "rentable_type"
            }
          ]
        },
        "channels": {
          "data": [
            {
              "type": "channel"
            }
          ]
        }
      }
    }
  ],
  "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 new optional query request parameter filter[promotion]

    • 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

      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 to the / response property anyOf list for the response status

    • info

      response property data/items/relationships/discount_campaign deprecated

    • info

      response property data/items/relationships/discount_campaign/data deprecated

    • info

      response property data/items/relationships/discount_campaign/data/id deprecated

    • info

      response property data/items/relationships/discount_campaign/data/meta deprecated

    • info

      response property data/items/relationships/discount_campaign/data/meta/method deprecated

    • info

      response property data/items/relationships/discount_campaign/data/meta/temp_id deprecated

    • info

      response property data/items/relationships/discount_campaign/data/type deprecated