Get prices
Returns the prices of a price list within a date range, optionally filtered by property (property_ids
and property_codes, together at most 50 values; a property matching either is returned). A
from or to that is not a date in the YYYY-MM-DD format, a to before from, or too many values returns
400. When no property visible to the API user matches, the list is empty (200).
The prices are paginated, 1 to 50 per page (paging_limit, default 20), ordered by property_id, then by
the start of the period (from), then by price id: follow _pagination.next_cursor until it is null, because a
page can hold fewer items than paging_limit (for example when prices are changed while you are reading). A
cursor is valid for the same filters it was issued with. _pagination.total_items counts all the prices of
the filter, across all pages.
Requires the API key scope revenue:read.
path Parameters
priceList[0-9A-Za-z_.-]+ · requiredPrice list code: a label chosen by whoever writes the prices (not necessarily a rate plan of /api/v1/rate-plans). A list with no prices is not an error: reading it returns an empty list. Letters, digits, _, . and - only.
query Parameters
fromFirst day of the date range, in the YYYY-MM-DD format
toLast day of the date range (inclusive), in the YYYY-MM-DD format
property_idsOnly these properties (ids), comma-separated (property_ids=12,15). Together with property_codes at most 50 values. Omit both to get the prices of all properties.
property_codesOnly the properties with these codes, the code of /api/v1/properties (exact match, case-insensitive), comma-separated (property_codes=A1,B2). Together with property_ids at most 50 values. The code is a filter, not an identifier: use property_id to refer to a property.
paging_limitLimit items returned in response. Must be between 1 and 50
next_cursorGet prices › Responses
Set prices
Sets (creates or replaces) the prices of one or more properties in the price list of the path. To write more than one price list, make one request for each.
Each item sets one price (and min_stay) for every day from from to to, both included. The days of the
range that already have a price in the list are overwritten; the other days of the list are left untouched.
Periods that become adjacent with the same price and min_stay are merged into one, so when you read the
prices back the rows can differ from the ones you sent.
price is in euro (e.g. 5.12), not in cents: it must be between 0 and 100000 with at most two decimals,
so a client that sends cents (512.5, 51200) is rejected. The whole body is validated before anything is
written: an invalid item returns 400 (Item <n>: ...) and nothing is saved. A range is at most 366 days: for a
longer period send more items. A property that is not found or not enabled is skipped and reported in
warnings; the other items are saved.
Requires the API key scope revenue:write.
path Parameters
priceList[0-9A-Za-z_.-]+ · requiredPrice list code: a label chosen by whoever writes the prices (not necessarily a rate plan of /api/v1/rate-plans). A list with no prices is not an error: reading it returns an empty list. Letters, digits, _, . and - only.
Set prices › Request Body
property_idProperty id
fromFirst day of the period the price applies to (inclusive)
toLast day of the period the price applies to (inclusive), not before from
pricePrice per night in euro (e.g. 5.12), between 0 and 100000 with at most two decimals. On PUT a value outside that range, or with more decimals (a sign that cents were sent), rejects the whole request with 400 and nothing is written.
min_stayMinimum number of nights for a stay starting in the period, at least 1 (400 otherwise). Optional on PUT (default 1); always set on read.
max_stayNot supported: accepted but ignored on write, always null on read.
Set prices › Responses
Prices set
warnings
