BObookingexperts
MasterPriceLists

GET master price lists

Changed on

Returns master price lists of the administration

get/v3/administrations/{administration_id}/master_price_lists

Request

Path parameters

administration_idstring required

Administration 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[master_price_list]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[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[round_direction]string

Filter on round_direction

filter[administration]string

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

filter[simple_prices]string

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

filter[complex_prices]string

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

filter[price_rules]string

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

activeboolean

When true, only master price lists in use will be returned

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

MasterPriceListCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "master_price_list",
      "attributes": {
        "round_to": 0.01,
        "round_direction": "ceil"
      },
      "relationships": {
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "simple_prices": {
          "data": [
            {
              "type": "simple_price"
            }
          ]
        },
        "complex_prices": {
          "data": [
            {
              "type": "complex_price"
            }
          ]
        },
        "price_rules": {
          "data": [
            {
              "type": "rule"
            }
          ]
        }
      }
    }
  ],
  "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

  • ff81bc4fefa9Revision changes
    • info

      added the new optional query request parameter filter[price_rules]

    • 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