{"openapi":"3.1.0","info":{"title":"Customer API","version":"1.0.0"},"paths":{"/v1/listings":{"get":{"operationId":"listings_allListings","summary":"Get all listings in an account","description":"This API call will return all the listings in a customer's account across all PMSs, with their minimum price, base price, recommended base price and maximum price along with other Performance Metrics available on the Pricing Dashboard and Multi-Calendar pages. You can find performance metrics after clicking \"Add Metrics\" button on the Pricing Dashboard or Multi Calendar.","tags":["listings"],"parameters":[{"name":"skip_hidden","in":"query","description":"This param can be used to filter hidden listings. Default is false, which returns all listings including hidden ones. Set to true to exclude hidden listings.","required":false,"schema":{"type":"boolean","default":false}},{"name":"only_syncing_listings","in":"query","description":"This param can be used to filter listings based on their sync status. Default is false, which returns all listings in the PriceLabs user account. If set to true, only listings with sync turned ON are returned.","required":false,"schema":{"type":"boolean","default":false}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listings_allListings_Response_200"}}}}}},"post":{"operationId":"listings_updateListings","summary":"Update one or more listings in an account","description":"Update pricing, tags, sync status, and group/subgroup assignment for one or more listings in a PriceLabs account.","tags":["listings"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listings_updateListings_Response_200"}}}},"400":{"description":"Missing listings, or id/pms is blank or not a string","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateListingsRequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"listings":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsPostRequestBodyContentApplicationJsonSchemaListingsItems"},"description":"Listings to update"}},"required":["listings"]}}}}}},"/v1/listings_minimal":{"get":{"operationId":"listings_minimalListings","summary":"Get a minimal list of listings","description":"Returns a minimal, lightweight list of every listing in the account — just the core identifying fields (`listing_id`, `pms_name`, `listing_name`, `property_name`, `parent_key`, `group_id`), whether sync is on (`push_enabled`), plus each listing's IDs on the booking channels/OTAs it is published on (`channel_listing_details` — Airbnb, Vrbo, Booking.com, Expedia, etc.). Unlike `GET /v1/listings`, this call returns no performance metrics or pricing, so it stays fast for large accounts that just need a quick listing directory or to map their PriceLabs listings to the corresponding channel listing IDs.","tags":["listings"],"parameters":[{"name":"search_query","in":"query","description":"Partial match on listing name, ID fragment, city, tags, or groups.","required":false,"schema":{"type":"string"}},{"name":"listing_name","in":"query","description":"Partial match on listing name only (not for numeric IDs or UUIDs).","required":false,"schema":{"type":"string"}},{"name":"listings","in":"query","description":"Comma-separated exact listing IDs or UUIDs to return.","required":false,"schema":{"type":"string"}},{"name":"pms","in":"query","description":"Comma-separated PMS names to filter by (e.g. airbnb,hostaway).","required":false,"schema":{"type":"string"}},{"name":"cities","in":"query","description":"Comma-separated city names to filter by.","required":false,"schema":{"type":"string"}},{"name":"groups","in":"query","description":"Comma-separated group names to filter by.","required":false,"schema":{"type":"string"}},{"name":"subgroups","in":"query","description":"Comma-separated sub-group names to filter by.","required":false,"schema":{"type":"string"}},{"name":"only_syncing_listings","in":"query","description":"This param can be used to filter listings based on their sync status. Default is false, which returns all listings in the PriceLabs user account. If set to true, only listings with sync turned ON are returned.","required":false,"schema":{"type":"boolean","default":false}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listings_minimalListings_Response_200"}}}},"403":{"description":"Forbidden — missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinimalListingsRequestForbiddenError"}}}}}}},"/v1/listings/{listing_id}":{"get":{"operationId":"listings_singleListing","summary":"Get a specific listing in an account","description":"This API call will return a specific listing in a customer's account, with their minimum price, base price, recommended base price and maximum price along with other Performance Metrics available on the Pricing Dashboard and Multi-Calendar pages. You can find performance metrics after clicking \"Add Metrics\" button on the Pricing Dashboard or Multi Calendar.","tags":["listings"],"parameters":[{"name":"listing_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listings_singleListing_Response_200"}}}}}}},"/v1/listing_metrics":{"get":{"operationId":"listings_getListingPerformanceMetrics","summary":"Get listing performance metrics","description":"Returns numerical KPI data for a single listing, including listing-level metrics\nand market-level comparison data. Metrics include occupancy, revenue, ADR, RevPAR,\nadjusted occupancy, base price ratio, min prices (Days at Minimum Price), and last booked date.\n\n**Response Structure:**\n- **listing_level**: Raw metric values from the listing's own historical data. DFD (Days From Date, i.e. days relative to today)-based metrics have nested objects keyed by DFD string. Non-DFD metrics (`bp_ratio`, `last_booked_date`) are scalar values. STLY (Same Time Last Year) comparisons are stored as `stly_<metric_name>` keys.\n- **market_level**: Raw market comparison values from portfolio/market engine data. Only includes metrics with market comparison (occupancy, adjusted_occupancy, adr).\n\n**Useful Comparisons:**\n- **Listing vs Market:** Compare `listing_level[metric][dfd]` with `market_level[metric][dfd]` at the same DFD (Days From Date) for occupancy/ADR to gauge pricing position.\n- **Listing vs STLY:** Compare `listing_level.revenue[dfd]` with `listing_level.stly_revenue[dfd]` for year-over-year growth.\n- **bp_ratio:** > 1 means priced above recommendation, < 1 means below.\n- **min_prices:** Percentage of days at minimum price per future window. High values suggest a base price review.\n\n**DFD (Days From Date) Keys:**\n\nKeys are strings. Metrics are calculated and stored per listing, so all windows are relative to the date\nthe metrics were last calculated, not the time of the API request.\n\nRegular keys count days: negative = the past N days, positive = the next N days (e.g. `-30`, `7`, `90`).\nDefault set: `-90, -60, -45, -30, -21, -15, -7, 1, 2, 3, 7, 10, 15, 21, 30, 45, 60, 90, 120, 180, 240, 300, 360`.\n`min_prices` uses only `7, 15, 21, 30, 45, 60, 90`.\n\nSpecial keys are fixed calendar periods. Their sign does **not** mean past or future:\n\n| Key | Period | Date range |\n|---|---|---|\n| `-999` | Year to date | 1 January of the current year up to the calculation date |\n| `-998` | Previous month | The full previous calendar month |\n| `-997` | Current month | The full current calendar month, 1st to last day (includes upcoming dates) |\n| `998` | Next month | The full next calendar month |\n| `-995` | Current quarter | The full current calendar quarter (includes upcoming dates) |\n| `995` | Next quarter | The full next calendar quarter |\n\n`-995` and `995` appear on `occupancy`, `revenue`, `adr`, `revpar` and the `goal_completion_*` metrics.\n`stly_*` metrics use `-999`, `-998`, `-997` and `998` for the equivalent period last year.\n","tags":["listings"],"parameters":[{"name":"listing_id","in":"query","description":"Unique listing ID (same as PriceLabs dashboard).","required":true,"schema":{"type":"string"}},{"name":"pms_name","in":"query","description":"PMS name the listing belongs to.","required":true,"schema":{"type":"string"}},{"name":"X-API-Key","in":"header","description":"API key for Customer API authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Performance metrics retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listings_getListingPerformanceMetrics_Response_200"}}}},"400":{"description":"Missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetListingPerformanceMetricsRequestBadRequestError"}}}},"401":{"description":"Unauthorized — invalid or missing API key.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Listing not found or user does not have access.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetListingPerformanceMetricsRequestNotFoundError"}}}},"422":{"description":"Metrics data could not be parsed for this listing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetListingPerformanceMetricsRequestUnprocessableEntityError"}}}}}}},"/v1/mappings/map":{"post":{"operationId":"mappings_mapListings","summary":"Map listings under a parent listing","description":"Maps (links) one or more child listings under a parent listing — parent-child mapping. Mapping groups the same physical property's listings across channels (for example its Airbnb and Vrbo listings) under one parent so they are managed and priced together.\n\nBy default this only links the listings: nothing is copied from the parent, and children keep their own prices and settings. Use the optional `copy` flags to copy the parent's prices or settings to the children at map time.\n\n> **Warning:** `copy.customization` also deletes each child's future date-specific overrides and replaces them with the parent's.","tags":["mappings"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Listings mapped successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mappings_mapListings_Response_200"}}}},"400":{"description":"Validation failure — unknown listing (ERR-LISTING-NOT-FOUND), parent is itself a child (ERR-INVALID-PARENT), child already mapped (ERR-ALREADY-MAPPED), too many children (ERR-MAX-CHILD), listings too far apart (ERR-MAP-DISTANCE), same-PMS mapping not allowed, or missing params (ERR-NO-PARENT / ERR-NO-CHILDREN).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapListingsRequestBadRequestError"}}}},"403":{"description":"No mapping permission (ERR-NO-ACCESS) — the account-level mapping permission and per-listing write permission are required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapListingsRequestForbiddenError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parent":{"$ref":"#/components/schemas/V1MappingsMapPostRequestBodyContentApplicationJsonSchemaParent","description":"The listing that will be the parent. Must not itself be mapped as a child."},"children":{"type":"array","items":{"$ref":"#/components/schemas/V1MappingsMapPostRequestBodyContentApplicationJsonSchemaChildrenItems"},"description":"Listings to map under the parent. Each must currently be unmapped (standalone); an already-mapped listing must be unmapped first. A child cannot be on the same PMS as the parent (unless same-PMS mapping is enabled for the account)."},"copy":{"$ref":"#/components/schemas/V1MappingsMapPostRequestBodyContentApplicationJsonSchemaCopy","description":"What to copy from the parent to each child at map time. All default false."}},"required":["parent","children"]}}}}}},"/v1/mappings/unmap":{"post":{"operationId":"mappings_unmapListings","summary":"Unmap listings from their parent","description":"Unmaps (detaches) listings from their parent-child mapping group. Each listing becomes standalone again and keeps its own prices and settings. Unmapping a parent listing detaches its whole group. Partial success is supported — the response lists which listings were unmapped and which failed.","tags":["mappings"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Unmap processed (partial success possible — check both arrays)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mappings_unmapListings_Response_200"}}}},"400":{"description":"Missing or invalid listings param (ERR-NO-LISTINGS)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmapListingsRequestBadRequestError"}}}},"403":{"description":"No mapping permission (ERR-NO-ACCESS)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmapListingsRequestForbiddenError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"listings":{"type":"array","items":{"$ref":"#/components/schemas/V1MappingsUnmapPostRequestBodyContentApplicationJsonSchemaListingsItems"},"description":"The listings to unmap."}},"required":["listings"]}}}}}},"/v1/groups":{"get":{"operationId":"groups_getAccountGroups","summary":"Get all groups in an account","description":"Returns all groups available in the customer's account. Each group includes whether it currently has listings assigned to it.","tags":["groups"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Groups_getAccountGroups_Response_200"}}}}}},"post":{"operationId":"groups_createGroup","summary":"Create a new group","description":"Creates a new group and returns the group ID.","tags":["groups"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Groups_createGroup_Response_200"}}}},"400":{"description":"Bad request — missing or invalid group name.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupRequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"group_name":{"type":"string","description":"Name of the group"}},"required":["group_name"]}}}}}},"/v1/group_listings":{"get":{"operationId":"groups_getGroupListings","summary":"Get listings assigned to a group or subgroup","description":"Returns listings assigned to the provided `group_id` or `subgroup_id`. At least one of `group_id` or `subgroup_id` is required. If both are provided, listings must match both filters.","tags":["groups"],"parameters":[{"name":"group_id","in":"query","description":"Numeric ID of the group","required":false,"schema":{"type":"integer"}},{"name":"subgroup_id","in":"query","description":"Numeric ID of the subgroup","required":false,"schema":{"type":"integer"}},{"name":"page_size","in":"query","description":"Number of listings to return per page. Defaults to 50.","required":false,"schema":{"type":"integer","default":50}},{"name":"page_number","in":"query","description":"Page number to fetch. Defaults to 1.","required":false,"schema":{"type":"integer","default":1}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Groups_getGroupListings_Response_200"}}}},"400":{"description":"Bad request — missing or invalid group/subgroup filter or invalid pagination params","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGroupListingsRequestBadRequestError"}}}}}}},"/v1/listings/{listing_id}/overrides":{"get":{"operationId":"dateSpecificOverridesDso_listingDateLevelOverrides","summary":"To fetch a listing's date specific overrides","description":"Use this API to get your listing's date specific overrides. By default, only overrides from today onwards are returned. Use the optional `start_date` and `end_date` query parameters to filter the date range.","tags":["dateSpecificOverridesDso"],"parameters":[{"name":"listing_id","in":"path","description":"Listing ID","required":true,"schema":{"type":"string"}},{"name":"pms","in":"query","description":"PMS name of the listing","required":true,"schema":{"type":"string"}},{"name":"start_date","in":"query","description":"Filter overrides from this date onwards (YYYY-MM-DD). Defaults to today if omitted.","required":false,"schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"Filter overrides up to and including this date (YYYY-MM-DD). If omitted, all overrides from `start_date` onwards are returned.","required":false,"schema":{"type":"string","format":"date"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Date_Specific_Overrides__DSO__listingDateLevelOverrides_Response_200"}}}},"400":{"description":"Missing listing_id or pms","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingDateLevelOverridesRequestBadRequestError"}}}},"404":{"description":"Listing not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingDateLevelOverridesRequestNotFoundError"}}}}}},"post":{"operationId":"dateSpecificOverridesDso_listingDateLevelOverrides1","summary":"Add/Update a listing's date specific override","description":"Use this API to add or update date specific overrides for a listing.\n\n**Notes**\n- If any override in the request fails validation, the entire request fails with 400 and no overrides are saved.\n- Price type option `percent_stacked` option is available only for users who have the feature enabled, if you want to use it, please reach out to support@pricelabs.co.\n","tags":["dateSpecificOverridesDso"],"parameters":[{"name":"listing_id","in":"path","description":"Listing ID","required":true,"schema":{"type":"string"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Date_Specific_Overrides__DSO__listingDateLevelOverrides1_Response_200"}}}},"400":{"description":"Bad request — missing params, invalid update_children, listing not found, or validation failed for an override","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingDateLevelOverrides1RequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"overrides":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsListingIdOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItems"},"description":"Date specific overrides to add or update"},"pms":{"type":"string","description":"PMS name of the listing"},"update_children":{"type":"boolean","description":"Must be a JSON boolean (`true` or `false`). If `true`, the DSO is also updated for all child listings. If `false` or omitted, only the parent listing is updated."}},"required":["overrides","pms"]}}}}},"delete":{"operationId":"dateSpecificOverridesDso_listingDateLevelOverrides2","summary":"Delete a listing's date specific override","description":"Use this API to delete date specific overrides for a listing.","tags":["dateSpecificOverridesDso"],"parameters":[{"name":"listing_id","in":"path","description":"Listing ID","required":true,"schema":{"type":"string"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"A successful response with status 204. The response body will be empty","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Date_Specific_Overrides__DSO__listingDateLevelOverrides2_Response_204"}}}},"400":{"description":"Bad request — missing params, invalid update_children, or listing not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListingDateLevelOverrides2RequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"overrides":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsListingIdOverridesDeleteRequestBodyContentApplicationJsonSchemaOverridesItems"},"description":"Override dates to delete"},"pms":{"type":"string","description":"PMS name of the listing"},"update_children":{"type":"boolean","description":"Must be a JSON boolean (`true` or `false`). If `true`, the DSO is also deleted for all child listings. If `false` or omitted, only the parent listing is deleted."}},"required":["overrides","pms"]}}}}}},"/v1/group_overrides":{"get":{"operationId":"dateSpecificOverridesDso_getGroupOverrides","summary":"Fetch a group's date specific overrides","description":"Returns date specific overrides (DSOs) for a group. Only overrides from today onwards are returned.\n\nUse `GET /v1/groups` to obtain valid group IDs.\n","tags":["dateSpecificOverridesDso"],"parameters":[{"name":"id","in":"query","description":"Numeric ID of the group","required":true,"schema":{"type":"integer"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Date_Specific_Overrides__DSO__getGroupOverrides_Response_200"}}}},"400":{"description":"Bad request — missing or invalid group id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGroupOverridesRequestBadRequestError"}}}}}},"post":{"operationId":"dateSpecificOverridesDso_updateGroupOverrides","summary":"Add/Update a group's date specific overrides","description":"Add or update date specific overrides for a group. Valid dates are from today through 2 years from today.\n\n**Notes**\n- Successfully validated overrides are saved even if other dates in the same request fail. Failed dates are returned in `failed_dates`.\n- `price_type` values for group DSOs are `fixed`, `percent`, and `percent_base`. `percent_stacked` is not supported.\n- For fixed prices, the value must be greater than 10.\n- Team members need write permission on the group.\n","tags":["dateSpecificOverridesDso"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success — includes successfully saved overrides and any per-date failures","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Date_Specific_Overrides__DSO__updateGroupOverrides_Response_200"}}}},"400":{"description":"Bad request — missing/invalid group id or missing/empty overrides array","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGroupOverridesRequestBadRequestError"}}}},"403":{"description":"Write access denied for the authenticated team member on this group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGroupOverridesRequestForbiddenError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Numeric ID of the group"},"overrides":{"type":"array","items":{"$ref":"#/components/schemas/V1GroupOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItems"},"description":"Date specific overrides to add or update"}},"required":["id","overrides"]}}}}},"delete":{"operationId":"dateSpecificOverridesDso_deleteGroupOverrides","summary":"Delete a group's date specific overrides","description":"Delete date specific overrides for a group by date.\n\n**Notes**\n- Past dates cannot be deleted and are returned in `failed_dates`.\n- Dates with no existing DSO are returned in `failed_dates`.\n- Successfully deleted dates are returned in `deleted_dates`.\n- Team members need write permission on the group.\n","tags":["dateSpecificOverridesDso"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success — includes deleted dates and any per-date failures","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Date_Specific_Overrides__DSO__deleteGroupOverrides_Response_200"}}}},"400":{"description":"Bad request — missing/invalid group id or missing/empty overrides array","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGroupOverridesRequestBadRequestError"}}}},"403":{"description":"Write access denied for the authenticated team member on this group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGroupOverridesRequestForbiddenError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Numeric ID of the group"},"overrides":{"type":"array","items":{"$ref":"#/components/schemas/V1GroupOverridesDeleteRequestBodyContentApplicationJsonSchemaOverridesItems"},"description":"Override dates to delete"}},"required":["id","overrides"]}}}}}},"/v1/listing_prices":{"post":{"operationId":"prices_forListings","summary":"Get prices for listings","description":"Get prices for listings in your PriceLabs account. Returns the last-refreshed price information for each listing.","tags":["prices"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingPricesPostResponsesContentApplicationJsonSchemaItems"}}}}},"400":{"description":"Bad request — missing/invalid `listings` array or non-string `id`/`pms`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricesForListingsRequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"listings":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingPricesPostRequestBodyContentApplicationJsonSchemaListingsItems"},"description":"Listings to fetch prices for. Each listing and its PMS must already exist in your PriceLabs account."}},"required":["listings"]}}}}}},"/v1/refresh_listing":{"post":{"operationId":"prices_refreshListing","summary":"Refresh a listing","description":"Recalculates prices for a listing on demand — the API equivalent of \"Save & Refresh\" in the PriceLabs app.\n\nWrites such as [date-specific overrides](api:capi:POST/v1/listings/{listing_id}/overrides) are stored immediately but do not trigger a recalculation on their own: the prices returned by [POST /v1/listing_prices](api:capi:POST/v1/listing_prices) update at the next scheduled refresh (roughly every 24 hours). Call this endpoint after making your changes to apply them right away. The call is synchronous and returns the freshly computed pricing calendar in the response, so you can verify your changes in the same round trip.\n\n> **Rate limits:** 3 calls per listing per 24 hours, and 10 calls per account per minute. Batch all changes for a listing before refreshing it.","tags":["prices"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success — the listing was recalculated. The response contains the freshly computed pricing calendar.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Prices_refreshListing_Response_200"}}}},"400":{"description":"Bad request — missing `listing_id`/`pms`, unknown listing, or the refresh failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshListingRequestBadRequestError"}}}},"429":{"description":"Rate limit exceeded — more than 3 refreshes for this listing in 24 hours, or more than 10 calls for the account in a minute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshListingRequestTooManyRequestsError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"listing_id":{"type":"string","description":"Unique listing ID. The listing must exist in your PriceLabs account."},"pms":{"type":"string","description":"PMS name for the listing. Must match the PMS the listing is connected under in PriceLabs."}},"required":["listing_id","pms"]}}}}}},"/v1/fetch_rate_plans":{"get":{"operationId":"prices_fetchRatePlans","summary":"Fetch rate plan adjustments for your listings","description":"If your listings have rate plan adjustments, you can use this API call to fetch those adjustments. You can fetch the prices for the default rate plan using the [POST /v1/listing_prices](api:capi:POST/v1/listing_prices) call and use the adjustments returned in this call to derive the prices of the non-default rate plans for your system.","tags":["prices"],"parameters":[{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"pms_name","in":"query","required":true,"schema":{"type":"string"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Prices_fetchRatePlans_Response_200"}}}},"403":{"description":"Missing listing_id/pms_name or listing not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchRatePlansRequestForbiddenError"}}}}}}},"/v1/neighborhood_data":{"get":{"operationId":"neighborhoodData_getNeighborhoodDataForAListing","summary":"Get neighborhood data for a listing","description":"Get neighborhood data for your listing with all stats shown on the Neighborhood Tab.","tags":["neighborhoodData"],"parameters":[{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"pms","in":"query","required":true,"schema":{"type":"string"}},{"name":"use_default_data","in":"query","description":"When `true` uses default data source instead of source selected on the UI.","required":false,"schema":{"$ref":"#/components/schemas/V1NeighborhoodDataGetParametersUseDefaultData","default":"false"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Neighborhood_Data_getNeighborhoodDataForAListing_Response_200"}}}},"400":{"description":"Invalid request, sync off, or payment issue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNeighborhoodDataForAListingRequestBadRequestError"}}}},"401":{"description":"Invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNeighborhoodDataForAListingRequestUnauthorizedError"}}}},"404":{"description":"Listing not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNeighborhoodDataForAListingRequestNotFoundError"}}}},"500":{"description":"Internal error while fetching neighborhood data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNeighborhoodDataForAListingRequestInternalServerError"}}}}}}},"/v1/neighborhood_data/fetch_sources":{"get":{"operationId":"neighborhoodData_getNeighborhoodDataSources","summary":"Get available neighborhood data sources for a listing","description":"Returns the compset sources a listing's neighborhood data can be based on, with the\nsub-options each one needs and the source currently in effect.\n\nThree sources exist:\n  * `NL` — Nearby Listings. Always available. Carries `br_range_options` (the bedroom\n    counts this listing can be compared against) and `br_range_selected`.\n  * `MD` — Market Dashboards. Available when the account has at least one Market Dashboard\n    report. Carries `md_reports`; the compsets for a report are fetched separately from\n    `GET /v1/neighborhood_data/get_md_compsets`.\n  * `CCC` — Competitor Listings. Requires the feature on the account, at least 20 competitor\n    listings, and all of them from a single booking channel.\n\nA source that is not available carries a `reason` explaining why. `selected_md_id` and\n`selected_md_compset` are only populated when the current source is `MD`.\n\nUse this endpoint to discover valid values before calling\n`POST /v1/neighborhood_data/update_source`.\n","tags":["neighborhoodData"],"parameters":[{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"pms","in":"query","required":true,"schema":{"type":"string"}},{"name":"X-API-Key","in":"header","description":"API key for Customer API authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Neighborhood_Data_getNeighborhoodDataSources_Response_200"}}}},"400":{"description":"Missing `listing_id` or `pms`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNeighborhoodDataSourcesRequestBadRequestError"}}}},"404":{"description":"Listing not found in this account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNeighborhoodDataSourcesRequestNotFoundError"}}}}}}},"/v1/neighborhood_data/get_md_compsets":{"get":{"operationId":"neighborhoodData_getMdReportCompsets","summary":"Get compsets for a Market Dashboard report","description":"Returns the compsets available on a Market Dashboard report, for use as `md_compset` when\nassigning `MD` as a listing's neighborhood data source.\n\nEach compset carries three fields, and the distinction matters:\n  * `value` — the identifier. This is the only form\n    `POST /v1/neighborhood_data/update_source` accepts as `md_compset`. Send it verbatim.\n  * `label` — display text. Not a valid `md_compset`.\n  * `group` — a heading for grouping compsets in a UI.\n\nGet `md_id` from `md_reports` in `GET /v1/neighborhood_data/fetch_sources`.\n","tags":["neighborhoodData"],"parameters":[{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"pms","in":"query","required":true,"schema":{"type":"string"}},{"name":"md_id","in":"query","description":"Market Dashboard report id, from `md_reports` in `fetch_sources`.","required":true,"schema":{"type":"integer"}},{"name":"X-API-Key","in":"header","description":"API key for Customer API authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Neighborhood_Data_getMdReportCompsets_Response_200"}}}},"400":{"description":"Missing `listing_id`, `pms` or `md_id`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMdReportCompsetsRequestBadRequestError"}}}},"404":{"description":"Listing not found in this account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMdReportCompsetsRequestNotFoundError"}}}}}}},"/v1/neighborhood_data/update_source":{"post":{"operationId":"neighborhoodData_assignNeighborhoodDataSource","summary":"Set the neighborhood data source for a listing","description":"Persistently sets which compset a listing's neighborhood data is based on. This is the same\nsetting as the compset selector on the Neighborhood Data tab, and it affects the data\nreturned by `GET /v1/neighborhood_data`.\n\nRequired fields depend on `selected_source`:\n  * `NL` — `br_selection` is required.\n  * `MD` — `md_id` and `md_compset` are both required.\n  * `CCC` — no sub-options; requires the feature on the account.\n\nSub-options are validated against the listing's own live options before anything is\npersisted, so an unknown value is rejected with a `400` that lists the valid alternatives\nrather than being silently ignored. Discover valid values with\n`GET /v1/neighborhood_data/fetch_sources` and `GET /v1/neighborhood_data/get_md_compsets`.\n\nRequires write permission on the listing. Team-member API keys without write permission\nreceive a `403`.\n","tags":["neighborhoodData"],"parameters":[{"name":"X-API-Key","in":"header","description":"API key for Customer API authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Source applied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Neighborhood_Data_assignNeighborhoodDataSource_Response_200"}}}},"400":{"description":"Missing or invalid parameters. When a sub-option is rejected, the response also carries\nthe valid alternatives — `available_br_selection`, `available_md_ids` or\n`available_compsets`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignNeighborhoodDataSourceRequestBadRequestError"}}}},"403":{"description":"Competitor Listings not enabled on the account, or no write permission on the listing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignNeighborhoodDataSourceRequestForbiddenError"}}}},"404":{"description":"Listing not found in this account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignNeighborhoodDataSourceRequestNotFoundError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"listing_id":{"type":"string","description":"Listing to update."},"pms":{"type":"string","description":"PMS name for the listing."},"selected_source":{"$ref":"#/components/schemas/V1NeighborhoodDataUpdateSourcePostRequestBodyContentApplicationJsonSchemaSelectedSource","description":"Compset source to apply. Case-insensitive."},"br_selection":{"type":"string","description":"Required when `selected_source` is `NL`. Comma-separated bedroom counts, each of\nwhich must appear in the NL source's `br_range_options`. Normalised on the way\nthrough, so `\"3, 2 ,2\"` is stored as `\"2,3\"`.\n"},"md_id":{"type":"integer","description":"Required when `selected_source` is `MD`. Must be the `report_id` of one of the\naccount's Market Dashboard reports; reports with `valid: 0` are not selectable.\n"},"md_compset":{"type":"string","description":"Required when `selected_source` is `MD`. Must be the `value` of a compset\nreturned by `get_md_compsets` for that `md_id` — not its `label`. Matched\ncase-insensitively; the canonical spelling is what gets stored.\n"}},"required":["listing_id","pms","selected_source"]}}}}}},"/v1/reservation_data":{"get":{"operationId":"reservations_getReservations","summary":"Get Reservations received from your PMS along with rental revenue information.","description":"Returns reservations in the PriceLabs account for the requested PMS. Includes reservations\nsynced from the connected PMS and reservations created or updated through\n`POST /v1/create_reservations`.\n\nThe request must include at least one of the following date filter groups:\n- `start_date` and `end_date` (both required together)\n- `booked_start_date` and/or `booked_end_date` (either one is sufficient)\n","tags":["reservations"],"parameters":[{"name":"pms","in":"query","description":"PMS to fetch reservations from. If the PMS does not provide reservations, no rows are returned.","required":true,"schema":{"type":"string"}},{"name":"start_date","in":"query","description":"Inclusive check-in filter start (`YYYY-MM-DD`). Filters reservations in `[start_date, end_date). If provided, also requires `end_date`.`.","required":false,"schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"Exclusive check-in filter end (`YYYY-MM-DD`). Filters reservations in `[start_date, end_date)`. If provided, also requires `start_date`.","required":false,"schema":{"type":"string","format":"date"}},{"name":"listing_id","in":"query","description":"Optional filter to a single listing.","required":false,"schema":{"type":"string"}},{"name":"include_hidden","in":"query","description":"When `\"false\"`, hidden listings are excluded.","required":false,"schema":{"$ref":"#/components/schemas/V1ReservationDataGetParametersIncludeHidden","default":"true"}},{"name":"booked_start_date","in":"query","description":"Optional filter on booking date (inclusive, `YYYY-MM-DD`).","required":false,"schema":{"type":"string","format":"date"}},{"name":"booked_end_date","in":"query","description":"Optional filter on booking date (inclusive day, `YYYY-MM-DD`).","required":false,"schema":{"type":"string","format":"date"}},{"name":"include","in":"query","description":"When the value contains `available`, `available` reservations are included.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Results per page (default `100`).","required":false,"schema":{"type":"integer","default":100}},{"name":"offset","in":"query","description":"Pagination offset (default `0`). Increment while `next_page` is `true`.","required":false,"schema":{"type":"integer","default":0}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success. Keep requesting pages until `next_page` is `false`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reservations_getReservations_Response_200"}}}},"400":{"description":"Invalid request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReservationsRequestBadRequestError"}}}},"401":{"description":"Invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReservationsRequestUnauthorizedError"}}}},"403":{"description":"Superadmin API keys only. Sub-user API keys receive this response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReservationsRequestForbiddenError"}}}}}}},"/v1/create_reservations":{"post":{"operationId":"reservations_createReservations","summary":"Create or update reservations","description":"Creates or updates reservations in PriceLabs for listings in your account.\n\nUse this when you need to add bookings that are not synced from a PMS — for example\ndirect bookings, offline stays, or booked times corrections. Each request accepts a `reservations`\narray of **1–100** reservation objects. The API validates and processes objects\nindependently, so one invalid reservation does not block the rest of the batch.\n\n**All 19 fields required.** Every reservation object must include all fields below (use\n`null` for inapplicable values). Extra unknown fields are rejected for that row.\n\n| Field | Type | Notes |\n|-------|------|-------|\n| `listing_id` | string | Must exist for user's account |\n| `pms_name` | string | Must be a portfolio-analytics-enabled PMS |\n| `reservation_id` | string/null | Auto-generated as `{listing_id}_{start_date}_{end_date}` if null. Has to be unique for a PMS |\n| `start_date` | string | YYYY-MM-DD |\n| `end_date` | string | YYYY-MM-DD, must be after `start_date` |\n| `no_of_days` | number/null | Auto-computed from dates if null |\n| `total_cost` | number/null | Required (>0) when `pl_status=booked` |\n| `currency` | string | e.g. USD, EUR |\n| `booked_time` | string/null | Required when `pl_status=booked`, must be ≤ `start_date` |\n| `pl_status` | string | `booked`, `cancelled`, `blocked`, or `available` |\n| `cancelled_time` | string/null | Required when `pl_status=cancelled` |\n| `total_fees` | number/null | |\n| `total_taxes` | number/null | |\n| `rental_revenue` | number/null | |\n| `ota_commission` | number/null | |\n| `host_payout` | number/null | |\n| `booking_source` | string/null | `airbnb`, `vrbo`, `bcom`, `manual`, `others` |\n| `guest_count` | number/null | |\n| `guest_zipcode` | string/null | |\n\n**Updates.** A unique reservation is identified by `reservation_id` + `pms_name`.\n- Reservations previously created or updated via this API (or CSV upload) can be updated.\n- Reservations already synced from a PMS fetch cannot be overwritten (`reservation already fetched via …`).\n- Reservation IDs must be unique for a PMS.\n\nReservations can only be added for PMS/channels that support Portfolio Analytics.\nThe listing must belong to the authenticated account. Team-member API keys need\n**write** permission on every listing in the payload.\n\nCreated reservations are available from `GET /v1/reservation_data`.\n","tags":["reservations"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"All reservations in the batch were created or updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReservationsResponse"}}}},"400":{"description":"Invalid request body (missing array, empty array, or more than 100 rows)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReservationsRequestBadRequestError"}}}},"401":{"description":"Invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReservationsRequestUnauthorizedError"}}}},"403":{"description":"Write access denied for one or more listings in the payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReservationsRequestForbiddenError"}}}},"500":{"description":"Internal error while creating reservations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReservationsRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reservations":{"type":"array","items":{"$ref":"#/components/schemas/V1CreateReservationsPostRequestBodyContentApplicationJsonSchemaReservationsItems"},"description":"Reservation rows to create or update. Maximum 100 per request."}},"required":["reservations"]}}}}}},"/v1/bookings_report":{"post":{"operationId":"bookingsReport_getBookingsReport","summary":"Get bookings report with filters and pagination","description":"Returns a paginated bookings/reservations report for the account. Supports date range filters\n(booked date or check-in date), listing-level filters, and various portfolio filters such as\ntags, groups, cities, bedroom count, and sync status.\n\nAt least one date filter group is recommended. If no date filters are provided, defaults to\nbookings from the last 90 days.\n","tags":["bookingsReport"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Bookings report data with pagination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bookings_Report_getBookingsReport_Response_200"}}}},"400":{"description":"Invalid request or validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBookingsReportRequestBadRequestError"}}}},"502":{"description":"Upstream service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBookingsReportRequestBadGatewayError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"date_filters":{"$ref":"#/components/schemas/V1BookingsReportPostRequestBodyContentApplicationJsonSchemaDateFilters","description":"Date range filters. Provide either booked date range or check-in date range (or both)."},"filters":{"$ref":"#/components/schemas/V1BookingsReportPostRequestBodyContentApplicationJsonSchemaFilters","description":"Listing and booking filters."},"limit":{"type":"integer","minimum":1,"maximum":500,"default":200,"description":"Maximum number of rows to return (1-500). Defaults to 200."},"offset":{"type":"integer","minimum":0,"default":0,"description":"Number of rows to skip for pagination. Defaults to 0."}}}}}}}},"/v1/report_builder/templates":{"get":{"operationId":"reportBuilder_getRBTemplates","summary":"Fetch available report templates","description":"Returns all Report Builder templates accessible to the authenticated user (including default/canned templates provided by PriceLabs and custom templates created by the user). The response structure varies depending on the filters and columns applied to each template.","tags":["reportBuilder"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report_Builder_getRBTemplates_Response_200"}}}}}}},"/v1/report_builder/data":{"post":{"operationId":"reportBuilder_generateReportData","summary":"Generate report data","description":"Triggers report generation using a previously saved template. Reports are processed asynchronously and require polling.","tags":["reportBuilder"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Report generated or queued for asynchronous processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report_Builder_generateReportData_Response_200"}}}},"400":{"description":"Missing template_id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateReportDataRequestBadRequestError"}}}},"404":{"description":"Template not found or access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateReportDataRequestNotFoundError"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateReportDataRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"template_id":{"type":"integer","description":"Template ID to generate data for."}},"required":["template_id"]}}}}}},"/v1/report_builder/poll":{"post":{"operationId":"reportBuilder_pollReportData","summary":"Poll report generation status","description":"Retrieves the status or generated report data for asynchronous report generation requests. Report generation sessions expire 30 minutes after creation.\n\n**Polling behavior:**\nAfter calling the report generation endpoint, poll this endpoint periodically (recommended interval: 5–10 seconds) until you receive a terminal response.\n\nStatus values returned by the downstream service are **case-sensitive**.\n\n**Continue polling when:**\n- `status: \"IN_PROGRESS\"` — The report is still being generated. Continue polling after a short delay.\n\n**Stop polling when:**\n- The response contains `data.report_data` and **no `status` field** — The report is ready. Use `data.report_data` and `data.report_currency`.\n- `status: \"STATUS_NOT_FOUND\"` — The `request_id` is invalid or expired. This can happen if the session expired (30 minutes after creation) or the report data was already retrieved.\n- HTTP `400` — The `request_id` is missing, or no active session was found for the `request_id`.\n- HTTP `403` — Your API key does not have Report Builder access.\n- HTTP `500` — An internal error occurred. You may retry a few times, but if it persists, stop polling.\n","tags":["reportBuilder"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Report status retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report_Builder_pollReportData_Response_200"}}}},"403":{"description":"Unauthorized — stop polling","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollReportDataRequestForbiddenError"}}}},"500":{"description":"Internal server error — stop polling (may retry a few times)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollReportDataRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string","description":"Request identifier returned by the report generation endpoint"}},"required":["request_id"]}}}}}},"/v1/nudges/available":{"get":{"operationId":"nudges_available","summary":"List available nudges","description":"Returns pending, non-expired nudges for listings accessible to the\nauthenticated user. Results can be filtered by nudge type,\nlisting ID, and PMS name.\n","tags":["nudges"],"parameters":[{"name":"nudge_type","in":"query","description":"Filter by nudge type. Omit to return all types.","required":false,"schema":{"$ref":"#/components/schemas/V1NudgesAvailableGetParametersNudgeType"}},{"name":"listing_id","in":"query","description":"Filter by listing ID. Requires `pms` when provided.","required":false,"schema":{"type":"string"}},{"name":"pms","in":"query","description":"Filter by PMS name. Required when `listing_id` is provided.","required":false,"schema":{"type":"string"}},{"name":"X-API-Key","in":"header","description":"API key for Customer API authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of available nudges (may be empty)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Nudges_available_Response_200"}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NudgesAvailableRequestBadRequestError"}}}}}}},"/v1/nudges/accept":{"post":{"operationId":"nudges_accept","summary":"Accept a nudge","description":"Accepts a price nudge for a single listing, updating the listing's\nprice to the nudge-recommended value and marking the nudge as\naccepted.\n\nRequires write permission on the listing. Sub-users/team-users\nwithout write permission receive a 403 response.\n\nThe endpoint verifies the nudge is still the latest pending\nrecommendation for that listing and nudge type; if a newer nudge\nexists, a 409 Conflict is returned.\n","tags":["nudges"],"parameters":[{"name":"X-API-Key","in":"header","description":"API key for Customer API authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Nudge accepted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Nudges_accept_Response_200"}}}},"400":{"description":"Invalid or missing parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NudgesAcceptRequestBadRequestError"}}}},"403":{"description":"Write access denied for the listing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NudgesAcceptRequestForbiddenError"}}}},"404":{"description":"Nudge or listing not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NudgesAcceptRequestNotFoundError"}}}},"409":{"description":"Nudge is stale — a newer recommendation exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NudgesAcceptRequestConflictError"}}}},"500":{"description":"Internal failure while persisting the acceptance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NudgesAcceptRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"nudge_id":{"type":"string","format":"uuid","description":"UUID of the nudge to accept"},"listing_id":{"type":"string","description":"Listing ID the nudge applies to"},"pms":{"type":"string","description":"PMS name for the listing"},"update_children":{"type":"boolean","default":false,"description":"When true, propagate the price change to child listings"}},"required":["nudge_id","listing_id","pms"]}}}}}},"/v1/actions":{"get":{"operationId":"actions_listActions","summary":"List actions for your listings","description":"Returns the Action Center alerts and recommendations for your listings: missing listing\ninformation, configuration issues, availability alerts, and pricing recommendations.\n\nGrouped per listing, most important first. Listings with nothing flagged are omitted,\nso the array can be empty.\n","tags":["actions"],"parameters":[{"name":"listing_id","in":"query","description":"Restrict to this listing. Must be provided together with `pms`.","required":false,"schema":{"type":"string"}},{"name":"pms","in":"query","description":"PMS name of the listing. Must be provided together with `listing_id`. Omit both to return actions for every accessible listing.","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"How the account's action visibility preferences are applied. `visible` (default) returns only actions that are not hidden, `all` ignores preferences, and `hidden` returns only the actions that have been hidden.","required":false,"schema":{"$ref":"#/components/schemas/V1ActionsGetParametersMode","default":"visible"}},{"name":"X-API-Key","in":"header","description":"API key for Customer API authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"One entry per listing that has at least one active action (may be empty)","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1ActionsGetResponsesContentApplicationJsonSchemaItems"}}}}},"400":{"description":"Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListActionsRequestBadRequestError"}}}},"404":{"description":"The requested listing does not exist or is not accessible","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListActionsRequestNotFoundError"}}}}}}},"/v1/customizations/listing":{"get":{"operationId":"customizations_getCapiListingCustomizations","summary":"Read listing-level customizations","description":"Returns the listing's OWN-level customization values (write-body-shaped). By default only\ntoggled-ON customizations are returned; pass `toggled_on=false` to also include toggled-off\nones with their full data packs. `?customizations=` filters the set.\n404 only if the listing itself is not found; a listing with no customizations set returns\n200 with an empty `customizations` map.\n","tags":["customizations"],"parameters":[{"name":"listing_id","in":"query","description":"Listing id (listing-level).","required":true,"schema":{"type":"string"}},{"name":"pms_name","in":"query","description":"PMS name (paired with listing_id).","required":true,"schema":{"type":"string"}},{"name":"customizations","in":"query","description":"Comma-separated spec keys to return; omit to return all supported.","required":false,"schema":{"type":"string"}},{"name":"toggled_on","in":"query","description":"When true (default), only customizations whose toggle is ON are returned. Pass false to also include toggled-off customizations with their full data packs.","required":false,"schema":{"type":"boolean","default":true}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Customizations retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiCustomizationsResponse"}}}},"400":{"description":"Bad request — ERR-MISSING-IDENTIFIER (required identifier(s) for the level missing),\nERR-NO-CUSTOMIZATIONS (write body empty), ERR-UNKNOWN-CUSTOMIZATION (key not in glossary),\nERR-CUSTOMIZATION-NOT-SUPPORTED (not yet supported), ERR-INVALID-CUSTOMIZATION\n(presence/shape), or ERR-VALIDATION-FAILED.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"401":{"description":"Missing/invalid X-API-KEY.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"403":{"description":"Forbidden — ERR-FEATURE-NOT-ENABLED (admin-only feature-gated field sent but\naccount lacks it); or ERR-READ-DENIED (reads) / ERR-WRITE-DENIED (writes) when a sub-user lacks the\nrelevant permission on the entity.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"404":{"description":"ERR-LISTING-NOT-FOUND / ERR-GROUP-NOT-FOUND / ERR-ACCOUNT-NOT-FOUND — entity not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}}}},"post":{"operationId":"customizations_updateCapiListingCustomizations","summary":"Create / update listing-level customizations","description":"Writes one or more customizations for the listing. `customizations` maps each spec key to its\nsettings object. All-or-nothing: if any object is invalid the whole request is rejected and\nnothing is written. Self-serve control-panel features are auto-enabled async (no wait);\nadmin-only feature-gated fields the account lacks -> `ERR-FEATURE-NOT-ENABLED` (no partial write).\n","tags":["customizations"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Customizations written (acknowledgment only).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customizations_updateCapiListingCustomizations_Response_200"}}}},"400":{"description":"Bad request — ERR-MISSING-IDENTIFIER (required identifier(s) for the level missing),\nERR-NO-CUSTOMIZATIONS (write body empty), ERR-UNKNOWN-CUSTOMIZATION (key not in glossary),\nERR-CUSTOMIZATION-NOT-SUPPORTED (not yet supported), ERR-INVALID-CUSTOMIZATION\n(presence/shape), or ERR-VALIDATION-FAILED.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"401":{"description":"Missing/invalid X-API-KEY.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"403":{"description":"Forbidden — ERR-FEATURE-NOT-ENABLED (admin-only feature-gated field sent but\naccount lacks it); or ERR-READ-DENIED (reads) / ERR-WRITE-DENIED (writes) when a sub-user lacks the\nrelevant permission on the entity.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"404":{"description":"ERR-LISTING-NOT-FOUND / ERR-GROUP-NOT-FOUND / ERR-ACCOUNT-NOT-FOUND — entity not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiListingCustomizationsWriteRequest"}}}}}},"/v1/customization_profiles":{"get":{"operationId":"customizations_getCapiCustomizationProfiles","summary":"List customization profiles (discovery)","description":"Read-only discovery endpoint for the account's customization profiles. Use it to look up\nthe exact `minstay_profile_id` / `pricing_profile_id` / `checkincheckout_profile_id`\nvalues that `custom_seasonal_profile` season writes accept, and the `oba_profile_id`\nvalues that `occupancy_based_adjustment` saved mode accepts — the ids returned here are\nexactly the set a write will validate against (same account-ownership rule).\n\nReturns all four profile types grouped by type; filter with `profile_type`, `archived`,\nor look up a single profile by exact `name` (requires `profile_type`; at most one match —\nprofile names are unique per account and type). A name with no match returns\n`404 ERR-PROFILE-NOT-FOUND`; the response is identical for nonexistent and not-owned\nnames. Entries expose only `id`, `name` and `archived` — not the profile's contents.\n","tags":["customizations"],"parameters":[{"name":"profile_type","in":"query","description":"Return only this profile type; omit for all four.","required":false,"schema":{"$ref":"#/components/schemas/V1CustomizationProfilesGetParametersProfileType"}},{"name":"archived","in":"query","description":"Filter by archived state. `false` also includes legacy profiles that never set the flag. Omit to return both archived and unarchived profiles.","required":false,"schema":{"type":"boolean"}},{"name":"name","in":"query","description":"Exact-match name lookup. Requires `profile_type`. Returns at most one profile; no match returns 404 ERR-PROFILE-NOT-FOUND.","required":false,"schema":{"type":"string"}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Profiles retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiCustomizationProfilesResponse"}}}},"400":{"description":"Bad request — ERR-INVALID-PROFILE-TYPE (`profile_type` not one of minstay / pricing /\ncheckincheckout / oba), ERR-INVALID-ARCHIVED (`archived` not true/false), or\nERR-MISSING-PROFILE-TYPE (`name` passed without `profile_type`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"401":{"description":"Missing/invalid X-API-KEY.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"404":{"description":"ERR-PROFILE-NOT-FOUND — no profile of the given type with that name on the account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}}}}},"/v1/customizations/group":{"get":{"operationId":"customizations_getCapiGroupCustomizations","summary":"Read group-level customizations","description":"Returns the group's OWN-level customization values (write-body-shaped). By default only\ntoggled-ON customizations are returned; pass `toggled_on=false` to also include toggled-off\nones. `?customizations=` filters. 404 only if the group itself is not found.\n","tags":["customizations"],"parameters":[{"name":"group_id","in":"query","description":"Group id.","required":true,"schema":{"type":"integer"}},{"name":"customizations","in":"query","description":"Comma-separated spec keys to return; omit to return all supported.","required":false,"schema":{"type":"string"}},{"name":"toggled_on","in":"query","description":"When true (default), only customizations whose toggle is ON are returned. Pass false to also include toggled-off customizations with their full data packs.","required":false,"schema":{"type":"boolean","default":true}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Customizations retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiCustomizationsResponse"}}}},"400":{"description":"Bad request — ERR-MISSING-IDENTIFIER (required identifier(s) for the level missing),\nERR-NO-CUSTOMIZATIONS (write body empty), ERR-UNKNOWN-CUSTOMIZATION (key not in glossary),\nERR-CUSTOMIZATION-NOT-SUPPORTED (not yet supported), ERR-INVALID-CUSTOMIZATION\n(presence/shape), or ERR-VALIDATION-FAILED.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"401":{"description":"Missing/invalid X-API-KEY.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"403":{"description":"Forbidden — ERR-FEATURE-NOT-ENABLED (admin-only feature-gated field sent but\naccount lacks it); or ERR-READ-DENIED (reads) / ERR-WRITE-DENIED (writes) when a sub-user lacks the\nrelevant permission on the entity.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"404":{"description":"ERR-LISTING-NOT-FOUND / ERR-GROUP-NOT-FOUND / ERR-ACCOUNT-NOT-FOUND — entity not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}}}},"post":{"operationId":"customizations_updateCapiGroupCustomizations","summary":"Create / update group-level customizations","tags":["customizations"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Customizations written (acknowledgment only).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customizations_updateCapiGroupCustomizations_Response_200"}}}},"400":{"description":"Bad request — ERR-MISSING-IDENTIFIER (required identifier(s) for the level missing),\nERR-NO-CUSTOMIZATIONS (write body empty), ERR-UNKNOWN-CUSTOMIZATION (key not in glossary),\nERR-CUSTOMIZATION-NOT-SUPPORTED (not yet supported), ERR-INVALID-CUSTOMIZATION\n(presence/shape), or ERR-VALIDATION-FAILED.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"401":{"description":"Missing/invalid X-API-KEY.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"403":{"description":"Forbidden — ERR-FEATURE-NOT-ENABLED (admin-only feature-gated field sent but\naccount lacks it); or ERR-READ-DENIED (reads) / ERR-WRITE-DENIED (writes) when a sub-user lacks the\nrelevant permission on the entity.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"404":{"description":"ERR-LISTING-NOT-FOUND / ERR-GROUP-NOT-FOUND / ERR-ACCOUNT-NOT-FOUND — entity not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiGroupCustomizationsWriteRequest"}}}}}},"/v1/customizations/account":{"get":{"operationId":"customizations_getCapiAccountCustomizations","summary":"Read account-level (pms) customizations","description":"Returns the account/pms's OWN-level customization values (write-body-shaped). By default\nonly toggled-ON customizations are returned; pass `toggled_on=false` to also include\ntoggled-off ones. `?customizations=` filters. 404 only if the account/pms itself is not\nfound; an account with no customizations set returns 200 with an empty `customizations` map.\n","tags":["customizations"],"parameters":[{"name":"pms_name","in":"query","description":"PMS name (account-level).","required":true,"schema":{"type":"string"}},{"name":"customizations","in":"query","description":"Comma-separated spec keys to return; omit to return all supported.","required":false,"schema":{"type":"string"}},{"name":"toggled_on","in":"query","description":"When true (default), only customizations whose toggle is ON are returned. Pass false to also include toggled-off customizations with their full data packs.","required":false,"schema":{"type":"boolean","default":true}},{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Customizations retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiCustomizationsResponse"}}}},"400":{"description":"Bad request — ERR-MISSING-IDENTIFIER (required identifier(s) for the level missing),\nERR-NO-CUSTOMIZATIONS (write body empty), ERR-UNKNOWN-CUSTOMIZATION (key not in glossary),\nERR-CUSTOMIZATION-NOT-SUPPORTED (not yet supported), ERR-INVALID-CUSTOMIZATION\n(presence/shape), or ERR-VALIDATION-FAILED.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"401":{"description":"Missing/invalid X-API-KEY.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"403":{"description":"Forbidden — ERR-FEATURE-NOT-ENABLED (admin-only feature-gated field sent but\naccount lacks it); or ERR-READ-DENIED (reads) / ERR-WRITE-DENIED (writes) when a sub-user lacks the\nrelevant permission on the entity.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"404":{"description":"ERR-LISTING-NOT-FOUND / ERR-GROUP-NOT-FOUND / ERR-ACCOUNT-NOT-FOUND — entity not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}}}},"post":{"operationId":"customizations_updateCapiAccountCustomizations","summary":"Create / update account-level (pms) customizations","tags":["customizations"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Customizations written (acknowledgment only).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customizations_updateCapiAccountCustomizations_Response_200"}}}},"400":{"description":"Bad request — ERR-MISSING-IDENTIFIER (required identifier(s) for the level missing),\nERR-NO-CUSTOMIZATIONS (write body empty), ERR-UNKNOWN-CUSTOMIZATION (key not in glossary),\nERR-CUSTOMIZATION-NOT-SUPPORTED (not yet supported), ERR-INVALID-CUSTOMIZATION\n(presence/shape), or ERR-VALIDATION-FAILED.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"401":{"description":"Missing/invalid X-API-KEY.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"403":{"description":"Forbidden — ERR-FEATURE-NOT-ENABLED (admin-only feature-gated field sent but\naccount lacks it); or ERR-READ-DENIED (reads) / ERR-WRITE-DENIED (writes) when a sub-user lacks the\nrelevant permission on the entity.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}},"404":{"description":"ERR-LISTING-NOT-FOUND / ERR-GROUP-NOT-FOUND / ERR-ACCOUNT-NOT-FOUND — entity not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapiAccountCustomizationsWriteRequest"}}}}}},"/v1/listing_optimizer/summary":{"get":{"operationId":"listingOptimizer_getListingOptimizerSummary","summary":"Get Listing Optimizer summary","description":"Returns Listing Optimizer scores for all active Airbnb listings in the account. Each entry includes the overall score, status, and basic listing info. If the account does not have an optimizer report, `has_optimizer_report` will be `false` and `listings` will be empty.\n\nUse this endpoint first to get a portfolio-wide overview, then call `/v1/listing_optimizer/report` for a detailed breakdown of individual listings.\n\nSupports optional `subscribed`, `status`, and `listing_ids` query parameters to filter the returned listings.\n","tags":["listingOptimizer"],"parameters":[{"name":"subscribed","in":"query","description":"Filter to listings with (`true`) or without (`false`) an active PriceLabs subscription.","required":false,"schema":{"type":"boolean"}},{"name":"status","in":"query","description":"Filter to listings with this optimizer status. One of `pending`, `processing`, `completed`, `error`, `delisted`, `archived`, `deleted`.","required":false,"schema":{"$ref":"#/components/schemas/V1ListingOptimizerSummaryGetParametersStatus"}},{"name":"listing_ids","in":"query","description":"Filter to specific listing IDs. Pass as repeated bracketed params, e.g. `listing_ids[]=1&listing_ids[]=2`.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"X-API-Key","in":"header","description":"API key for Customer API authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Listing Optimizer summary retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listing_Optimizer_getListingOptimizerSummary_Response_200"}}}},"401":{"description":"Unauthorized — invalid or missing API key.","content":{"application/json":{"schema":{"description":"Any type"}}}}}}},"/v1/listing_optimizer/report":{"get":{"operationId":"listingOptimizer_getListingOptimizerReport","summary":"Get Listing Optimizer report for a listing","description":"Returns full Listing Optimizer details for a single Airbnb listing: category letter grades, score breakdowns, improvement tips, and previous-run grades for comparison.\n\nRequires `listing_id` as a query parameter. Optionally accepts `pms_name` as a query parameter (defaults to `airbnb`). If the account has not paid for Optimizer access for this listing, `payment_restricted: true` is returned and score data is omitted.\n","tags":["listingOptimizer"],"parameters":[{"name":"listing_id","in":"query","description":"Listing ID of the Airbnb listing.","required":true,"schema":{"type":"string"}},{"name":"pms_name","in":"query","description":"PMS name. Defaults to `airbnb`.","required":false,"schema":{"type":"string"}},{"name":"X-API-Key","in":"header","description":"API key for Customer API authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Listing Optimizer report retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listing_Optimizer_getListingOptimizerReport_Response_200"}}}},"400":{"description":"Bad request — `listing_id` is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetListingOptimizerReportRequestBadRequestError"}}}},"401":{"description":"Unauthorized — invalid or missing API key.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Listing not found, or Listing Optimizer not available for this account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetListingOptimizerReportRequestNotFoundError"}}}},"422":{"description":"Optimizer report data could not be loaded for this listing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetListingOptimizerReportRequestUnprocessableEntityError"}}}}}}},"/v1/listing_optimizer/ranking":{"get":{"operationId":"listingOptimizer_getListingOptimizerRanking","summary":"Get Listing Optimizer ranking for a listing","description":"Returns competitive ranking data for a single Airbnb listing: current search-result rankings by guest count and length-of-stay segments, the number of competing listings in the neighborhood, and up to 90 days of ranking history.\n\nRequires `listing_id` as a query parameter. `pms_name`, `guest_count`, `los`, and `history_start_date` remain optional query parameters.\n\nUse `guest_count` and `los` to narrow results to a specific segment. Use `history_start_date` to control how far back the ranking history goes (defaults to 90 days ago; cannot be set earlier than 90 days ago).\n","tags":["listingOptimizer"],"parameters":[{"name":"listing_id","in":"query","description":"Listing ID of the Airbnb listing.","required":true,"schema":{"type":"string"}},{"name":"pms_name","in":"query","description":"PMS name. Defaults to `airbnb`.","required":false,"schema":{"type":"string"}},{"name":"guest_count","in":"query","description":"Filter ranking segments to this guest count only.","required":false,"schema":{"type":"integer"}},{"name":"los","in":"query","description":"Filter ranking segments to this length of stay only.","required":false,"schema":{"type":"string"}},{"name":"history_start_date","in":"query","description":"Start date for ranking history (YYYY-MM-DD). Cannot be earlier than 90 days ago. Defaults to 90 days ago.","required":false,"schema":{"type":"string","format":"date"}},{"name":"X-API-Key","in":"header","description":"API key for Customer API authentication.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Listing Optimizer ranking retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listing_Optimizer_getListingOptimizerRanking_Response_200"}}}},"400":{"description":"Bad request — `listing_id` is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetListingOptimizerRankingRequestBadRequestError"}}}},"401":{"description":"Unauthorized — invalid or missing API key.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Listing not found, or Listing Optimizer not available for this account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetListingOptimizerRankingRequestNotFoundError"}}}}}}},"/v1/logs":{"post":{"operationId":"logs_getLogs","summary":"Retrieve activity logs","description":"Fetches paginated activity logs for the authenticated user. Supports\nfiltering by log type, entity identifiers, actions, team members, and date range.\n","tags":["logs"],"parameters":[{"name":"X-API-Key","in":"header","description":"PriceLabs Customer API key (found in Account Settings > API Details).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsResponse"}}}},"400":{"description":"Bad request. Returned when a required field is missing or a filter value is invalid.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsError"}}}},"401":{"description":"Invalid or missing API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsError"}}}},"403":{"description":"Forbidden. Returned when the API key is valid but access to logs is not allowed.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsError"}}}},"503":{"description":"Service unavailable. Upstream log service is temporarily unreachable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsRequest"}}}}}},"/v1/add_listing_data":{"post":{"operationId":"pmsSpecific_addNewListingsFromPMS","summary":"Import newly added listings from PMS","description":"Use this API call to pull new listings that you have added in your PMS. Make sure the `listing_id` in the body is for an existing listing that was previously added to your PriceLabs account.\n\n> **Note:** This API call works only for `bookingsync` and `redawning` PMS.","tags":["pmsSpecific"],"parameters":[{"name":"X-API-Key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PMS_Specific_addNewListingsFromPMS_Response_200"}}}},"400":{"description":"Bad request (missing params, listing not found, unsupported PMS, etc.)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddNewListingsFromPMSRequestBadRequestError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"listing_id":{"type":"string","description":"Listing ID of an existing listing in your PriceLabs account"},"pms_name":{"type":"string","description":"PMS name of the listing"}},"required":["listing_id","pms_name"]}}}}}}},"tags":[{"name":"listings"},{"name":"mappings"},{"name":"groups"},{"name":"dateSpecificOverridesDso"},{"name":"prices"},{"name":"neighborhoodData"},{"name":"reservations"},{"name":"bookingsReport"},{"name":"reportBuilder"},{"name":"nudges"},{"name":"actions"},{"name":"customizations"},{"name":"listingOptimizer"},{"name":"logs"},{"name":"pmsSpecific"}],"servers":[{"url":"https://api.pricelabs.co","description":"https://api.pricelabs.co"}],"components":{"schemas":{"V1ListingsGetResponsesContentApplicationJsonSchemaListingsItemsChannelListingDetailsItems":{"type":"object","properties":{"channel_name":{"type":"string","description":"Name of the OTA/channel (e.g., airbnb, bookingcom, vrbo, expedia)"},"channel_listing_id":{"type":"string","description":"Listing ID on the respective channel"}},"title":"V1ListingsGetResponsesContentApplicationJsonSchemaListingsItemsChannelListingDetailsItems"},"V1ListingsGetResponsesContentApplicationJsonSchemaListingsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique listing ID"},"pms":{"type":"string","description":"PMS that this listing belongs to."},"name":{"type":"string","description":"Name of the listing"},"latitude":{"type":"string"},"longitude":{"type":"string"},"country":{"type":"string"},"city_name":{"type":"string"},"state":{"type":"string"},"currency":{"type":["string","null"],"description":"Current pricing currency for the listing."},"no_of_bedrooms":{"type":"number","format":"double","description":"Number of bedrooms in the listing. For Studio/Hotel room, it will be 0. If null, then bedroom count is not provided by the PMS via API. In such cases, bedroom count must be updated via PriceLabs account."},"cleaning_fees":{"type":"number","format":"double","description":"Cleaning fee for the listing"},"channel_listing_details":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsGetResponsesContentApplicationJsonSchemaListingsItemsChannelListingDetailsItems"},"description":"List of channel-specific listing identifiers"},"min":{"type":"number","format":"double","description":"minimum price for the listing"},"base":{"type":"number","format":"double","description":"base price for the listing"},"max":{"type":"number","format":"double","description":"maximum price for the listing"},"group":{"type":"string","description":"Listing Group"},"group_id":{"type":"integer","description":"Numeric ID of the listing group"},"subgroup":{"type":"string","description":"Listing Sub group"},"subgroup_id":{"type":"integer","description":"Numeric ID of the listing subgroup"},"tags":{"type":"string","description":"PriceLabs tags for the listing"},"notes":{"type":"string","description":"Notes added for the listing"},"isHidden":{"type":"boolean","description":"If the listing is hidden or not on the PriceLabs Pricing dashboard"},"push_enabled":{"type":"boolean","description":"If Sync is turned ON for the listing or not"},"last_date_pushed":{"type":"string","description":"Last synced time"},"last_refreshed_at":{"type":"string","description":"Last time the prices were refreshed"}},"title":"V1ListingsGetResponsesContentApplicationJsonSchemaListingsItems"},"Listings_allListings_Response_200":{"type":"object","properties":{"listings":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsGetResponsesContentApplicationJsonSchemaListingsItems"}}},"title":"Listings_allListings_Response_200"},"V1ListingsPostRequestBodyContentApplicationJsonSchemaListingsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique listing ID"},"pms":{"type":"string","description":"PMS that this listing belongs to."},"base":{"type":"number","format":"double","description":"Base price for the listing"},"min":{"type":"number","format":"double","description":"Minimum price for the listing"},"max":{"type":"number","format":"double","description":"Maximum price for the listing"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags for the listing. Maximum of 10 tags per listing."},"push_enabled":{"type":"string","description":"Toggle price sync ON (\"true\") or OFF (\"false\") for the listing. Must be passed as a string, not a boolean."},"group_id":{"type":"integer","description":"Numeric ID of the Group. `-1` removes the listing from its group. A listing with a subgroup cannot drop its group, so send `-1` for both to clear them."},"subgroup_id":{"type":"integer","description":"Numeric ID of the Subgroup. `-1` removes the listing from its subgroup."}},"required":["id","pms"],"title":"V1ListingsPostRequestBodyContentApplicationJsonSchemaListingsItems"},"V1ListingsPostResponsesContentApplicationJsonSchemaListingsItems":{"type":"object","properties":{"base":{"type":"number","format":"double","description":"Base price for the listing"},"id":{"type":"string","description":"Unique listing ID"},"max":{"type":"number","format":"double","description":"Maximum price for the listing"},"min":{"type":"number","format":"double","description":"Minimum price for the listing"},"push_enabled":{"type":"boolean","description":"Current sync status after update"},"group_id":{"type":"integer","description":"Numeric ID of the Group"},"subgroup_id":{"type":"integer","description":"Numeric ID of the Subgroup"},"errors":{"type":"array","items":{"type":"string"},"description":"Present when tag or sync or group/subgroup updates failed for this listing"}},"title":"V1ListingsPostResponsesContentApplicationJsonSchemaListingsItems"},"Listings_updateListings_Response_200":{"type":"object","properties":{"listings":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsPostResponsesContentApplicationJsonSchemaListingsItems"},"description":"Updated listings with their new pricing values"}},"title":"Listings_updateListings_Response_200"},"UpdateListingsRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"},"desc":{"type":"string"}},"title":"UpdateListingsRequestBadRequestError"},"V1ListingsMinimalGetResponsesContentApplicationJsonSchemaListingsItemsChannelListingDetailsItems":{"type":"object","properties":{"channel_name":{"type":"string","description":"Name of the OTA/channel (e.g., airbnb, bookingcom, vrbo, expedia)"},"channel_listing_id":{"type":"string","description":"Listing ID on the respective channel"}},"title":"V1ListingsMinimalGetResponsesContentApplicationJsonSchemaListingsItemsChannelListingDetailsItems"},"V1ListingsMinimalGetResponsesContentApplicationJsonSchemaListingsItems":{"type":"object","properties":{"listing_id":{"type":"string","description":"Unique listing ID"},"pms_name":{"type":"string","description":"PMS that this listing belongs to"},"listing_name":{"type":"string","description":"Name of the listing"},"property_name":{"type":"string","description":"Name of the property the listing belongs to"},"parent_key":{"type":"integer","description":"Parent listing key for multi-unit / linked listings"},"group_id":{"type":["integer","null"],"description":"ID of the group the listing is assigned to (null if unassigned)"},"push_enabled":{"type":"boolean","description":"If Sync is turned ON for the listing or not"},"channel_listing_details":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsMinimalGetResponsesContentApplicationJsonSchemaListingsItemsChannelListingDetailsItems"},"description":"The listing's IDs on each booking channel/OTA it is published on. Empty array when no channel IDs are known."}},"title":"V1ListingsMinimalGetResponsesContentApplicationJsonSchemaListingsItems"},"Listings_minimalListings_Response_200":{"type":"object","properties":{"listings":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsMinimalGetResponsesContentApplicationJsonSchemaListingsItems"}},"total_listings":{"type":"integer","description":"Total number of listings returned"}},"title":"Listings_minimalListings_Response_200"},"V1ListingsMinimalGetResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"title":"V1ListingsMinimalGetResponsesContentApplicationJsonSchemaError"},"MinimalListingsRequestForbiddenError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/V1ListingsMinimalGetResponsesContentApplicationJsonSchemaError"}},"title":"MinimalListingsRequestForbiddenError"},"V1ListingsListingIdGetResponsesContentApplicationJsonSchemaListingsItemsChannelListingDetailsItems":{"type":"object","properties":{"channel_name":{"type":"string","description":"Name of the OTA/channel (e.g., airbnb, bookingcom, vrbo, expedia)"},"channel_listing_id":{"type":"string","description":"Listing ID on the respective channel"}},"title":"V1ListingsListingIdGetResponsesContentApplicationJsonSchemaListingsItemsChannelListingDetailsItems"},"V1ListingsListingIdGetResponsesContentApplicationJsonSchemaListingsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique listing ID"},"pms":{"type":"string","description":"PMS that this listing belongs to."},"name":{"type":"string","description":"Name of the listing"},"latitude":{"type":"string"},"longitude":{"type":"string"},"country":{"type":"string"},"city_name":{"type":"string"},"state":{"type":"string"},"currency":{"type":["string","null"],"description":"Current pricing currency for the listing."},"no_of_bedrooms":{"type":"number","format":"double","description":"Number of bedrooms in the listing. For Studio/Hotel room, it will be 0. If null, then bedroom count is not provided by the PMS via API. In such cases, bedroom count must be updated via PriceLabs account."},"cleaning_fees":{"type":"number","format":"double","description":"Cleaning fee for the listing"},"min":{"type":"number","format":"double","description":"minimum price for the listing"},"base":{"type":"number","format":"double","description":"base price for the listing"},"max":{"type":"number","format":"double","description":"maximum price for the listing"},"group":{"type":"string","description":"Listing Group"},"group_id":{"type":"integer","description":"Numeric ID of the listing group"},"subgroup":{"type":"string","description":"Listing Sub group"},"subgroup_id":{"type":"integer","description":"Numeric ID of the listing subgroup"},"tags":{"type":"string","description":"Tags for the listing"},"notes":{"type":"string","description":"Notes added for the listing"},"isHidden":{"type":"boolean","description":"If the listing is hidden or not on the PriceLabs Pricing dashboard"},"push_enabled":{"type":"boolean","description":"If Sync is turned ON for the listing or not"},"last_date_pushed":{"type":"string","description":"Last synced time"},"last_refreshed_at":{"type":"string","description":"Last time the prices were refreshed"},"channel_listing_details":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsListingIdGetResponsesContentApplicationJsonSchemaListingsItemsChannelListingDetailsItems"},"description":"List of channel-specific listing identifiers"}},"title":"V1ListingsListingIdGetResponsesContentApplicationJsonSchemaListingsItems"},"Listings_singleListing_Response_200":{"type":"object","properties":{"listings":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsListingIdGetResponsesContentApplicationJsonSchemaListingsItems"}}},"title":"Listings_singleListing_Response_200"},"V1ListingMetricsGetResponsesContentApplicationJsonSchemaDataListingLevel":{"type":"object","properties":{"occupancy":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Occupancy percentage per DFD window."},"revenue":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Revenue per DFD window."},"adr":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Average Daily Rate per DFD window."},"revpar":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Revenue Per Available Room per DFD window."},"adjusted_occupancy":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Adjusted occupancy percentage per DFD window."},"min_prices":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Percentage of days at minimum price per future DFD window (keys 7, 15, 21, 30, 45, 60, 90)."},"bp_ratio":{"type":"number","format":"double","description":"Base price ratio. > 1 means above recommendation, < 1 means below."},"last_booked_date":{"type":["string","null"],"description":"ISO date of the last booking. Null if no bookings."},"stly_occupancy":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Same-time-last-year occupancy per DFD window."},"stly_revenue":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Same-time-last-year revenue per DFD window."},"stly_adr":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Same-time-last-year ADR per DFD window."},"stly_revpar":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Same-time-last-year RevPAR per DFD window."},"stly_adjusted_occupancy":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Same-time-last-year adjusted occupancy per DFD window."},"weekend_total_occupancy":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Total occupancy (blocks counted as bookings) for weekend nights only, per DFD window. Weekend nights follow the listing's weekend definition."},"weekday_total_occupancy":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Total occupancy (blocks counted as bookings) for weekday nights only, per DFD window."},"weekend_adjusted_occupancy":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Adjusted occupancy (blocks not counted as bookings) for weekend nights only, per DFD window. Weekend nights follow the listing's weekend definition."},"weekday_adjusted_occupancy":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Adjusted occupancy (blocks not counted as bookings) for weekday nights only, per DFD window."},"booking_pickup":{"type":"object","additionalProperties":{"type":"integer"},"description":"Nights Booked: number of nights booked in the past N days. Keys: `-998, -997, -60, -45, -30, -21, -15, -7, -3`."},"booking_pickup_unique":{"type":"object","additionalProperties":{"type":"integer"},"description":"Bookings Pickup: number of unique bookings made in the past N days. Same keys as `booking_pickup`."},"stly_booking_pickup":{"type":"object","additionalProperties":{"type":"integer"},"description":"Same-time-last-year `booking_pickup`."},"stly_booking_pickup_unique":{"type":"object","additionalProperties":{"type":"integer"},"description":"Same-time-last-year `booking_pickup_unique`."},"total_booked":{"type":"object","additionalProperties":{"type":"integer"},"description":"Number of booked nights in the next N days. Keys: `7, 15, 30, 60`."},"total_blocked":{"type":"object","additionalProperties":{"type":"integer"},"description":"Number of blocked nights in the next N days. Keys: `7, 15, 30, 60`."},"total_available":{"type":"object","additionalProperties":{"type":"integer"},"description":"Total number of nights in the next N days, before removing blocked nights. Keys: `7, 15, 30, 60`."},"stly_total_booked":{"type":"object","additionalProperties":{"type":"integer"},"description":"Same-time-last-year `total_booked`."},"stly_total_blocked":{"type":"object","additionalProperties":{"type":"integer"},"description":"Same-time-last-year `total_blocked`."},"stly_total_available":{"type":"object","additionalProperties":{"type":"integer"},"description":"Same-time-last-year `total_available`."},"goal_completion_occupancy":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Percentage of the listing's occupancy goal achieved for the period. Keys: `-999, -997, -995, 995, 998`. Only populated when goals are set for the listing."},"goal_completion_revenue":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Percentage of the listing's total revenue goal achieved for the period. Same keys as `goal_completion_occupancy`."},"goal_completion_rental_revenue":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Percentage of the listing's rental revenue goal achieved for the period. Same keys as `goal_completion_occupancy`."},"goal_completion_adr":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Percentage of the listing's ADR goal achieved for the period. Same keys as `goal_completion_occupancy`."},"goal_completion_revpar":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Percentage of the listing's RevPAR goal achieved for the period. Same keys as `goal_completion_occupancy`."},"currency":{"type":["string","null"],"description":"Currency used for monetary listing-level metrics, sourced from the stored listing metric set."}},"description":"Raw numerical listing-level metric data. DFD-based metrics have nested objects keyed by DFD string. Non-DFD metrics are scalar values. STLY comparisons are stored as `stly_<metric_name>` keys.","title":"V1ListingMetricsGetResponsesContentApplicationJsonSchemaDataListingLevel"},"V1ListingMetricsGetResponsesContentApplicationJsonSchemaDataMarketLevel":{"type":"object","properties":{"occupancy":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Market occupancy percentage per DFD window."},"adjusted_occupancy":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Market adjusted occupancy per DFD window."},"adr":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Market ADR per DFD window."},"currency":{"type":["string","null"],"description":"Currency used for monetary market-level metrics, sourced from the stored market metric set."}},"description":"Raw numerical market comparison data. Only includes metrics with market comparison (occupancy, adjusted_occupancy, adr).","title":"V1ListingMetricsGetResponsesContentApplicationJsonSchemaDataMarketLevel"},"V1ListingMetricsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"listing_level":{"$ref":"#/components/schemas/V1ListingMetricsGetResponsesContentApplicationJsonSchemaDataListingLevel","description":"Raw numerical listing-level metric data. DFD-based metrics have nested objects keyed by DFD string. Non-DFD metrics are scalar values. STLY comparisons are stored as `stly_<metric_name>` keys."},"market_level":{"$ref":"#/components/schemas/V1ListingMetricsGetResponsesContentApplicationJsonSchemaDataMarketLevel","description":"Raw numerical market comparison data. Only includes metrics with market comparison (occupancy, adjusted_occupancy, adr)."}},"required":["listing_level","market_level"],"title":"V1ListingMetricsGetResponsesContentApplicationJsonSchemaData"},"Listings_getListingPerformanceMetrics_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/V1ListingMetricsGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Listings_getListingPerformanceMetrics_Response_200"},"GetListingPerformanceMetricsRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}},"title":"GetListingPerformanceMetricsRequestBadRequestError"},"GetListingPerformanceMetricsRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}},"title":"GetListingPerformanceMetricsRequestNotFoundError"},"GetListingPerformanceMetricsRequestUnprocessableEntityError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}},"title":"GetListingPerformanceMetricsRequestUnprocessableEntityError"},"V1MappingsMapPostRequestBodyContentApplicationJsonSchemaParent":{"type":"object","properties":{"listing_id":{"type":"string"},"pms_name":{"type":"string"}},"required":["listing_id","pms_name"],"description":"The listing that will be the parent. Must not itself be mapped as a child.","title":"V1MappingsMapPostRequestBodyContentApplicationJsonSchemaParent"},"V1MappingsMapPostRequestBodyContentApplicationJsonSchemaChildrenItems":{"type":"object","properties":{"listing_id":{"type":"string"},"pms_name":{"type":"string"}},"required":["listing_id","pms_name"],"title":"V1MappingsMapPostRequestBodyContentApplicationJsonSchemaChildrenItems"},"V1MappingsMapPostRequestBodyContentApplicationJsonSchemaCopy":{"type":"object","properties":{"min_max_base":{"type":"boolean","default":false,"description":"Copy the parent's min/base/max prices to each child."},"customization":{"type":"boolean","default":false,"description":"Copy the parent's pricing customizations to each child. Also deletes each child's future date-specific overrides and replaces them with the parent's."},"group":{"type":"boolean","default":false,"description":"Copy the parent's group/subgroup assignment."},"notes":{"type":"boolean","default":false,"description":"Copy the parent's notes and note reminders."},"tags":{"type":"boolean","default":false,"description":"Copy the parent's tags."}},"description":"What to copy from the parent to each child at map time. All default false.","title":"V1MappingsMapPostRequestBodyContentApplicationJsonSchemaCopy"},"Mappings_mapListings_Response_200":{"type":"object","properties":{"status":{"type":"integer"},"success":{"type":"string"}},"title":"Mappings_mapListings_Response_200"},"MapListingsRequestBadRequestError":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}},"title":"MapListingsRequestBadRequestError"},"MapListingsRequestForbiddenError":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"},"listings":{"type":"array","items":{"type":"string"},"description":"Names of the listings the caller lacks write permission on (when applicable)"}},"title":"MapListingsRequestForbiddenError"},"V1MappingsUnmapPostRequestBodyContentApplicationJsonSchemaListingsItems":{"type":"object","properties":{"listing_id":{"type":"string"},"pms_name":{"type":"string"}},"required":["listing_id","pms_name"],"title":"V1MappingsUnmapPostRequestBodyContentApplicationJsonSchemaListingsItems"},"V1MappingsUnmapPostResponsesContentApplicationJsonSchemaSuccessItems":{"type":"object","properties":{"listing_id":{"type":"string"},"pms_name":{"type":"string"},"unique_id":{"type":"string"},"listing_name":{"type":"string"}},"title":"V1MappingsUnmapPostResponsesContentApplicationJsonSchemaSuccessItems"},"V1MappingsUnmapPostResponsesContentApplicationJsonSchemaFailureItems":{"type":"object","properties":{"listing_id":{"type":"string"},"listing_name":{"type":"string"},"type":{"type":"string","description":"Failure type, e.g. not_available (unknown or not mapped) or no_access (no write permission)"},"message":{"type":"string"}},"title":"V1MappingsUnmapPostResponsesContentApplicationJsonSchemaFailureItems"},"Mappings_unmapListings_Response_200":{"type":"object","properties":{"success":{"type":"array","items":{"$ref":"#/components/schemas/V1MappingsUnmapPostResponsesContentApplicationJsonSchemaSuccessItems"},"description":"Listings that were unmapped"},"failure":{"type":"array","items":{"$ref":"#/components/schemas/V1MappingsUnmapPostResponsesContentApplicationJsonSchemaFailureItems"},"description":"Listings that could not be unmapped"}},"title":"Mappings_unmapListings_Response_200"},"UnmapListingsRequestBadRequestError":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}},"title":"UnmapListingsRequestBadRequestError"},"UnmapListingsRequestForbiddenError":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}},"title":"UnmapListingsRequestForbiddenError"},"V1GroupsGetResponsesContentApplicationJsonSchemaGroupsItems":{"type":"object","properties":{"id":{"type":"integer","description":"Numeric ID of the group"},"name":{"type":"string","description":"Name of the group"},"has_listings":{"type":"boolean","description":"Whether this group has listings assigned to it"}},"title":"V1GroupsGetResponsesContentApplicationJsonSchemaGroupsItems"},"Groups_getAccountGroups_Response_200":{"type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/V1GroupsGetResponsesContentApplicationJsonSchemaGroupsItems"}}},"title":"Groups_getAccountGroups_Response_200"},"Groups_createGroup_Response_200":{"type":"object","properties":{"id":{"type":"integer","description":"Numeric ID of the new group"}},"title":"Groups_createGroup_Response_200"},"CreateGroupRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"},"desc":{"type":"string"}},"title":"CreateGroupRequestBadRequestError"},"V1GroupListingsGetResponsesContentApplicationJsonSchemaListingsItems":{"type":"object","properties":{"listing_id":{"type":"string","description":"Unique listing ID"},"listing_name":{"type":"string","description":"Name of the listing"},"pms":{"type":"string","description":"PMS that this listing belongs to"}},"title":"V1GroupListingsGetResponsesContentApplicationJsonSchemaListingsItems"},"V1GroupListingsGetResponsesContentApplicationJsonSchemaPagination":{"type":"object","properties":{"page_number":{"type":"integer"},"page_size":{"type":"integer"},"total_records":{"type":"integer"},"total_pages":{"type":"integer"}},"title":"V1GroupListingsGetResponsesContentApplicationJsonSchemaPagination"},"Groups_getGroupListings_Response_200":{"type":"object","properties":{"group_id":{"type":["integer","null"],"description":"Group ID used to filter listings"},"subgroup_id":{"type":["integer","null"],"description":"Subgroup ID used to filter listings"},"listings":{"type":"array","items":{"$ref":"#/components/schemas/V1GroupListingsGetResponsesContentApplicationJsonSchemaListingsItems"}},"pagination":{"$ref":"#/components/schemas/V1GroupListingsGetResponsesContentApplicationJsonSchemaPagination"},"message":{"type":"string","description":"Present when no listings are found"}},"title":"Groups_getGroupListings_Response_200"},"GetGroupListingsRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetGroupListingsRequestBadRequestError"},"V1ListingsListingIdOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsPriceType":{"type":"string","enum":["percent","fixed","percent_stacked"],"description":"Can be a fixed amount or a percentage applied on the recommended price. `percent_stacked` stacks on top of other percentage adjustments.","title":"V1ListingsListingIdOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsPriceType"},"V1ListingsListingIdOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsMinPriceType":{"type":"string","enum":["fixed","percent_base","percent_min"],"description":"Can be set as a fixed amount OR a percentage change on the minimum price or a percentage change on the base price","title":"V1ListingsListingIdOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsMinPriceType"},"V1ListingsListingIdOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsMaxPriceType":{"type":"string","enum":["fixed","percent_base","percent_max"],"description":"Can be set as a fixed amount OR a percentage change on the maximum price or a percentage change on the  base price","title":"V1ListingsListingIdOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsMaxPriceType"},"V1ListingsListingIdOverridesGetResponsesContentApplicationJsonSchemaOverridesItems":{"type":"object","properties":{"date":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"price":{"type":"string","description":"If price_type is fixed, then price represents the fixed price. If price_type is percent or percent_stacked, then price is the percentage change on the recommended price and should have a value ranging from -75 to 1000."},"price_type":{"$ref":"#/components/schemas/V1ListingsListingIdOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsPriceType","description":"Can be a fixed amount or a percentage applied on the recommended price. `percent_stacked` stacks on top of other percentage adjustments."},"currency":{"type":"string"},"base_price":{"type":"number","format":"double","description":"Base price for the override date"},"min_stay":{"type":"number","format":"double","description":"Minimum stay set by this override for the date. An integer greater than 0; omitted when the override does not set a minimum stay."},"min_price":{"type":"number","format":"double","description":"If min_price_type is fixed, then min_price is the fixed price. If min_price_type is percent_base or percent_min, then min_price represents a percentage change on the base price or the minimum price, respectively, and should have a value ranging from -75 to 1000."},"min_price_type":{"$ref":"#/components/schemas/V1ListingsListingIdOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsMinPriceType","description":"Can be set as a fixed amount OR a percentage change on the minimum price or a percentage change on the base price"},"max_price":{"type":"number","format":"double","description":"If max_price_type is fixed, then max_price is the fixed maximum price. If max_price_type is percent_base or percent_max, then max_price represents a percentage change on the listing base price or the maximum price, respectively, and should have a value ranging from -75 to 1000."},"max_price_type":{"$ref":"#/components/schemas/V1ListingsListingIdOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsMaxPriceType","description":"Can be set as a fixed amount OR a percentage change on the maximum price or a percentage change on the  base price"},"check_in_check_out_enabled":{"type":"string","description":"`0` if check-in/check-out is disabled for the DSO. `1` if check-in/check-out is enabled — when enabled, `check_in` and `check_out` values are also returned."},"check_in":{"type":"string","description":"A binary string of 7 characters, one per day of the week starting Monday through Sunday. `0` = not allowed, `1` = allowed. e.g. `1000001` means check-in is allowed only on Monday and Sunday."},"check_out":{"type":"string","description":"A binary string of 7 characters, one per day of the week starting Monday through Sunday. `0` = not allowed, `1` = allowed. e.g. `0010000` means check-out is allowed only on Wednesday."},"reason":{"type":"string"},"lead_time_expiry":{"type":"number","format":"double","description":"The DSO expires within this many days of the stay date. Allowed values are 1 to 999."}},"title":"V1ListingsListingIdOverridesGetResponsesContentApplicationJsonSchemaOverridesItems"},"Date_Specific_Overrides__DSO__listingDateLevelOverrides_Response_200":{"type":"object","properties":{"overrides":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsListingIdOverridesGetResponsesContentApplicationJsonSchemaOverridesItems"}}},"title":"Date Specific Overrides (DSO)_listingDateLevelOverrides_Response_200"},"ListingDateLevelOverridesRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing the invalid request"}},"title":"ListingDateLevelOverridesRequestBadRequestError"},"ListingDateLevelOverridesRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ListingDateLevelOverridesRequestNotFoundError"},"V1ListingsListingIdOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsPriceType":{"type":"string","enum":["percent","fixed","percent_stacked"],"description":"Must be `fixed`, `percent`, or `percent_stacked`. Required when `price` is provided. If `fixed`, `currency` must exactly match your PMS or the update results in erroneous data. If `percent` or `percent_stacked`, the change is applied on the recommended base price.","title":"V1ListingsListingIdOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsPriceType"},"V1ListingsListingIdOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsMinPriceType":{"type":"string","enum":["fixed","percent_base","percent_min"],"description":"Minimum price type. Use `fixed` for an absolute price — `currency` is required and must exactly match your PMS. Use `percent_base` or `percent_min` for percentage adjustments on the base or minimum price, respectively.","title":"V1ListingsListingIdOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsMinPriceType"},"V1ListingsListingIdOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsMaxPriceType":{"type":"string","enum":["fixed","percent_base","percent_max"],"title":"V1ListingsListingIdOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsMaxPriceType"},"V1ListingsListingIdOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItems":{"type":"object","properties":{"date":{"type":"string","description":"Override date"},"price":{"type":"string","description":"If `price_type` is `fixed`, the fixed price. If `price_type` is `percent` or `percent_stacked`, the percentage change on the recommended price (range -75 to 1000)."},"price_type":{"$ref":"#/components/schemas/V1ListingsListingIdOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsPriceType","description":"Must be `fixed`, `percent`, or `percent_stacked`. Required when `price` is provided. If `fixed`, `currency` must exactly match your PMS or the update results in erroneous data. If `percent` or `percent_stacked`, the change is applied on the recommended base price."},"currency":{"type":"string","description":"Required when `price_type` is `fixed`. Must exactly match the currency in your PMS."},"min_stay":{"type":"number","format":"double","description":"Minimum stay. Must be an integer greater than 0."},"min_price":{"type":"number","format":"double","description":"If `min_price_type` is `fixed`, the fixed minimum price. If `percent_base` or `percent_min`, a percentage change on the base or minimum price, respectively (range -75 to 1000)."},"min_price_type":{"$ref":"#/components/schemas/V1ListingsListingIdOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsMinPriceType","description":"Minimum price type. Use `fixed` for an absolute price — `currency` is required and must exactly match your PMS. Use `percent_base` or `percent_min` for percentage adjustments on the base or minimum price, respectively."},"max_price":{"type":"number","format":"double","description":"If `max_price_type` is `fixed`, the fixed maximum price. If `percent_base` or `percent_max`, a percentage change on the base or maximum price, respectively (range -75 to 1000)."},"max_price_type":{"$ref":"#/components/schemas/V1ListingsListingIdOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsMaxPriceType"},"base_price":{"type":"number","format":"double","description":"Base price for the override date"},"check_in_check_out_enabled":{"type":"string","description":"`0` if check-in/check-out is disabled. `1` if enabled — also send `check_in` and `check_out` when enabled."},"check_in":{"type":"string","description":"A binary string of 7 characters, one per day starting Monday through Sunday. `0` = not allowed, `1` = allowed. e.g. `1000001` = check-in allowed only on Monday and Sunday."},"check_out":{"type":"string","description":"A binary string of 7 characters, one per day starting Monday through Sunday. `0` = not allowed, `1` = allowed. e.g. `0010000` = check-out allowed only on Wednesday."},"reason":{"type":"string"},"lead_time_expiry":{"type":"number","format":"double","description":"The DSO expires within this many days of the stay date. Allowed values are 1 to 999."}},"title":"V1ListingsListingIdOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItems"},"V1ListingsListingIdOverridesPostResponsesContentApplicationJsonSchemaOverridesItems":{"type":"object","properties":{"date":{"type":"string"},"price":{"type":"string"},"price_type":{"type":"string"},"currency":{"type":"string"},"base_price":{"type":"number","format":"double"},"min_stay":{"type":"number","format":"double","description":"Minimum stay set by this override for the date. An integer greater than 0; omitted when the override does not set a minimum stay."},"min_price":{"type":"number","format":"double"},"min_price_type":{"type":"string"},"max_price":{"type":"number","format":"double"},"max_price_type":{"type":"string"},"check_in_check_out_enabled":{"type":"string","description":"`0` if check-in/check-out is disabled. `1` if enabled."},"check_in":{"type":"string","description":"Binary string of 7 characters for allowed check-in days (Monday–Sunday)."},"check_out":{"type":"string","description":"Binary string of 7 characters for allowed check-out days (Monday–Sunday)."},"reason":{"type":"string"},"lead_time_expiry":{"type":"number","format":"double","description":"The DSO expires within this many days of the stay date. Allowed values are 1 to 999."}},"title":"V1ListingsListingIdOverridesPostResponsesContentApplicationJsonSchemaOverridesItems"},"V1ListingsListingIdOverridesPostResponsesContentApplicationJsonSchemaChildListingsUpdateInfo":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"}},"title":"V1ListingsListingIdOverridesPostResponsesContentApplicationJsonSchemaChildListingsUpdateInfo"},"Date_Specific_Overrides__DSO__listingDateLevelOverrides1_Response_200":{"type":"object","properties":{"overrides":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsListingIdOverridesPostResponsesContentApplicationJsonSchemaOverridesItems"},"description":"Successfully updated overrides for the request."},"child_listings_update_info":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/V1ListingsListingIdOverridesPostResponsesContentApplicationJsonSchemaChildListingsUpdateInfo"},"description":"Included when `update_children` is `true`. Maps child listing IDs to their update status. Returns an empty object if the listing has no child listings."}},"title":"Date Specific Overrides (DSO)_listingDateLevelOverrides1_Response_200"},"ListingDateLevelOverrides1RequestBadRequestError0":{"type":"object","properties":{"error":{"type":"string"}},"title":"ListingDateLevelOverrides1RequestBadRequestError0"},"ListingDateLevelOverrides1RequestBadRequestError1":{"type":"object","properties":{"date":{"type":"string"},"error":{"type":"string"}},"title":"ListingDateLevelOverrides1RequestBadRequestError1"},"ListingDateLevelOverrides1RequestBadRequestError":{"oneOf":[{"$ref":"#/components/schemas/ListingDateLevelOverrides1RequestBadRequestError0"},{"$ref":"#/components/schemas/ListingDateLevelOverrides1RequestBadRequestError1"}],"title":"ListingDateLevelOverrides1RequestBadRequestError"},"V1ListingsListingIdOverridesDeleteRequestBodyContentApplicationJsonSchemaOverridesItems":{"type":"object","properties":{"date":{"type":"string"}},"required":["date"],"title":"V1ListingsListingIdOverridesDeleteRequestBodyContentApplicationJsonSchemaOverridesItems"},"V1ListingsListingIdOverridesDeleteResponsesContentApplicationJsonSchemaOverridesItems":{"type":"object","properties":{"date":{"type":"string"}},"title":"V1ListingsListingIdOverridesDeleteResponsesContentApplicationJsonSchemaOverridesItems"},"Date_Specific_Overrides__DSO__listingDateLevelOverrides2_Response_204":{"type":"object","properties":{"overrides":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingsListingIdOverridesDeleteResponsesContentApplicationJsonSchemaOverridesItems"},"description":"Dates that were successfully deleted"}},"title":"Date Specific Overrides (DSO)_listingDateLevelOverrides2_Response_204"},"ListingDateLevelOverrides2RequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ListingDateLevelOverrides2RequestBadRequestError"},"V1GroupOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsPriceType":{"type":"string","enum":["percent","fixed","percent_base"],"description":"Can be a fixed amount, a percentage on the recommended price, or a percentage on the base price. `percent_stacked` is not supported for group DSOs.","title":"V1GroupOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsPriceType"},"V1GroupOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsMinPriceType":{"type":"string","enum":["fixed","percent_base","percent_min"],"title":"V1GroupOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsMinPriceType"},"V1GroupOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsMaxPriceType":{"type":"string","enum":["fixed","percent_base","percent_max"],"title":"V1GroupOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsMaxPriceType"},"V1GroupOverridesGetResponsesContentApplicationJsonSchemaOverridesItems":{"type":"object","properties":{"date":{"type":"string","format":"date"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"price":{"type":"string","description":"If `price_type` is `fixed`, the fixed price. If `price_type` is `percent` or `percent_base`, the percentage change (range -75 to 1000)."},"price_type":{"$ref":"#/components/schemas/V1GroupOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsPriceType","description":"Can be a fixed amount, a percentage on the recommended price, or a percentage on the base price. `percent_stacked` is not supported for group DSOs."},"currency":{"type":"string","description":"Present when a fixed price/min price/max price is set."},"base_price":{"type":"number","format":"double","description":"Base price for the override date"},"min_stay":{"type":"number","format":"double","description":"Minimum stay (only returned when greater than 0)"},"min_price":{"type":"number","format":"double","description":"If `min_price_type` is `fixed`, the fixed minimum price. If `percent_base` or `percent_min`, a percentage change on the base or minimum price (range -75 to 1000)."},"min_price_type":{"$ref":"#/components/schemas/V1GroupOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsMinPriceType"},"max_price":{"type":"number","format":"double","description":"If `max_price_type` is `fixed`, the fixed maximum price. If `percent_base` or `percent_max`, a percentage change on the base or maximum price (range -75 to 1000)."},"max_price_type":{"$ref":"#/components/schemas/V1GroupOverridesGetResponsesContentApplicationJsonSchemaOverridesItemsMaxPriceType"},"check_in_check_out_enabled":{"type":"string","description":"`0` if check-in/check-out is disabled for the DSO. `1` if enabled — when enabled, `check_in` and `check_out` values are also returned."},"check_in":{"type":"string","description":"A binary string of 7 characters, one per day of the week starting Monday through Sunday. `0` = not allowed, `1` = allowed."},"check_out":{"type":"string","description":"A binary string of 7 characters, one per day of the week starting Monday through Sunday. `0` = not allowed, `1` = allowed."},"reason":{"type":"string"}},"title":"V1GroupOverridesGetResponsesContentApplicationJsonSchemaOverridesItems"},"Date_Specific_Overrides__DSO__getGroupOverrides_Response_200":{"type":"object","properties":{"id":{"type":"integer","description":"Group ID"},"overrides":{"type":"array","items":{"$ref":"#/components/schemas/V1GroupOverridesGetResponsesContentApplicationJsonSchemaOverridesItems"}},"message":{"type":"string","description":"Present when no DSOs are found for the group"}},"title":"Date Specific Overrides (DSO)_getGroupOverrides_Response_200"},"GetGroupOverridesRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetGroupOverridesRequestBadRequestError"},"V1GroupOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsPriceType":{"type":"string","enum":["percent","fixed","percent_base"],"description":"Required when `price` is provided. Must be `fixed`, `percent`, or `percent_base`.","title":"V1GroupOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsPriceType"},"V1GroupOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsMinPriceType":{"type":"string","enum":["fixed","percent_base","percent_min"],"title":"V1GroupOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsMinPriceType"},"V1GroupOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsMaxPriceType":{"type":"string","enum":["fixed","percent_base","percent_max"],"title":"V1GroupOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsMaxPriceType"},"V1GroupOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItems":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Override date (YYYY-MM-DD). Must be between today and 2 years from today."},"price":{"type":"string","description":"If `price_type` is `fixed`, the fixed price (must be greater than 10). If `percent` or `percent_base`, the percentage change (range -75 to 1000)."},"price_type":{"$ref":"#/components/schemas/V1GroupOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsPriceType","description":"Required when `price` is provided. Must be `fixed`, `percent`, or `percent_base`."},"currency":{"type":"string","description":"Required when `price_type` is `fixed`."},"min_stay":{"type":"number","format":"double","description":"Minimum stay. Must be an integer greater than 0."},"min_price":{"type":"number","format":"double","description":"If `min_price_type` is `fixed`, the fixed minimum price. If `percent_base` or `percent_min`, a percentage change on the base or minimum price (range -75 to 1000)."},"min_price_type":{"$ref":"#/components/schemas/V1GroupOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsMinPriceType"},"max_price":{"type":"number","format":"double","description":"If `max_price_type` is `fixed`, the fixed maximum price. If `percent_base` or `percent_max`, a percentage change on the base or maximum price (range -75 to 1000)."},"max_price_type":{"$ref":"#/components/schemas/V1GroupOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItemsMaxPriceType"},"base_price":{"type":"number","format":"double","description":"Base price for the override date"},"check_in_check_out_enabled":{"type":"string","description":"`0` if check-in/check-out is disabled. `1` if enabled — also send `check_in` and `check_out` when enabled."},"check_in":{"type":"string","description":"A binary string of 7 characters, one per day starting Monday through Sunday. `0` = not allowed, `1` = allowed."},"check_out":{"type":"string","description":"A binary string of 7 characters, one per day starting Monday through Sunday. `0` = not allowed, `1` = allowed."},"reason":{"type":"string"},"lead_time_expiry":{"type":"number","format":"double","description":"The DSO expires within this many days of the stay date. Allowed values are 1 to 999."}},"required":["date"],"title":"V1GroupOverridesPostRequestBodyContentApplicationJsonSchemaOverridesItems"},"V1GroupOverridesPostResponsesContentApplicationJsonSchemaOverridesItems":{"type":"object","properties":{"date":{"type":"string","format":"date"},"price":{"type":"string"},"price_type":{"type":"string"},"currency":{"type":"string"},"base_price":{"type":"number","format":"double"},"min_stay":{"type":"number","format":"double","description":"Minimum stay set by this override for the date. An integer greater than 0; omitted when the override does not set a minimum stay."},"min_price":{"type":"number","format":"double"},"min_price_type":{"type":"string"},"max_price":{"type":"number","format":"double"},"max_price_type":{"type":"string"},"check_in_check_out_enabled":{"type":"string"},"check_in":{"type":"string"},"check_out":{"type":"string"},"reason":{"type":"string"},"lead_time_expiry":{"type":"number","format":"double"}},"title":"V1GroupOverridesPostResponsesContentApplicationJsonSchemaOverridesItems"},"V1GroupOverridesPostResponsesContentApplicationJsonSchemaFailedDatesItems":{"type":"object","properties":{"date":{"type":"string"},"error":{"type":"string"}},"title":"V1GroupOverridesPostResponsesContentApplicationJsonSchemaFailedDatesItems"},"Date_Specific_Overrides__DSO__updateGroupOverrides_Response_200":{"type":"object","properties":{"id":{"type":"integer"},"overrides":{"type":"array","items":{"$ref":"#/components/schemas/V1GroupOverridesPostResponsesContentApplicationJsonSchemaOverridesItems"},"description":"Successfully saved overrides"},"failed_dates":{"type":"array","items":{"$ref":"#/components/schemas/V1GroupOverridesPostResponsesContentApplicationJsonSchemaFailedDatesItems"},"description":"Dates that failed validation or were out of range"}},"title":"Date Specific Overrides (DSO)_updateGroupOverrides_Response_200"},"UpdateGroupOverridesRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"UpdateGroupOverridesRequestBadRequestError"},"UpdateGroupOverridesRequestForbiddenError":{"type":"object","properties":{"error_code":{"type":"string"},"error":{"type":"string"}},"title":"UpdateGroupOverridesRequestForbiddenError"},"V1GroupOverridesDeleteRequestBodyContentApplicationJsonSchemaOverridesItems":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Override date to delete (YYYY-MM-DD)"}},"required":["date"],"title":"V1GroupOverridesDeleteRequestBodyContentApplicationJsonSchemaOverridesItems"},"V1GroupOverridesDeleteResponsesContentApplicationJsonSchemaFailedDatesItems":{"type":"object","properties":{"date":{"type":"string"},"error":{"type":"string"}},"title":"V1GroupOverridesDeleteResponsesContentApplicationJsonSchemaFailedDatesItems"},"Date_Specific_Overrides__DSO__deleteGroupOverrides_Response_200":{"type":"object","properties":{"id":{"type":"integer"},"deleted_dates":{"type":"array","items":{"type":"string","format":"date"},"description":"Dates that were successfully deleted"},"failed_dates":{"type":"array","items":{"$ref":"#/components/schemas/V1GroupOverridesDeleteResponsesContentApplicationJsonSchemaFailedDatesItems"},"description":"Dates that could not be deleted"}},"title":"Date Specific Overrides (DSO)_deleteGroupOverrides_Response_200"},"DeleteGroupOverridesRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"DeleteGroupOverridesRequestBadRequestError"},"DeleteGroupOverridesRequestForbiddenError":{"type":"object","properties":{"error_code":{"type":"string"},"error":{"type":"string"}},"title":"DeleteGroupOverridesRequestForbiddenError"},"V1ListingPricesPostRequestBodyContentApplicationJsonSchemaListingsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique listing ID. The listing must exist in your PriceLabs account."},"pms":{"type":"string","description":"PMS name for the listing. Must match the PMS the listing is connected under in PriceLabs."},"dateFrom":{"type":"string","format":"date","description":"Optional start of date range (`YYYY-MM-DD`). Used only if it falls within the listing's available pricing calendar; otherwise the calendar start is used."},"dateTo":{"type":"string","format":"date","description":"Optional end of date range (`YYYY-MM-DD`). Used only if it falls within the listing's available pricing calendar; otherwise the calendar end is used."},"reason":{"type":"boolean","description":"If truthy, each date entry in the response includes a pricing reason breakdown (`listing_info`, `market_factors`, `pricing_customizations`, etc.)."}},"required":["id","pms"],"title":"V1ListingPricesPostRequestBodyContentApplicationJsonSchemaListingsItems"},"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsErrorStatus":{"type":"string","enum":["LISTING_NOT_PRESENT","LISTING_NO_DATA","LISTING_TOGGLE_OFF"],"description":"Machine-readable error code. `LISTING_NOT_PRESENT` — listing does not exist in PriceLabs. `LISTING_NO_DATA` — prices were not fetched on PriceLabs. `LISTING_TOGGLE_OFF` — sync is turned OFF.","title":"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsErrorStatus"},"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsLosPricingLosNight":{"type":"object","properties":{"los_night":{"type":"string","description":"This is the \"Stay Length\" in LOS pricing model"},"max_price":{"type":"string","description":"Max Price for the LOS"},"min_price":{"type":"string","description":"Minimum Price for the LOS"},"los_adjustment":{"type":"string","description":"Percentage Premium or Discount"}},"description":"This is the \"Stay Length\" in LOS pricing model","title":"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsLosPricingLosNight"},"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsLosPricing":{"type":"object","properties":{"los_night":{"$ref":"#/components/schemas/V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsLosPricingLosNight","description":"This is the \"Stay Length\" in LOS pricing model"}},"description":"LOS pricing as defined in PL for the listing","title":"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsLosPricing"},"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsDataItemsAdr":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"description":"Average Daily Rate. `-1` if not applicable.","title":"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsDataItemsAdr"},"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsDataItemsAdrStly":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"description":"Average Daily Rate same time last year. `-1` if not applicable.","title":"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsDataItemsAdrStly"},"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsDataItemsReason":{"type":"object","properties":{},"description":"Pricing reason breakdown. Included per date when `reason` is truthy in the request. Contains `listing_info`, `market_factors`, `pricing_customizations`, `thresholds`, `other_customizations`, `final_price_override`, and `final_adjustments`.","title":"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsDataItemsReason"},"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsDataItems":{"type":"object","properties":{"date":{"type":"string","description":"Applicable date for the mentioned prices"},"price":{"type":"number","format":"double","description":"This is the price recommended by PriceLabs"},"user_price":{"type":"number","format":"double","description":"Last Seen Price on the PMS. If \"-1\" it means day is unavailable"},"booked_price":{"type":"number","format":"double","description":"The \"Your Price\" value from the Customizations \"Download prices\" CSV. Unlike `user_price`, it is filled on booked and blocked dates."},"uncustomized_price":{"type":"number","format":"double","description":"The recommended price before any customizations (far out premiums, last-minute discounts, etc.) are applied."},"min_stay":{"type":"number","format":"double","description":"minimum stay"},"booking_status":{"type":"string","description":"Booking Status"},"booking_status_STLY":{"type":"string","description":"Booking Status same time last year"},"ADR":{"$ref":"#/components/schemas/V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsDataItemsAdr","description":"Average Daily Rate. `-1` if not applicable."},"ADR_STLY":{"$ref":"#/components/schemas/V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsDataItemsAdrStly","description":"Average Daily Rate same time last year. `-1` if not applicable."},"unbookable":{"type":"number","format":"double","description":"If 0, date is bookable, if 1, date is not bookable due to a minimum stay/check-in/check-out restriction set on PriceLabs"},"booked_date":{"type":"string"},"booked_date_STLY":{"type":"string","description":"Booked date same time last year. `-1` if not applicable."},"occupancy":{"type":"number","format":"double","description":"Occupancy for the date when available in pricing reasons data."},"multi_unit_occupancy":{"type":"string","description":"Multi-unit occupancy when available (e.g. `3/4`)."},"weekly_discount":{"type":"number","format":"double","description":"Weekly discount applied, if any"},"monthly_discount":{"type":"number","format":"double","description":"monthly discount applied, if any"},"extra_person_fee":{"type":"number","format":"double","description":"Extra guest fees, if applicable"},"extra_person_fee_trigger":{"type":"number","format":"double","description":"No. of guests after which extra guest fees is applicable"},"check_in":{"type":"boolean","description":"Whether check-in is allowed(true) or not(false)"},"check_out":{"type":"boolean","description":"Whether check-out is allowed(true) or not(false)"},"demand_color":{"type":"string","description":"Hex color code representing the demand level for this date."},"demand_desc":{"type":"string","description":"Demand description like Low Demand, Normal Demand, Good Demand, High Demand"},"reason":{"$ref":"#/components/schemas/V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsDataItemsReason","description":"Pricing reason breakdown. Included per date when `reason` is truthy in the request. Contains `listing_info`, `market_factors`, `pricing_customizations`, `thresholds`, `other_customizations`, `final_price_override`, and `final_adjustments`."}},"title":"V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsDataItems"},"V1ListingPricesPostResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"id":{"type":"string","description":"ID for the listing"},"pms":{"type":"string","description":"PMS Name"},"group":{"type":"string","description":"Listing Tags (deprecated). Unfortunately named legacy field."},"currency":{"type":"string","description":"Currency for the listing"},"last_refreshed_at":{"type":"string","description":"DateTime when the listing was last refreshed in PL like when \"Save & Refresh\" is done. Also updated when sync happens as prices are refreshed before sync."},"error":{"type":"string","description":"Returned instead of price data when the request cannot be fulfilled for this listing"},"error_status":{"$ref":"#/components/schemas/V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsErrorStatus","description":"Machine-readable error code. `LISTING_NOT_PRESENT` — listing does not exist in PriceLabs. `LISTING_NO_DATA` — prices were not fetched on PriceLabs. `LISTING_TOGGLE_OFF` — sync is turned OFF."},"los_pricing":{"$ref":"#/components/schemas/V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsLosPricing","description":"LOS pricing as defined in PL for the listing"},"data":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingPricesPostResponsesContentApplicationJsonSchemaItemsDataItems"},"description":"Daily price entries for the requested date range"}},"title":"V1ListingPricesPostResponsesContentApplicationJsonSchemaItems"},"PricesForListingsRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"},"desc":{"type":"string"}},"title":"PricesForListingsRequestBadRequestError"},"V1RefreshListingPostResponsesContentApplicationJsonSchemaPricingArrayItems":{"type":"object","properties":{"date":{"type":"string","format":"date"},"price":{"type":"string","description":"Final recommended price for the date, after all customizations, overrides, and min/max limits."},"user_price":{"type":"string","description":"Price after user adjustments for the date."},"uncustomized_price":{"type":"string","description":"Price before your customizations and overrides are applied."},"min_price":{"type":"string","description":"Minimum price in effect for the date."},"max_price":{"type":"string","description":"Maximum price in effect for the date."},"min_stay":{"type":"string","description":"Minimum stay in effect for the date."},"dso_flag":{"type":"string","description":"`1` if a date-specific override is applied on this date at any level, `0` otherwise."},"listing_dso_flag":{"type":"string","description":"`1` if a listing-level date-specific override is applied on this date."},"group_dso_flag":{"type":"string","description":"`1` if a group-level date-specific override is applied on this date."},"sub_group_dso_flag":{"type":"string","description":"`1` if a subgroup-level date-specific override is applied on this date."},"acc_dso_flag":{"type":"string","description":"`1` if an account-level date-specific override is applied on this date."},"num_bookings":{"type":"string","description":"Number of bookings on the date."},"unbookable":{"type":"string","description":"`1` if the date is blocked or otherwise unbookable."},"demand":{"type":"string","description":"Demand indicator for the date."},"reasons_json":{"type":"string","description":"JSON-encoded breakdown of how the price was computed (`listing_info`, `market_factors`, `pricing_customizations`, `thresholds`, etc.)."}},"title":"V1RefreshListingPostResponsesContentApplicationJsonSchemaPricingArrayItems"},"Prices_refreshListing_Response_200":{"type":"object","properties":{"pricing_array":{"type":"array","items":{"$ref":"#/components/schemas/V1RefreshListingPostResponsesContentApplicationJsonSchemaPricingArrayItems"},"description":"One entry per date of the listing's pricing calendar, computed by this refresh. Values are returned as strings; `-1` denotes \"not set\". Additional internal fields may also be present."}},"title":"Prices_refreshListing_Response_200"},"RefreshListingRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"RefreshListingRequestBadRequestError"},"V1RefreshListingPostResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"message":{"type":"string"}},"title":"V1RefreshListingPostResponsesContentApplicationJsonSchemaError"},"RefreshListingRequestTooManyRequestsError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/V1RefreshListingPostResponsesContentApplicationJsonSchemaError"}},"title":"RefreshListingRequestTooManyRequestsError"},"V1FetchRatePlansGetResponsesContentApplicationJsonSchemaRatePlansRateplans":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"Adjustment type (e.g. `fixed` or `percent`)"},"default":{"type":"string","description":"`\"true\"` if this is the default rate plan"},"plan_type":{"type":"string"},"adjustment":{"type":"number","format":"double"},"update_type":{"type":"string","description":"Defaults to `price and restrictions` when blank or `all`"}},"title":"V1FetchRatePlansGetResponsesContentApplicationJsonSchemaRatePlansRateplans"},"V1FetchRatePlansGetResponsesContentApplicationJsonSchemaRatePlans":{"type":"object","properties":{"id":{"type":"string","description":"Listing ID"},"pms":{"type":"string","description":"PMS name"},"name":{"type":"string","description":"Listing name"},"rateplans":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/V1FetchRatePlansGetResponsesContentApplicationJsonSchemaRatePlansRateplans"},"description":"Rate plans keyed by rate plan ID"}},"title":"V1FetchRatePlansGetResponsesContentApplicationJsonSchemaRatePlans"},"Prices_fetchRatePlans_Response_200":{"type":"object","properties":{"rate_plans":{"$ref":"#/components/schemas/V1FetchRatePlansGetResponsesContentApplicationJsonSchemaRatePlans"}},"title":"Prices_fetchRatePlans_Response_200"},"FetchRatePlansRequestForbiddenError":{"type":"object","properties":{"error":{"type":"string"},"desc":{"type":"string"}},"title":"FetchRatePlansRequestForbiddenError"},"V1NeighborhoodDataGetParametersUseDefaultData":{"type":"string","enum":["true","false"],"default":"false","title":"V1NeighborhoodDataGetParametersUseDefaultData"},"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataFuturePercentilePricesCategory":{"type":"object","properties":{"Listings Used":{"type":"integer"},"Active Used":{"type":"integer"},"Inactive Used":{"type":"integer"},"X_values":{"type":"array","items":{"type":"string","format":"date"},"description":"Array of future dates."},"Y_values":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}},"description":"Five corresponding arrays — one per label — with values for each date in X_values."}},"title":"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataFuturePercentilePricesCategory"},"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataFuturePercentilePrices":{"type":"object","properties":{"Category":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataFuturePercentilePricesCategory"},"description":"Keyed by bedroom category — `\"-1\"` room, `\"0\"` studio, `\"1\"` 1BR, and so on — or compset name when using a Market Dashboard custom compset."},"Labels":{"type":"array","items":{"type":"string"},"description":"25th Percentile, 50th Percentile, 75th Percentile, Median Booked Price, 90th Percentile."}},"description":"Per bedroom category (key), percentile market prices for each stay date. Uses Category (key), X_values (dates), Y_values (one array per label), and Labels.","title":"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataFuturePercentilePrices"},"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataFutureOccNewCancCategory":{"type":"object","properties":{"Listings Used":{"type":"integer"},"Active Used":{"type":"integer"},"Inactive Used":{"type":"integer"},"X_values":{"type":"array","items":{"type":"string","format":"date"},"description":"Array of future dates."},"Y_values":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}}},"description":"One array per label; nested arrays hold values per date."}},"title":"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataFutureOccNewCancCategory"},"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataFutureOccNewCanc":{"type":"object","properties":{"Category":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataFutureOccNewCancCategory"},"description":"Keyed by bedroom category or compset name (same structure as Future Percentile Prices)."},"Labels":{"type":"array","items":{"type":"string"},"description":"Occupancy, New Bookings (last 7 days), Canceled Bookings (last 30 days), Occupancy_LY, Occupancy_STLY, New_Bookings_STLY."}},"description":"Per bedroom category, future occupancy/pickup plus same-time-last-year occupancy, pickup, and final occupancy.","title":"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataFutureOccNewCanc"},"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataSummaryTableBasePriceCategoryYValuesItems":{"oneOf":[{"type":"number","format":"double"},{"type":"array","items":{"description":"Any type"}}],"title":"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataSummaryTableBasePriceCategoryYValuesItems"},"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataSummaryTableBasePriceCategory":{"type":"object","properties":{"Listings Used":{"type":"integer"},"Active Used":{"type":"integer"},"Inactive Used":{"type":"integer"},"Y_values":{"type":"array","items":{"$ref":"#/components/schemas/V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataSummaryTableBasePriceCategoryYValuesItems"}}},"title":"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataSummaryTableBasePriceCategory"},"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataSummaryTableBasePrice":{"type":"object","properties":{"Category":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataSummaryTableBasePriceCategory"},"description":"Keyed by bedroom category or compset name."},"Labels":{"type":"array","items":{"type":"string"},"description":"25th/50th/75th/90th Percentile Price. For Market Dashboard sources, may also include Median Listed Price (USD), Median Booked Nightly Price (USD), Median Booked Weekly Price (USD), Median Booked Monthly Price (USD), Median LOS, Median Lead Time."}},"description":"Per bedroom category, percentile prices for the past 180 and future 180 days.","title":"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataSummaryTableBasePrice"},"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataMarketKpiCategory":{"type":"object","properties":{"X_values":{"type":"array","items":{"type":"string"},"description":"Time periods for which KPI data is available."},"Y_values":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}},"description":"2D array with 5 KPI rows; columns align with X_values."}},"title":"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataMarketKpiCategory"},"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataMarketKpi":{"type":"object","properties":{"Category":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataMarketKpiCategory"},"description":"Keyed by bedroom type; each entry has X_values (time periods) and Y_values (2D array with 5 KPI rows aligned to X_values)."},"Labels":{"type":"array","items":{"type":"string"},"description":"Total Available Days (days listings were available), Booking Window (median days between booking and first stay), LOS (nights per reservation), Revenue (total booking revenue), Total Booked Days (total booked days across listings)."}},"description":"Aggregated market KPIs at monthly level, plus last 365 and 730 days. Has Category (keyed by bedroom type) and Labels.","title":"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataMarketKpi"},"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"Listings Used":{"type":"integer","description":"Total number of listings considered in this neighborhood."},"currency":{"type":"string","description":"Listing currency."},"lat":{"type":"number","format":"double","description":"Listing latitude."},"lng":{"type":"number","format":"double","description":"Listing longitude."},"source":{"type":"string","description":"Data source — Airbnb or VRBO as indicated in the response (e.g. `airbnb`, `vrbo`)."},"Neighborhood Data Source":{"type":"string","description":"Source selected on the ND tab under \"Select CompSets for comparison\". Can be `Nearby Listings` or `Market Dashboard: <dashboard name>`."},"Future Percentile Prices":{"$ref":"#/components/schemas/V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataFuturePercentilePrices","description":"Per bedroom category (key), percentile market prices for each stay date. Uses Category (key), X_values (dates), Y_values (one array per label), and Labels."},"Future Occ/New/Canc":{"$ref":"#/components/schemas/V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataFutureOccNewCanc","description":"Per bedroom category, future occupancy/pickup plus same-time-last-year occupancy, pickup, and final occupancy."},"Summary Table Base Price":{"$ref":"#/components/schemas/V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataSummaryTableBasePrice","description":"Per bedroom category, percentile prices for the past 180 and future 180 days."},"Market KPI":{"$ref":"#/components/schemas/V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaDataMarketKpi","description":"Aggregated market KPIs at monthly level, plus last 365 and 730 days. Has Category (keyed by bedroom type) and Labels."}},"description":"Neighborhood data payload from the pricing engine (`neighborhood_json`).","title":"V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaData"},"Neighborhood_Data_getNeighborhoodDataForAListing_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/V1NeighborhoodDataGetResponsesContentApplicationJsonSchemaData","description":"Neighborhood data payload from the pricing engine (`neighborhood_json`)."},"status":{"type":"string"}},"required":["data","status"],"title":"Neighborhood Data_getNeighborhoodDataForAListing_Response_200"},"GetNeighborhoodDataForAListingRequestBadRequestError0":{"type":"object","properties":{"error":{"type":"string"},"status":{"type":"string"}},"title":"GetNeighborhoodDataForAListingRequestBadRequestError0"},"GetNeighborhoodDataForAListingRequestBadRequestError1":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetNeighborhoodDataForAListingRequestBadRequestError1"},"GetNeighborhoodDataForAListingRequestBadRequestError":{"oneOf":[{"$ref":"#/components/schemas/GetNeighborhoodDataForAListingRequestBadRequestError0"},{"$ref":"#/components/schemas/GetNeighborhoodDataForAListingRequestBadRequestError1"}],"title":"GetNeighborhoodDataForAListingRequestBadRequestError"},"GetNeighborhoodDataForAListingRequestUnauthorizedError":{"type":"object","properties":{"message":{"type":"string"}},"title":"GetNeighborhoodDataForAListingRequestUnauthorizedError"},"GetNeighborhoodDataForAListingRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"},"status":{"type":"string"}},"title":"GetNeighborhoodDataForAListingRequestNotFoundError"},"GetNeighborhoodDataForAListingRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"},"status":{"type":"string"}},"title":"GetNeighborhoodDataForAListingRequestInternalServerError"},"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItemsKey":{"type":"string","enum":["NL","MD","CCC"],"title":"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItemsKey"},"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItemsBrRangeOptionsItems":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"integer"},"num_properties":{"type":"integer"}},"title":"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItemsBrRangeOptionsItems"},"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItemsBrRangeSelected":{"type":"object","properties":{"min":{"type":"integer"},"max":{"type":"integer"},"selected":{"type":"array","items":{"type":"integer"}}},"description":"NL only. The bedroom selection currently applied.","title":"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItemsBrRangeSelected"},"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItemsMdReportsItems":{"type":"object","properties":{"report_id":{"type":"integer","description":"Pass this as `md_id`."},"report_name":{"type":"string"},"valid":{"type":"integer","description":"0 when the report cannot be used as a source."}},"title":"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItemsMdReportsItems"},"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItems":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItemsKey"},"label":{"type":"string","description":"Human-readable name of the source."},"available":{"type":"boolean","description":"Whether this source can currently be selected for this listing."},"reason":{"type":"string","description":"Present only when `available` is false; why the source cannot be used."},"br_range_options":{"type":"array","items":{"$ref":"#/components/schemas/V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItemsBrRangeOptionsItems"},"description":"NL only. Bedroom buckets available for comparison."},"br_range_selected":{"$ref":"#/components/schemas/V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItemsBrRangeSelected","description":"NL only. The bedroom selection currently applied."},"md_reports":{"type":"array","items":{"$ref":"#/components/schemas/V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItemsMdReportsItems"},"description":"MD only. Market Dashboard reports on the account."},"selected_md_id":{"type":["integer","null"],"description":"MD only, and only when MD is the current source."},"selected_md_compset":{"type":["string","null"],"description":"MD only, and only when MD is the current source."}},"title":"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItems"},"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataCurrentSource":{"type":"string","enum":["NL","MD","CCC"],"title":"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataCurrentSource"},"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"sources":{"type":"array","items":{"$ref":"#/components/schemas/V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataSourcesItems"},"description":"One entry per source, always in the order NL, MD, CCC."},"current_source":{"$ref":"#/components/schemas/V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaDataCurrentSource"},"listing_id":{"type":"string"},"pms":{"type":"string"}},"title":"V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaData"},"Neighborhood_Data_getNeighborhoodDataSources_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/V1NeighborhoodDataFetchSourcesGetResponsesContentApplicationJsonSchemaData"},"status":{"type":"string"}},"title":"Neighborhood Data_getNeighborhoodDataSources_Response_200"},"GetNeighborhoodDataSourcesRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"},"status":{"type":"string"}},"title":"GetNeighborhoodDataSourcesRequestBadRequestError"},"GetNeighborhoodDataSourcesRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"},"status":{"type":"string"}},"title":"GetNeighborhoodDataSourcesRequestNotFoundError"},"V1NeighborhoodDataGetMdCompsetsGetResponsesContentApplicationJsonSchemaDataCompsetsItems":{"type":"object","properties":{"value":{"type":"string","description":"Pass this as `md_compset`."},"label":{"type":"string","description":"Display text. Not a valid `md_compset`."},"group":{"type":"string"}},"title":"V1NeighborhoodDataGetMdCompsetsGetResponsesContentApplicationJsonSchemaDataCompsetsItems"},"V1NeighborhoodDataGetMdCompsetsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"md_id":{"type":"string"},"compsets":{"type":"array","items":{"$ref":"#/components/schemas/V1NeighborhoodDataGetMdCompsetsGetResponsesContentApplicationJsonSchemaDataCompsetsItems"}},"listing_id":{"type":"string"},"pms":{"type":"string"}},"title":"V1NeighborhoodDataGetMdCompsetsGetResponsesContentApplicationJsonSchemaData"},"Neighborhood_Data_getMdReportCompsets_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/V1NeighborhoodDataGetMdCompsetsGetResponsesContentApplicationJsonSchemaData"},"status":{"type":"string"}},"title":"Neighborhood Data_getMdReportCompsets_Response_200"},"GetMdReportCompsetsRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"},"status":{"type":"string"}},"title":"GetMdReportCompsetsRequestBadRequestError"},"GetMdReportCompsetsRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"},"status":{"type":"string"}},"title":"GetMdReportCompsetsRequestNotFoundError"},"V1NeighborhoodDataUpdateSourcePostRequestBodyContentApplicationJsonSchemaSelectedSource":{"type":"string","enum":["NL","MD","CCC"],"description":"Compset source to apply. Case-insensitive.","title":"V1NeighborhoodDataUpdateSourcePostRequestBodyContentApplicationJsonSchemaSelectedSource"},"V1NeighborhoodDataUpdateSourcePostResponsesContentApplicationJsonSchemaDataSelectedSource":{"type":"string","enum":["NL","MD","CCC"],"description":"The source now in effect.","title":"V1NeighborhoodDataUpdateSourcePostResponsesContentApplicationJsonSchemaDataSelectedSource"},"V1NeighborhoodDataUpdateSourcePostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"selected_source":{"$ref":"#/components/schemas/V1NeighborhoodDataUpdateSourcePostResponsesContentApplicationJsonSchemaDataSelectedSource","description":"The source now in effect."},"listing_id":{"type":"string"},"pms":{"type":"string"},"br_selection":{"type":"string","description":"NL only. The normalised bedroom selection that was applied."},"md_id":{"type":"integer","description":"MD only."},"md_compset":{"type":"string","description":"MD only. The canonical compset value that was applied."}},"title":"V1NeighborhoodDataUpdateSourcePostResponsesContentApplicationJsonSchemaData"},"Neighborhood_Data_assignNeighborhoodDataSource_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/V1NeighborhoodDataUpdateSourcePostResponsesContentApplicationJsonSchemaData"},"status":{"type":"string"}},"title":"Neighborhood Data_assignNeighborhoodDataSource_Response_200"},"AssignNeighborhoodDataSourceRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"},"available_br_selection":{"type":"array","items":{"type":"string"},"description":"Present when `br_selection` was rejected."},"available_md_ids":{"type":"array","items":{"type":"string"},"description":"Present when `md_id` was rejected."},"available_compsets":{"type":"array","items":{"type":"string"},"description":"Present when `md_compset` was rejected."},"status":{"type":"string"}},"title":"AssignNeighborhoodDataSourceRequestBadRequestError"},"AssignNeighborhoodDataSourceRequestForbiddenError":{"type":"object","properties":{"error":{"type":"string"},"status":{"type":"string"}},"title":"AssignNeighborhoodDataSourceRequestForbiddenError"},"AssignNeighborhoodDataSourceRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"},"status":{"type":"string"}},"title":"AssignNeighborhoodDataSourceRequestNotFoundError"},"V1ReservationDataGetParametersIncludeHidden":{"type":"string","enum":["true","false"],"default":"true","title":"V1ReservationDataGetParametersIncludeHidden"},"V1ReservationDataGetResponsesContentApplicationJsonSchemaDataItemsBookingStatus":{"type":"string","enum":["booked","cancelled","blocked","available"],"description":"Typically `booked` or `cancelled`. For `yourrentals_prod`, `blocked` may also appear. `available` when `include=available`.","title":"V1ReservationDataGetResponsesContentApplicationJsonSchemaDataItemsBookingStatus"},"V1ReservationDataGetResponsesContentApplicationJsonSchemaDataItemsRentalRevenue1":{"type":"string","enum":["NA"],"title":"V1ReservationDataGetResponsesContentApplicationJsonSchemaDataItemsRentalRevenue1"},"V1ReservationDataGetResponsesContentApplicationJsonSchemaDataItemsRentalRevenue":{"oneOf":[{"type":"number","format":"double"},{"$ref":"#/components/schemas/V1ReservationDataGetResponsesContentApplicationJsonSchemaDataItemsRentalRevenue1"}],"description":"Numeric for supported PMSs; otherwise `\"NA\"`.","title":"V1ReservationDataGetResponsesContentApplicationJsonSchemaDataItemsRentalRevenue"},"V1ReservationDataGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"listing_id":{"type":"string"},"listing_name":{"type":"string"},"unit_id":{"type":"string","description":"Present for unit-level reservations; omitted for listing-level rows."},"reservation_id":{"type":"string"},"check_in":{"type":"string","format":"date"},"check_out":{"type":"string","format":"date"},"booking_status":{"$ref":"#/components/schemas/V1ReservationDataGetResponsesContentApplicationJsonSchemaDataItemsBookingStatus","description":"Typically `booked` or `cancelled`. For `yourrentals_prod`, `blocked` may also appear. `available` when `include=available`."},"booked_date":{"type":["string","null"],"format":"date-time"},"rental_revenue":{"$ref":"#/components/schemas/V1ReservationDataGetResponsesContentApplicationJsonSchemaDataItemsRentalRevenue","description":"Numeric for supported PMSs; otherwise `\"NA\"`."},"total_cost":{"type":["number","null"],"format":"double"},"no_of_days":{"type":"integer"},"currency":{"type":["string","null"]},"cancelled_on":{"type":["string","null"],"format":"date-time"},"guestName":{"type":"string","description":"Always returned as `Hidden`."},"cleaning_fees":{"type":"number","format":"double","description":"Present only when provided by the PMS in booking info."},"booking_channel":{"type":"string","description":"Present only when provided in booking info (`pl_source`)."},"channelConfirmationCode":{"type":"string","description":"Present only when provided in booking info."},"guest_count":{"type":"integer","description":"Present only when provided by the PMS in booking info."},"ota_commission":{"type":"number","format":"double","description":"Present only when provided by the PMS."}},"title":"V1ReservationDataGetResponsesContentApplicationJsonSchemaDataItems"},"Reservations_getReservations_Response_200":{"type":"object","properties":{"pms_name":{"type":"string","description":"Lowercased PMS name from the request."},"next_page":{"type":"boolean","description":"`true` when the number of returned rows equals `limit` (more pages may exist). Keep requesting until `false`."},"data":{"type":"array","items":{"$ref":"#/components/schemas/V1ReservationDataGetResponsesContentApplicationJsonSchemaDataItems"},"description":"Reservation rows for the request. Empty when the PMS does not provide reservations."}},"required":["pms_name","next_page","data"],"title":"Reservations_getReservations_Response_200"},"GetReservationsRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetReservationsRequestBadRequestError"},"GetReservationsRequestUnauthorizedError":{"type":"object","properties":{"message":{"type":"string"}},"title":"GetReservationsRequestUnauthorizedError"},"GetReservationsRequestForbiddenError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetReservationsRequestForbiddenError"},"V1CreateReservationsPostRequestBodyContentApplicationJsonSchemaReservationsItemsPlStatus":{"type":"string","enum":["booked","cancelled","blocked","available"],"description":"Reservation status. Values are normalized (lowercase, spaces removed).","title":"V1CreateReservationsPostRequestBodyContentApplicationJsonSchemaReservationsItemsPlStatus"},"V1CreateReservationsPostRequestBodyContentApplicationJsonSchemaReservationsItems":{"type":"object","properties":{"listing_id":{"type":"string","description":"PriceLabs listing ID. Must exist on the account for `pms_name`."},"pms_name":{"type":"string","description":"PMS or channel name for the listing (case-insensitive). Must support Portfolio Analytics."},"reservation_id":{"type":["string","null"],"description":"Unique reservation ID for this PMS. If blank, PriceLabs generates `{listing_id}_{start_date}_{end_date}`."},"start_date":{"type":"string","format":"date","description":"Check-in date (`YYYY-MM-DD`). Must be before `end_date`."},"end_date":{"type":"string","format":"date","description":"Check-out date (`YYYY-MM-DD`). Exclusive of the stay end in length-of-stay calculations (`end_date - start_date` nights)."},"no_of_days":{"type":["integer","null"],"description":"Length of stay in nights. If omitted or it does not match `end_date - start_date`, the API uses the date difference."},"total_cost":{"type":["number","null"],"format":"double","description":"Total booking amount. Required and must be greater than `0` when `pl_status` is `booked`. Minimum `0` for other statuses."},"currency":{"type":"string","description":"ISO currency code (required). Stored uppercase (for example `USD`)."},"booked_time":{"type":["string","null"],"format":"date","description":"Date the booking was made (`YYYY-MM-DD` or datetime). Required when `pl_status` is `booked`. Must be on or before `start_date`."},"pl_status":{"$ref":"#/components/schemas/V1CreateReservationsPostRequestBodyContentApplicationJsonSchemaReservationsItemsPlStatus","description":"Reservation status. Values are normalized (lowercase, spaces removed)."},"cancelled_time":{"type":["string","null"],"format":"date","description":"Cancellation date. Required when `pl_status` is `cancelled`. Ignored for other statuses."},"total_fees":{"type":["number","null"],"format":"double","description":"Total fees. Must be greater than or equal to `0` when provided."},"total_taxes":{"type":["number","null"],"format":"double","description":"Total taxes. Must be greater than or equal to `0` when provided."},"rental_revenue":{"type":["number","null"],"format":"double","description":"Rental revenue. Must be greater than `0` when provided on a `booked` reservation."},"ota_commission":{"type":["number","null"],"format":"double","description":"OTA commission. Must be greater than or equal to `0` when provided."},"host_payout":{"type":["number","null"],"format":"double","description":"Host payout. Must be greater than or equal to `0` when provided."},"booking_source":{"type":["string","null"],"description":"Booking channel. Mapped to `airbnb`, `vrbo`, `bcom`, `manual`, or `others` (unrecognized values become `others`). Stored on the reservation's booking info.\n"},"guest_count":{"type":["integer","null"],"description":"Number of guests. Must be greater than or equal to `0` when provided."},"guest_zipcode":{"type":["string","null"],"description":"Guest zip or postal code. Stored on the reservation's booking info."}},"required":["listing_id","pms_name","reservation_id","start_date","end_date","no_of_days","total_cost","currency","booked_time","pl_status","cancelled_time","total_fees","total_taxes","rental_revenue","ota_commission","host_payout","booking_source","guest_count","guest_zipcode"],"title":"V1CreateReservationsPostRequestBodyContentApplicationJsonSchemaReservationsItems"},"CreateReservationsResponseReservationsItems":{"type":"object","properties":{"reservation":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The reservation payload that was processed (may include a generated `reservation_id`)."},"success":{"type":"boolean"},"error":{"type":"string","description":"Present when `success` is `false`."}},"required":["reservation","success"],"title":"CreateReservationsResponseReservationsItems"},"CreateReservationsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` when at least one reservation succeeded. `false` when every row failed."},"total":{"type":"integer","description":"Number of reservation objects in the request."},"success_count":{"type":"integer","description":"Number of rows that were created or updated."},"failure_count":{"type":"integer","description":"Number of rows that failed validation or could not be saved."},"reservations":{"type":"array","items":{"$ref":"#/components/schemas/CreateReservationsResponseReservationsItems"},"description":"Per-row results in the same order as the request."}},"required":["success","total","success_count","failure_count","reservations"],"title":"CreateReservationsResponse"},"CreateReservationsRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"}},"title":"CreateReservationsRequestBadRequestError"},"CreateReservationsRequestUnauthorizedError":{"type":"object","properties":{"message":{"type":"string"}},"title":"CreateReservationsRequestUnauthorizedError"},"CreateReservationsRequestForbiddenError":{"type":"object","properties":{"error_code":{"type":"string"},"error":{"type":"string"}},"title":"CreateReservationsRequestForbiddenError"},"CreateReservationsRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateReservationsRequestInternalServerError"},"V1BookingsReportPostRequestBodyContentApplicationJsonSchemaDateFilters":{"type":"object","properties":{"min_booked_date":{"type":"string","format":"date","description":"Start of booked date range (inclusive, `YYYY-MM-DD`)."},"max_booked_date":{"type":"string","format":"date","description":"End of booked date range (inclusive, `YYYY-MM-DD`)."},"min_check_in_date":{"type":"string","format":"date","description":"Start of check-in date range (inclusive, `YYYY-MM-DD`)."},"max_check_in_date":{"type":"string","format":"date","description":"End of check-in date range (inclusive, `YYYY-MM-DD`)."}},"description":"Date range filters. Provide either booked date range or check-in date range (or both).","title":"V1BookingsReportPostRequestBodyContentApplicationJsonSchemaDateFilters"},"V1BookingsReportPostRequestBodyContentApplicationJsonSchemaFiltersListingsItems":{"type":"object","properties":{"listing_id":{"type":"string","description":"The listing ID."},"pms_name":{"type":"string","description":"PMS name for this listing."}},"required":["listing_id","pms_name"],"title":"V1BookingsReportPostRequestBodyContentApplicationJsonSchemaFiltersListingsItems"},"V1BookingsReportPostRequestBodyContentApplicationJsonSchemaFiltersBookingStatusItems":{"type":"string","enum":["booked","cancelled","blocked"],"title":"V1BookingsReportPostRequestBodyContentApplicationJsonSchemaFiltersBookingStatusItems"},"V1BookingsReportPostRequestBodyContentApplicationJsonSchemaFilters":{"type":"object","properties":{"pms":{"type":"string","description":"Filter by PMS/channel name."},"listings":{"type":"array","items":{"$ref":"#/components/schemas/V1BookingsReportPostRequestBodyContentApplicationJsonSchemaFiltersListingsItems"},"description":"Filter by specific listings. Each item must include `listing_id` and `pms_name`."},"tags":{"type":"string","description":"Comma-separated list of tag names to filter by."},"groups":{"type":"string","description":"Comma-separated list of group IDs to filter by."},"subgroups":{"type":"string","description":"Comma-separated list of subgroup IDs to filter by."},"cities":{"type":"string","description":"Comma-separated list of city names to filter by."},"brCount":{"type":"string","description":"Comma-separated list of bedroom counts to filter by."},"syncStatus":{"type":"string","description":"Filter by price sync status. Use `true` for sync ON, `false` for sync OFF."},"search_query":{"type":"string","description":"Free-text search across listing names, IDs, and cities."},"booking_status":{"type":"array","items":{"$ref":"#/components/schemas/V1BookingsReportPostRequestBodyContentApplicationJsonSchemaFiltersBookingStatusItems"},"description":"Booking statuses to include. Valid values: `booked`, `cancelled`, `blocked`. Defaults to `[\"booked\"]`."}},"description":"Listing and booking filters.","title":"V1BookingsReportPostRequestBodyContentApplicationJsonSchemaFilters"},"V1BookingsReportPostResponsesContentApplicationJsonSchemaDataReservationsItems":{"type":"object","properties":{"listing_id":{"type":"string"},"listing_name":{"type":"string"},"pms_name":{"type":"string"},"reservation_id":{"type":"string"},"check_in":{"type":"string","format":"date"},"check_out":{"type":"string","format":"date"},"booked_date":{"type":"string"},"no_of_days":{"type":"integer"},"rental_revenue":{"type":"number","format":"double"},"total_cost":{"type":"number","format":"double"},"currency":{"type":"string"},"booking_status":{"type":"string"},"booking_channel":{"type":"string"}},"title":"V1BookingsReportPostResponsesContentApplicationJsonSchemaDataReservationsItems"},"V1BookingsReportPostResponsesContentApplicationJsonSchemaDataPagination":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of matching rows."},"offset":{"type":"integer","description":"Current offset."},"limit":{"type":"integer","description":"Rows per page."},"has_more":{"type":"boolean","description":"Whether more pages exist."}},"title":"V1BookingsReportPostResponsesContentApplicationJsonSchemaDataPagination"},"V1BookingsReportPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"reservations":{"type":"array","items":{"$ref":"#/components/schemas/V1BookingsReportPostResponsesContentApplicationJsonSchemaDataReservationsItems"},"description":"Array of reservation rows matching the filters."},"pagination":{"$ref":"#/components/schemas/V1BookingsReportPostResponsesContentApplicationJsonSchemaDataPagination"}},"title":"V1BookingsReportPostResponsesContentApplicationJsonSchemaData"},"Bookings_Report_getBookingsReport_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/V1BookingsReportPostResponsesContentApplicationJsonSchemaData"}},"title":"Bookings Report_getBookingsReport_Response_200"},"GetBookingsReportRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"},"error_code":{"type":"string"}},"title":"GetBookingsReportRequestBadRequestError"},"GetBookingsReportRequestBadGatewayError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetBookingsReportRequestBadGatewayError"},"V1ReportBuilderTemplatesGetResponsesContentApplicationJsonSchemaTemplatesItems":{"type":"object","properties":{"templateId":{"type":"number","format":"double","description":"Unique identifier for the template."},"name":{"type":"string","description":"Template display name."},"description":{"type":"string","description":"Brief explanation of the report scope."},"createdByDisplayName":{"type":"string","description":"Creator identifier (\"PriceLabs\" for system defaults)."},"lastGeneratedDate":{"type":"string","description":"Timestamp of the last generation runtime."},"userId":{"type":"number","format":"double","description":"Owner's user ID (0 for system-wide templates)."}},"title":"V1ReportBuilderTemplatesGetResponsesContentApplicationJsonSchemaTemplatesItems"},"Report_Builder_getRBTemplates_Response_200":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/V1ReportBuilderTemplatesGetResponsesContentApplicationJsonSchemaTemplatesItems"},"description":"List of accessible template objects."}},"title":"Report Builder_getRBTemplates_Response_200"},"V1ReportBuilderDataPostResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["IN_PROGRESS"],"title":"V1ReportBuilderDataPostResponsesContentApplicationJsonSchemaStatus"},"Report_Builder_generateReportData_Response_200":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"$ref":"#/components/schemas/V1ReportBuilderDataPostResponsesContentApplicationJsonSchemaStatus"}},"title":"Report Builder_generateReportData_Response_200"},"GenerateReportDataRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GenerateReportDataRequestBadRequestError"},"GenerateReportDataRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GenerateReportDataRequestNotFoundError"},"GenerateReportDataRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"}},"title":"GenerateReportDataRequestInternalServerError"},"V1ReportBuilderPollPostResponsesContentApplicationJsonSchemaOneOf0Status":{"type":"string","enum":["IN_PROGRESS"],"title":"V1ReportBuilderPollPostResponsesContentApplicationJsonSchemaOneOf0Status"},"ReportBuilderPollReportDataResponse2000":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"$ref":"#/components/schemas/V1ReportBuilderPollPostResponsesContentApplicationJsonSchemaOneOf0Status"}},"description":"Report is still being generated — continue polling","title":"ReportBuilderPollReportDataResponse2000"},"V1ReportBuilderPollPostResponsesContentApplicationJsonSchemaOneOf1Status":{"type":"string","enum":["STATUS_NOT_FOUND"],"title":"V1ReportBuilderPollPostResponsesContentApplicationJsonSchemaOneOf1Status"},"ReportBuilderPollReportDataResponse2001":{"type":"object","properties":{"request_id":{"type":"string"},"status":{"$ref":"#/components/schemas/V1ReportBuilderPollPostResponsesContentApplicationJsonSchemaOneOf1Status"}},"description":"Request ID is invalid or expired — stop polling","title":"ReportBuilderPollReportDataResponse2001"},"V1ReportBuilderPollPostResponsesContentApplicationJsonSchemaOneOf2Data":{"type":"object","properties":{"report_data":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"report_currency":{"type":"string"}},"title":"V1ReportBuilderPollPostResponsesContentApplicationJsonSchemaOneOf2Data"},"ReportBuilderPollReportDataResponse2002":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/V1ReportBuilderPollPostResponsesContentApplicationJsonSchemaOneOf2Data"}},"description":"Report is ready — stop polling. No `status` field is present.","title":"ReportBuilderPollReportDataResponse2002"},"Report_Builder_pollReportData_Response_200":{"oneOf":[{"$ref":"#/components/schemas/ReportBuilderPollReportDataResponse2000"},{"$ref":"#/components/schemas/ReportBuilderPollReportDataResponse2001"},{"$ref":"#/components/schemas/ReportBuilderPollReportDataResponse2002"}],"title":"Report Builder_pollReportData_Response_200"},"PollReportDataRequestForbiddenError":{"type":"object","properties":{"error":{"type":"string"}},"title":"PollReportDataRequestForbiddenError"},"PollReportDataRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"}},"title":"PollReportDataRequestInternalServerError"},"V1NudgesAvailableGetParametersNudgeType":{"type":"string","enum":["base_price","min_price"],"title":"V1NudgesAvailableGetParametersNudgeType"},"V1NudgesAvailableGetResponsesContentApplicationJsonSchemaNudgesItemsNudgeType":{"type":"string","enum":["base_price","min_price"],"title":"V1NudgesAvailableGetResponsesContentApplicationJsonSchemaNudgesItemsNudgeType"},"V1NudgesAvailableGetResponsesContentApplicationJsonSchemaNudgesItems":{"type":"object","properties":{"listing_id":{"type":"string"},"pms_name":{"type":"string"},"listing_name":{"type":"string"},"nudge_type":{"$ref":"#/components/schemas/V1NudgesAvailableGetResponsesContentApplicationJsonSchemaNudgesItemsNudgeType"},"nudge_id":{"type":"string","format":"uuid"},"current_value":{"type":"integer","description":"Current value of the price field on the listing"},"suggested_value":{"type":"integer","description":"Nudge-recommended value"},"direction":{"type":"string","description":"Whether the nudge suggests an increase or decrease"},"reason":{"type":"string","description":"Explanation for the recommendation"},"expiration":{"type":"string","format":"date-time","description":"ISO 8601 timestamp after which the nudge expires"},"status":{"type":"string"}},"title":"V1NudgesAvailableGetResponsesContentApplicationJsonSchemaNudgesItems"},"Nudges_available_Response_200":{"type":"object","properties":{"nudges":{"type":"array","items":{"$ref":"#/components/schemas/V1NudgesAvailableGetResponsesContentApplicationJsonSchemaNudgesItems"}}},"title":"Nudges_available_Response_200"},"NudgesAvailableRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"NudgesAvailableRequestBadRequestError"},"V1NudgesAcceptPostResponsesContentApplicationJsonSchemaNudgeType":{"type":"string","enum":["base_price","min_price"],"title":"V1NudgesAcceptPostResponsesContentApplicationJsonSchemaNudgeType"},"Nudges_accept_Response_200":{"type":"object","properties":{"nudge_id":{"type":"string","format":"uuid"},"listing_id":{"type":"string"},"pms_name":{"type":"string"},"nudge_type":{"$ref":"#/components/schemas/V1NudgesAcceptPostResponsesContentApplicationJsonSchemaNudgeType"},"status":{"type":"string"},"applied_value":{"type":"integer","description":"The price value that was applied to the listing"},"update_children":{"type":"boolean"}},"title":"Nudges_accept_Response_200"},"NudgesAcceptRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"NudgesAcceptRequestBadRequestError"},"NudgesAcceptRequestForbiddenError":{"type":"object","properties":{"error_code":{"type":"string"},"error":{"type":"string"}},"title":"NudgesAcceptRequestForbiddenError"},"NudgesAcceptRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"}},"title":"NudgesAcceptRequestNotFoundError"},"NudgesAcceptRequestConflictError":{"type":"object","properties":{"error":{"type":"string"}},"title":"NudgesAcceptRequestConflictError"},"NudgesAcceptRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"}},"title":"NudgesAcceptRequestInternalServerError"},"V1ActionsGetParametersMode":{"type":"string","enum":["visible","all","hidden"],"default":"visible","title":"V1ActionsGetParametersMode"},"V1ActionsGetResponsesContentApplicationJsonSchemaItemsListingDetails":{"type":"object","properties":{"listing_id":{"type":"string"},"pms":{"type":"string"},"pms_display_name":{"type":["string","null"],"description":"Human-readable PMS name (e.g. \"Airbnb\" for `airbnb`)."},"listing_name":{"type":["string","null"]}},"title":"V1ActionsGetResponsesContentApplicationJsonSchemaItemsListingDetails"},"V1ActionsGetResponsesContentApplicationJsonSchemaItemsActionsItemsActionType":{"type":"string","enum":["base_price_alert","min_price_alert","base_price_missing","location_missing","bedroom_count_missing","oba_turned_off","last_minute_conservative_vs_market","minimum_stay_off_vs_market","many_unbookable_dates","many_blocked_dates"],"title":"V1ActionsGetResponsesContentApplicationJsonSchemaItemsActionsItemsActionType"},"V1ActionsGetResponsesContentApplicationJsonSchemaItemsActionsItems":{"type":"object","properties":{"action_type":{"$ref":"#/components/schemas/V1ActionsGetResponsesContentApplicationJsonSchemaItemsActionsItemsActionType"},"title":{"type":"string","description":"Human-readable name of the action."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Action-specific detail. Empty for actions that only flag a missing or disabled setting. Price recommendations carry `nudge_id`, `current`, `recommended`, `direction` and `expiration`; minimum stay and last minute actions carry `current` and `recommended`; blocked and unbookable dates carry `count`, `threshold` and `date_ranges`. Every field for the action's family is always present; those with no value are `null`."}},"title":"V1ActionsGetResponsesContentApplicationJsonSchemaItemsActionsItems"},"V1ActionsGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"listing_details":{"$ref":"#/components/schemas/V1ActionsGetResponsesContentApplicationJsonSchemaItemsListingDetails"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/V1ActionsGetResponsesContentApplicationJsonSchemaItemsActionsItems"},"description":"Ordered most important first."}},"title":"V1ActionsGetResponsesContentApplicationJsonSchemaItems"},"ListActionsRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ListActionsRequestBadRequestError"},"ListActionsRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ListActionsRequestNotFoundError"},"CapiSeasonalitySeasonalityType":{"type":"string","enum":["no_seasonality","conservative","moderately_conservative","recommended","moderately_aggressive","aggressive"],"description":"Required when the toggle is on. UI label in brackets. Each value follows the market's\nseasonal demand curve more closely than the one above it.\n- `no_seasonality` (No Seasonality) — flattens the seasonal curve entirely.\n- `conservative` (Conservative)\n- `moderately_conservative` (Moderately Conservative)\n- `recommended` (Recommended) — PriceLabs' default.\n- `moderately_aggressive` (Moderately Aggressive)\n- `aggressive` (Aggressive) — follows the curve most closely.\n","title":"CapiSeasonalitySeasonalityType"},"CapiSeasonality":{"type":"object","properties":{"seasonality_customization_on":{"type":"boolean"},"seasonality_type":{"$ref":"#/components/schemas/CapiSeasonalitySeasonalityType","description":"Required when the toggle is on. UI label in brackets. Each value follows the market's\nseasonal demand curve more closely than the one above it.\n- `no_seasonality` (No Seasonality) — flattens the seasonal curve entirely.\n- `conservative` (Conservative)\n- `moderately_conservative` (Moderately Conservative)\n- `recommended` (Recommended) — PriceLabs' default.\n- `moderately_aggressive` (Moderately Aggressive)\n- `aggressive` (Aggressive) — follows the curve most closely.\n"}},"required":["seasonality_customization_on"],"description":"`seasonality` customization — how strongly prices follow the market's seasonal demand\ncurve. (Spec key: `seasonality`.) Turning the toggle off keeps the stored value (only the\ntoggle flips).\n","title":"CapiSeasonality"},"CapiLastMinutePricesLastMinFactorType":{"type":"string","enum":["none","recommended","conservative","aggressive","linear","linear_gradual","fixed"],"description":"Required when the toggle is on. UI label in brackets.\n- `none` (No last minute adjustment) — suppresses the adjustment, unlike switching the toggle off.\n- `recommended` (Market Driven - Balanced) — discount derived from live market data, tapering to 0% by the end of the window.\n- `conservative` (Market Driven - Conservative) — same mechanism, smaller discount.\n- `aggressive` (Market Driven - Aggressive) — same mechanism, larger discount.\n- `linear` (% - Flat) — one flat percentage across the whole window.\n- `linear_gradual` (% - Gradual) — ramps from 0% at `last_min_factor_dfd` days out to the full value on the day of check-in.\n- `fixed` (Fixed) — a flat nightly price, not a percentage. Listing level only.\nEvery type is a single rule: there is no way to set different percentages at different\ndays out within one customization.\n","title":"CapiLastMinutePricesLastMinFactorType"},"CapiLastMinutePrices":{"type":"object","properties":{"last_min_factor_on":{"type":"boolean"},"last_min_factor_type":{"$ref":"#/components/schemas/CapiLastMinutePricesLastMinFactorType","description":"Required when the toggle is on. UI label in brackets.\n- `none` (No last minute adjustment) — suppresses the adjustment, unlike switching the toggle off.\n- `recommended` (Market Driven - Balanced) — discount derived from live market data, tapering to 0% by the end of the window.\n- `conservative` (Market Driven - Conservative) — same mechanism, smaller discount.\n- `aggressive` (Market Driven - Aggressive) — same mechanism, larger discount.\n- `linear` (% - Flat) — one flat percentage across the whole window.\n- `linear_gradual` (% - Gradual) — ramps from 0% at `last_min_factor_dfd` days out to the full value on the day of check-in.\n- `fixed` (Fixed) — a flat nightly price, not a percentage. Listing level only.\nEvery type is a single rule: there is no way to set different percentages at different\ndays out within one customization.\n"},"last_min_factor_value":{"type":"number","format":"double","description":"Signed adjustment. linear/linear_gradual: percentage, discount magnitude 0-75 /\npremium magnitude 0-500. fixed: flat price. Required for linear/linear_gradual/fixed.\n"},"last_min_factor_dfd":{"type":"integer","minimum":1,"maximum":90,"description":"Days from check-in the adjustment starts (1-90). Required for linear/linear_gradual/fixed."}},"required":["last_min_factor_on"],"description":"`last_minute_prices` customization — adjust prices as check-in approaches. (Spec key:\n`last_minute_prices`.) Field requirements depend on `last_min_factor_type`:\n- `none`, `recommended`, `conservative`, `aggressive`: only the type — value/dfd are\n  auto-filled (anything sent with them is ignored).\n- `linear`, `linear_gradual`, `fixed`: `last_min_factor_value` and `last_min_factor_dfd`\n  are required.\nThe value is SIGNED — negative = discount, positive = premium (e.g. -15 = up to 15% off).\nFor `fixed` it is the flat nightly price. `fixed` is accepted at listing level only and is\nrejected at group and account level, matching the dashboard, which offers it for a single\nlisting. The value must be at least 20% of the listing's base price, or at least 15 when the\nlisting has no base price set.\nTurning the toggle off resets the stored configuration (type linear / value 0) —\nre-enabling later requires sending the full configuration again. Switching it off does NOT\nmean no last-minute adjustment: the algorithm's own market-driven discount takes over. Send\n`last_min_factor_type: none` with the toggle ON to suppress last-minute pricing entirely.\n","title":"CapiLastMinutePrices"},"CapiDayOfWeekAdjustment":{"type":"object","properties":{"dow_factor_on":{"type":"boolean"},"dow_factor_value_mon":{"type":"integer"},"dow_factor_value_tue":{"type":"integer"},"dow_factor_value_wed":{"type":"integer"},"dow_factor_value_thu":{"type":"integer"},"dow_factor_value_fri":{"type":"integer"},"dow_factor_value_sat":{"type":"integer"},"dow_factor_value_sun":{"type":"integer"}},"required":["dow_factor_on"],"description":"`day_of_week_adjustment` customization — a signed percentage adjustment per weekday\n(negative = discount, positive = premium; each between -75 and 1000). Days omitted from\nthe request default to 0 (no adjustment that day); at least one day must be non-empty.\nTurning the toggle off keeps the stored day values (only the toggle flips).\n","title":"CapiDayOfWeekAdjustment"},"CapiFarOutPremiumFarOutPremiumType":{"type":"string","enum":["none","recommended","conservative","aggressive","linear","fix"],"description":"Required when the toggle is on. UI label in brackets. Note this enum uses `fix`, not\n`fixed` as `last_min_factor_type` does, and has no `linear_gradual`.\n- `none` (No Far Out Premium) — suppresses the adjustment, unlike switching the toggle off.\n- `recommended` (Market Driven - Balanced) — premium derived from live market data.\n- `conservative` (Market Driven - Conservative) — same mechanism, smaller premium.\n- `aggressive` (Market Driven - Aggressive) — same mechanism, larger premium.\n- `linear` (% Gradual) — ramps up in `far_out_premium_step` day steps from `far_out_premium_start`.\n- `fix` (% Flat) — one flat percentage from `far_out_premium_start` onwards.\n","title":"CapiFarOutPremiumFarOutPremiumType"},"CapiFarOutPremium":{"type":"object","properties":{"far_out_premium_on":{"type":"boolean"},"far_out_premium_type":{"$ref":"#/components/schemas/CapiFarOutPremiumFarOutPremiumType","description":"Required when the toggle is on. UI label in brackets. Note this enum uses `fix`, not\n`fixed` as `last_min_factor_type` does, and has no `linear_gradual`.\n- `none` (No Far Out Premium) — suppresses the adjustment, unlike switching the toggle off.\n- `recommended` (Market Driven - Balanced) — premium derived from live market data.\n- `conservative` (Market Driven - Conservative) — same mechanism, smaller premium.\n- `aggressive` (Market Driven - Aggressive) — same mechanism, larger premium.\n- `linear` (% Gradual) — ramps up in `far_out_premium_step` day steps from `far_out_premium_start`.\n- `fix` (% Flat) — one flat percentage from `far_out_premium_start` onwards.\n"},"far_out_premium_value":{"type":"integer","description":"Signed percentage (-30..500). Required for linear/fix."},"far_out_premium_start":{"type":"integer","minimum":1,"maximum":999,"description":"Days from today where the adjustment reaches its maximum (1-999). Required for linear/fix."},"far_out_premium_step":{"type":"integer","minimum":1,"maximum":999,"description":"Step size in days (1-999). Required for linear; ignored for fix (always 1)."}},"required":["far_out_premium_on"],"description":"`far_out_premium` customization — adjust prices for far-out dates. Field requirements\ndepend on `far_out_premium_type`:\n- `none`, `recommended`, `conservative`, `aggressive`: only the type — other fields are\n  auto-filled (anything sent with them is ignored).\n- `linear`: `far_out_premium_value`, `far_out_premium_start` and `far_out_premium_step`\n  are required.\n- `fix`: `far_out_premium_value` and `far_out_premium_start` are required (`step` is\n  fixed to 1). A `fix` configuration is stored as `linear` with step 1, so it reads back\n  as `linear` — posting that back is equivalent.\nThe value is SIGNED — negative = discount (down to -30), positive = premium (up to 500).\nTurning the toggle off resets the stored configuration to the 'none' state\n(value 0 / start 999 / step 1) — re-enabling later requires sending the full\nconfiguration again. Switching it off does NOT mean no far-out adjustment: the algorithm's\nown market-driven premium takes over. Send `far_out_premium_type: none` with the toggle ON\nto suppress far-out pricing entirely.\n","title":"CapiFarOutPremium"},"CapiDemandFactorToneDemandFactor":{"type":"string","enum":["conservative","moderately_conservative","recommended","moderately_aggressive","aggressive","no demand factor"],"description":"Required when the toggle is on. UI label in brackets. Each value moves prices further\nin response to a change in demand than the one above it. Note the \"off\" member here is\nthe space-separated `no demand factor`, not `none` as the last-minute and far-out\nenums use.\n- `no demand factor` (No demand factor) — prices stop reacting to demand.\n- `conservative` (Conservative)\n- `moderately_conservative` (Moderately Conservative)\n- `recommended` (Recommended) — PriceLabs' default.\n- `moderately_aggressive` (Moderately Aggressive)\n- `aggressive` (Aggressive) — moves prices the furthest for the same change in demand.\n","title":"CapiDemandFactorToneDemandFactor"},"CapiDemandFactorHotelCompsetType":{"type":"string","enum":["recommended","custom"],"description":"Hotel compset mode (feature-gated). UI label in brackets.\n- `recommended` (PriceLabs Default) — PriceLabs picks the hotel comp set.\n- `custom` (Selected in Hotel Data tab) — uses the comp set chosen there.\nfully_hotel + recommended is not a valid combination.\n","title":"CapiDemandFactorHotelCompsetType"},"CapiDemandFactorHotelWt":{"type":"string","enum":["fully_str","mostly_str","balance","mostly_hotel","fully_hotel"],"description":"Hotel vs short-term-rental weighting (feature-gated). UI label in brackets. Each value\nweights the comp set further toward hotels and away from short-term rentals than the\none above it.\n- `fully_str` (Fully Short-Term Rental)\n- `mostly_str` (Mostly Short-Term Rental)\n- `balance` (Balance)\n- `mostly_hotel` (Mostly Hotel)\n- `fully_hotel` (Fully Hotel)\n","title":"CapiDemandFactorHotelWt"},"CapiDemandFactor":{"type":"object","properties":{"tone_demand_factor_on":{"type":"boolean"},"tone_demand_factor":{"$ref":"#/components/schemas/CapiDemandFactorToneDemandFactor","description":"Required when the toggle is on. UI label in brackets. Each value moves prices further\nin response to a change in demand than the one above it. Note the \"off\" member here is\nthe space-separated `no demand factor`, not `none` as the last-minute and far-out\nenums use.\n- `no demand factor` (No demand factor) — prices stop reacting to demand.\n- `conservative` (Conservative)\n- `moderately_conservative` (Moderately Conservative)\n- `recommended` (Recommended) — PriceLabs' default.\n- `moderately_aggressive` (Moderately Aggressive)\n- `aggressive` (Aggressive) — moves prices the furthest for the same change in demand.\n"},"hotel_compset_type":{"$ref":"#/components/schemas/CapiDemandFactorHotelCompsetType","description":"Hotel compset mode (feature-gated). UI label in brackets.\n- `recommended` (PriceLabs Default) — PriceLabs picks the hotel comp set.\n- `custom` (Selected in Hotel Data tab) — uses the comp set chosen there.\nfully_hotel + recommended is not a valid combination.\n"},"hotel_wt":{"$ref":"#/components/schemas/CapiDemandFactorHotelWt","description":"Hotel vs short-term-rental weighting (feature-gated). UI label in brackets. Each value\nweights the comp set further toward hotels and away from short-term rentals than the\none above it.\n- `fully_str` (Fully Short-Term Rental)\n- `mostly_str` (Mostly Short-Term Rental)\n- `balance` (Balance)\n- `mostly_hotel` (Mostly Hotel)\n- `fully_hotel` (Fully Hotel)\n"}},"required":["tone_demand_factor_on"],"description":"`demand_factor` customization — how strongly prices react to market demand.\n`hotel_compset_type` and `hotel_wt` require the hotel compset & weights feature\n(admin-granted): without it, writes including them are rejected\n(`ERR-FEATURE-NOT-ENABLED`) and reads omit them. With the feature, send the hotel fields\nas a pair or not at all: both -> hotel config updated; neither -> tone-only write (stored\nhotel config untouched); exactly one -> validation error. Turning the toggle off clears\nthe hotel fields.\n","title":"CapiDemandFactor"},"CapiCustomSeasonalProfileCustomSeasonalProfilePriceType":{"type":"string","enum":["percentage","fixed"],"description":"How repeating-season prices are interpreted. Required when `seasons` is non-empty.\n- `percentage` — the season's prices are a signed adjustment to the base price.\n- `fixed` — the season's prices are absolute currency amounts.\n","title":"CapiCustomSeasonalProfileCustomSeasonalProfilePriceType"},"CapiCspSeason":{"type":"object","properties":{"season_name":{"type":"string","description":"Display name. Must not contain `< > & \" ' /`."},"start_month":{"type":"string","description":"Month the season starts, \"1\"-\"12\"."},"start_day":{"type":"string","description":"Day of month the season starts, \"1\"-\"31\"."},"end_month":{"type":"string"},"end_day":{"type":"string"},"lowest_price":{"type":["integer","null"],"description":"Season minimum price. Integer only (numeric strings coerced). `percentage`: signed\npercent adjustment, -75..599. `fixed`: absolute price, 0..99999999. Must be <=\n`highest_price` when both are set.\n"},"base_price":{"type":["integer","null"],"description":"Season base price (same rules as `lowest_price`)."},"highest_price":{"type":["integer","null"],"description":"Season maximum price (same rules as `lowest_price`)."},"minstay_profile_id":{"type":["integer","null"],"description":"Min-stay profile to apply during the season. Must belong to the account. Requires a\nPMS that supports min-stay updates — at group level, at least one of the account's\nconnected PMSes must support it. (Listing/group level only.) Use\n`GET /v1/customization_profiles` to look up the exact profile id.\n"},"pricing_profile_id":{"type":["integer","null"],"description":"Pricing profile to apply during the season. Must belong to the account. Requires the\npricing-profiles feature. (Listing/group level only.) Use\n`GET /v1/customization_profiles` to look up the exact profile id.\n"},"checkincheckout_profile_id":{"type":["integer","null"],"description":"Check-in/check-out profile to apply during the season. Must belong to the account.\nRequires a PMS that supports check-in/check-out updates — at group level, at least\none of the account's connected PMSes must support it. (Listing/group level only.)\nUse `GET /v1/customization_profiles` to look up the exact profile id.\n"}},"required":["season_name","start_month","start_day","end_month","end_day"],"description":"A season that repeats every year. Dates are month/day only — validity is checked against\na leap-year calendar, so Feb 29 is allowed. Start must be on or before end (a season\ncannot wrap across the year boundary; split it into two seasons instead). Seasons in the\nsame array must not overlap each other; overlapping a season in the OTHER array is fine.\nPrice fields and profile ids are optional — send `null` (or omit) to leave that aspect\nunset for the season. Numeric strings are accepted and coerced (e.g. `\"05\"` -> month 5,\n`\"120\"` -> 120).\n","title":"CapiCspSeason"},"CapiCustomSeasonalProfileCustomSeasonalProfilePriceTypeNonRepeating":{"type":"string","enum":["percentage","fixed"],"description":"Required when `non_repeating_seasons` is non-empty.","title":"CapiCustomSeasonalProfileCustomSeasonalProfilePriceTypeNonRepeating"},"CapiCspNonRepeatingSeason":{"type":"object","properties":{"season_name":{"type":"string","description":"Display name. Must not contain `< > & \" ' /`."},"start_month":{"type":"string","description":"Month the season starts, \"1\"-\"12\"."},"start_day":{"type":"string","description":"Day of month the season starts, \"1\"-\"31\"."},"end_month":{"type":"string"},"end_day":{"type":"string"},"lowest_price":{"type":["integer","null"],"description":"Season minimum price. Integer only (numeric strings coerced). `percentage`: signed\npercent adjustment, -75..599. `fixed`: absolute price, 0..99999999. Must be <=\n`highest_price` when both are set.\n"},"base_price":{"type":["integer","null"],"description":"Season base price (same rules as `lowest_price`)."},"highest_price":{"type":["integer","null"],"description":"Season maximum price (same rules as `lowest_price`)."},"minstay_profile_id":{"type":["integer","null"],"description":"Min-stay profile to apply during the season. Must belong to the account. Requires a\nPMS that supports min-stay updates — at group level, at least one of the account's\nconnected PMSes must support it. (Listing/group level only.) Use\n`GET /v1/customization_profiles` to look up the exact profile id.\n"},"pricing_profile_id":{"type":["integer","null"],"description":"Pricing profile to apply during the season. Must belong to the account. Requires the\npricing-profiles feature. (Listing/group level only.) Use\n`GET /v1/customization_profiles` to look up the exact profile id.\n"},"checkincheckout_profile_id":{"type":["integer","null"],"description":"Check-in/check-out profile to apply during the season. Must belong to the account.\nRequires a PMS that supports check-in/check-out updates — at group level, at least\none of the account's connected PMSes must support it. (Listing/group level only.)\nUse `GET /v1/customization_profiles` to look up the exact profile id.\n"},"start_year":{"type":"string","description":"Year the season starts (non-repeating seasons carry real years)."},"end_year":{"type":"string"}},"required":["season_name","start_month","start_day","end_month","end_day","start_year","end_year"],"description":"A one-off season for specific calendar dates (real years). Same fields and rules as a\nrepeating season, plus required `start_year`/`end_year`. Requires the non-repeating\nseasons feature on the account.\n","title":"CapiCspNonRepeatingSeason"},"CapiCustomSeasonalProfileCustomSeasonalProfileInheritBaseprice":{"type":"string","enum":["1","0"],"description":"Inherit season base prices from the group/account level (feature-gated;\nlisting/group level only). Writes accept `\"1\"`/`\"0\"` or `true`/`false`;\nreads return `\"1\"`/`\"0\"`.\n","title":"CapiCustomSeasonalProfileCustomSeasonalProfileInheritBaseprice"},"CapiCustomSeasonalProfileCustomSeasonalProfileInheritMinstay":{"type":"string","enum":["1","0"],"description":"Inherit season min-stay profiles from the group/account level (feature-gated; listing/group level only; same format as `inherit_baseprice`).","title":"CapiCustomSeasonalProfileCustomSeasonalProfileInheritMinstay"},"CapiCustomSeasonalProfileCustomSeasonalProfileInheritCico":{"type":"string","enum":["1","0"],"description":"Inherit season check-in/check-out profiles from the group/account level (feature-gated; listing/group level only; same format as `inherit_baseprice`).","title":"CapiCustomSeasonalProfileCustomSeasonalProfileInheritCico"},"CapiCustomSeasonalProfileCustomSeasonalProfileInheritPriceprofile":{"type":"string","enum":["1","0"],"description":"Inherit season pricing profiles from the group/account level (feature-gated; listing/group level only; same format as `inherit_baseprice`).","title":"CapiCustomSeasonalProfileCustomSeasonalProfileInheritPriceprofile"},"CapiCustomSeasonalProfileCustomSeasonalProfile":{"type":"object","properties":{"price_type":{"$ref":"#/components/schemas/CapiCustomSeasonalProfileCustomSeasonalProfilePriceType","description":"How repeating-season prices are interpreted. Required when `seasons` is non-empty.\n- `percentage` — the season's prices are a signed adjustment to the base price.\n- `fixed` — the season's prices are absolute currency amounts.\n"},"seasons":{"type":"array","items":{"$ref":"#/components/schemas/CapiCspSeason"},"description":"Seasons that repeat every year."},"price_type_non_repeating":{"$ref":"#/components/schemas/CapiCustomSeasonalProfileCustomSeasonalProfilePriceTypeNonRepeating","description":"Required when `non_repeating_seasons` is non-empty."},"non_repeating_seasons":{"type":"array","items":{"$ref":"#/components/schemas/CapiCspNonRepeatingSeason"},"description":"One-off seasons for specific calendar dates (feature-gated)."},"inherit_baseprice":{"$ref":"#/components/schemas/CapiCustomSeasonalProfileCustomSeasonalProfileInheritBaseprice","description":"Inherit season base prices from the group/account level (feature-gated;\nlisting/group level only). Writes accept `\"1\"`/`\"0\"` or `true`/`false`;\nreads return `\"1\"`/`\"0\"`.\n"},"inherit_minstay":{"$ref":"#/components/schemas/CapiCustomSeasonalProfileCustomSeasonalProfileInheritMinstay","description":"Inherit season min-stay profiles from the group/account level (feature-gated; listing/group level only; same format as `inherit_baseprice`)."},"inherit_cico":{"$ref":"#/components/schemas/CapiCustomSeasonalProfileCustomSeasonalProfileInheritCico","description":"Inherit season check-in/check-out profiles from the group/account level (feature-gated; listing/group level only; same format as `inherit_baseprice`)."},"inherit_priceprofile":{"$ref":"#/components/schemas/CapiCustomSeasonalProfileCustomSeasonalProfileInheritPriceprofile","description":"Inherit season pricing profiles from the group/account level (feature-gated; listing/group level only; same format as `inherit_baseprice`)."}},"description":"Required when the toggle is on.","title":"CapiCustomSeasonalProfileCustomSeasonalProfile"},"CapiCustomSeasonalProfile":{"type":"object","properties":{"custom_seasonal_profile_on":{"type":"boolean"},"custom_seasonal_profile":{"$ref":"#/components/schemas/CapiCustomSeasonalProfileCustomSeasonalProfile","description":"Required when the toggle is on."}},"required":["custom_seasonal_profile_on"],"description":"`custom_seasonal_profile` customization — define seasons with their own price settings\nand (optionally) min-stay / pricing / check-in-check-out profiles. (Spec key:\n`custom_seasonal_profile`.)\n\nStructure: a toggle plus a `custom_seasonal_profile` object holding two season arrays —\n`seasons` (repeat every year) and `non_repeating_seasons` (specific calendar years).\nEither array may be empty, but not both. `price_type` is required when `seasons` is\nnon-empty and applies to all repeating seasons; `price_type_non_repeating` likewise for\n`non_repeating_seasons`.\n\nWrite semantics: turning the toggle OFF touches only the toggle (the stored seasons are\npreserved and read back with `toggled_on=false`). A toggle-ON write REPLACES the entire\nstored configuration — always send the full set of seasons, not a delta.\n\nLevel differences: at account level only `price_type: percentage` is allowed, profile\nids cannot be set, and `inherit_*` flags are rejected (no parent level to inherit from).\n\nFeature-gated parts (rejected as validation errors if the account lacks the feature):\n`non_repeating_seasons` and the `inherit_*` flags are admin-granted features;\n`pricing_profile_id` requires the pricing-profiles feature; `minstay_profile_id` /\n`checkincheckout_profile_id` require a PMS that supports those updates.\n\nProfile ids: seasons can reference min-stay / pricing / check-in-check-out profiles by\nid. Use the discovery endpoint `GET /v1/customization_profiles` to get the exact profile\nids on your account — the ids it returns are exactly the set these writes accept.\n","title":"CapiCustomSeasonalProfile"},"CapiOccupancyBasedAdjustmentRecommendedType":{"type":"string","enum":["recommended"],"title":"CapiOccupancyBasedAdjustmentRecommendedType"},"CapiOccupancyBasedAdjustmentRecommended":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/CapiOccupancyBasedAdjustmentRecommendedType"}},"required":["type"],"description":"Recommended (market-driven) OBA mode. Only `type: recommended` is accepted — no other\nfields on this object.\n","title":"CapiOccupancyBasedAdjustmentRecommended"},"CapiOccupancyBasedAdjustmentFactor":{"type":"object","properties":{"occupancy":{"type":"integer","minimum":0,"maximum":100},"adjustment":{"type":"integer","minimum":-100,"maximum":500}},"required":["occupancy","adjustment"],"description":"One occupancy → adjustment pair inside a custom OBA segment. `occupancy` is an integer\npercent (0–100). `adjustment` is a signed percentage (−100..500): negative = discount,\npositive = premium (e.g. −15 = 15% off at that occupancy).\n","title":"CapiOccupancyBasedAdjustmentFactor"},"CapiOccupancyBasedAdjustmentSegment":{"type":"object","properties":{"start_day":{"type":"integer","minimum":0,"maximum":999},"end_day":{"type":"integer","minimum":0,"maximum":999},"factors":{"type":"array","items":{"$ref":"#/components/schemas/CapiOccupancyBasedAdjustmentFactor"}}},"required":["start_day","end_day","factors"],"description":"One days-from-check-in window with its occupancy factors. `start_day` and `end_day` are\nintegers 0–999 (days from check-in). `factors` must be a non-empty array.\n","title":"CapiOccupancyBasedAdjustmentSegment"},"CapiOccupancyBasedAdjustmentOccupancyBasedDiscounts1":{"type":"array","items":{"$ref":"#/components/schemas/CapiOccupancyBasedAdjustmentSegment"},"title":"CapiOccupancyBasedAdjustmentOccupancyBasedDiscounts1"},"CapiOccupancyBasedAdjustmentOccupancyBasedDiscounts":{"oneOf":[{"$ref":"#/components/schemas/CapiOccupancyBasedAdjustmentRecommended"},{"$ref":"#/components/schemas/CapiOccupancyBasedAdjustmentOccupancyBasedDiscounts1"}],"description":"Required for recommended and custom modes (when the toggle is on and\n`oba_profile_id` is omitted). Either `{ \"type\": \"recommended\" }` or a non-empty\narray of segments.\n","title":"CapiOccupancyBasedAdjustmentOccupancyBasedDiscounts"},"CapiOccupancyBasedAdjustment":{"type":"object","properties":{"occupancy_based_discounts_on":{"type":"boolean"},"occupancy_based_discounts":{"$ref":"#/components/schemas/CapiOccupancyBasedAdjustmentOccupancyBasedDiscounts","description":"Required for recommended and custom modes (when the toggle is on and\n`oba_profile_id` is omitted). Either `{ \"type\": \"recommended\" }` or a non-empty\narray of segments.\n"},"oba_profile_id":{"type":"integer","minimum":1,"description":"Required for saved mode (when the toggle is on and `occupancy_based_discounts` is\nomitted). Positive integer id of an account OBA profile. Use\n`GET /v1/customization_profiles?profile_type=oba` to look up the exact id.\n"}},"required":["occupancy_based_discounts_on"],"description":"`occupancy_based_adjustment` customization — adjust prices based on how full the listing\n(or portfolio) is.\n\nWhen the toggle is **off**, send only `{ occupancy_based_discounts_on: false }`.\n\nWhen the toggle is **on**, exactly one of these modes is required — toggle-on alone is\nrejected:\n- **Recommended** — `occupancy_based_discounts: { \"type\": \"recommended\" }` (market-driven).\n- **Saved** — `oba_profile_id` pointing at an account OBA profile (use\n  `GET /v1/customization_profiles?profile_type=oba` to discover ids). Do not also send\n  `occupancy_based_discounts`.\n- **Custom** — `occupancy_based_discounts` as a non-empty array of segments, each with\n  `start_day`, `end_day`, and `factors: [{ occupancy, adjustment }, ...]`.\n\nTo apply no occupancy-based adjustment (PriceLabs will not apply any occupancy-based\ndiscount or premium), use this payload:\n\n```\n{\n  \"occupancy_based_discounts_on\": true,\n  \"occupancy_based_discounts\": [\n    {\n      \"start_day\": 0,\n      \"end_day\": 15,\n      \"factors\": [{ \"occupancy\": 10, \"adjustment\": 0 }]\n    }\n  ]\n}\n```\n\n`occupancy_based_discounts` and `oba_profile_id` cannot both be set.\n","title":"CapiOccupancyBasedAdjustment"},"CapiBookingFactorBookingFactorValueSelectOption":{"type":"string","enum":["default","none"],"description":"Required when the toggle is on.\n- `default` — PriceLabs default booking-recency discount.\n- `none` — no booking-recency discount.\n","title":"CapiBookingFactorBookingFactorValueSelectOption"},"CapiBookingFactor":{"type":"object","properties":{"booking_factor_on":{"type":"boolean"},"booking_factor_value_select_option":{"$ref":"#/components/schemas/CapiBookingFactorBookingFactorValueSelectOption","description":"Required when the toggle is on.\n- `default` — PriceLabs default booking-recency discount.\n- `none` — no booking-recency discount.\n"}},"required":["booking_factor_on"],"description":"`booking_factor` customization — booking recency factor. When the toggle is **off**,\nsend only `{ booking_factor_on: false }`. When **on**, `booking_factor_value_select_option`\nis required and accepts `default` or `none`.\n","title":"CapiBookingFactor"},"CapiExtraPersonFeeListingExtraPersonFeeType":{"type":"string","enum":["fixed","percent"],"description":"Required when the toggle is on. `fixed` (currency amount) or `percent`.","title":"CapiExtraPersonFeeListingExtraPersonFeeType"},"CapiExtraPersonFee":{"type":"object","properties":{"update_listing_extra_person_on":{"type":"boolean"},"listing_extra_person_fee_type":{"$ref":"#/components/schemas/CapiExtraPersonFeeListingExtraPersonFeeType","description":"Required when the toggle is on. `fixed` (currency amount) or `percent`."},"listing_extra_person_fee":{"type":"integer","description":"Required when the toggle is on. Fee amount — for `percent`, 0–500; for `fixed`, a\ncurrency amount.\n"},"listing_extra_person_fee_trigger":{"type":"integer","minimum":1,"description":"Required when the toggle is on. Guest count after which the fee applies."}},"required":["update_listing_extra_person_on"],"description":"`extra_person_fee` customization — fee charged after a guest threshold. Requires a PMS\nthat supports extra person fee. When the toggle is **off**, send only\n`{ update_listing_extra_person_on: false }`. When **on**, type, fee, and trigger are all\nrequired.\n","title":"CapiExtraPersonFee"},"CapiWeeklyDiscount":{"type":"object","properties":{"weekly_discount_on":{"type":"boolean"},"weekly_discount":{"type":"integer","minimum":0,"maximum":75,"description":"Required when the toggle is on. Weekly discount percentage (0–75)."}},"required":["weekly_discount_on"],"description":"`weekly_discount` customization — percentage discount for weekly stays. Requires a PMS\nthat supports weekly/monthly discounts. When the toggle is **off**, send only\n`{ weekly_discount_on: false }`. When **on**, `weekly_discount` is required (integer 0–75).\n","title":"CapiWeeklyDiscount"},"CapiMonthlyDiscount":{"type":"object","properties":{"monthly_discount_on":{"type":"boolean"},"monthly_discount":{"type":"integer","minimum":0,"maximum":75,"description":"Required when the toggle is on. Monthly discount percentage (0–75)."}},"required":["monthly_discount_on"],"description":"`monthly_discount` customization — percentage discount for monthly stays. Requires a PMS\nthat supports weekly/monthly discounts. When the toggle is **off**, send only\n`{ monthly_discount_on: false }`. When **on**, `monthly_discount` is required (integer 0–75).\n","title":"CapiMonthlyDiscount"},"CapiMinWeekendPriceMinWeekendPriceType":{"type":"string","enum":["fixed","percent_base","percent_min"],"description":"Required when the toggle is on.\n- `fixed` — absolute weekend floor price.\n- `percent_base` — percent of base price.\n- `percent_min` — percent of min price.\n","title":"CapiMinWeekendPriceMinWeekendPriceType"},"CapiMinWeekendPrice":{"type":"object","properties":{"min_weekend_price_on":{"type":"boolean"},"min_weekend_price":{"type":"integer","description":"Required when the toggle is on. For `percent_base` / `percent_min`: integer −50..500.\nFor `fixed`: absolute price (at listing level, at least the listing's min price when set).\n"},"min_weekend_price_type":{"$ref":"#/components/schemas/CapiMinWeekendPriceMinWeekendPriceType","description":"Required when the toggle is on.\n- `fixed` — absolute weekend floor price.\n- `percent_base` — percent of base price.\n- `percent_min` — percent of min price.\n"}},"required":["min_weekend_price_on"],"description":"`min_weekend_price` customization — floor price for weekend nights. Auto-enables the\nWeekend Adjustments control-panel feature. When the toggle is **off**, send only\n`{ min_weekend_price_on: false }`. When **on**, both `min_weekend_price` and\n`min_weekend_price_type` are required.\n","title":"CapiMinWeekendPrice"},"CapiCustomizationsMap":{"type":"object","properties":{"seasonality":{"$ref":"#/components/schemas/CapiSeasonality"},"last_minute_prices":{"$ref":"#/components/schemas/CapiLastMinutePrices"},"day_of_week_adjustment":{"$ref":"#/components/schemas/CapiDayOfWeekAdjustment"},"far_out_premium":{"$ref":"#/components/schemas/CapiFarOutPremium"},"demand_factor":{"$ref":"#/components/schemas/CapiDemandFactor"},"custom_seasonal_profile":{"$ref":"#/components/schemas/CapiCustomSeasonalProfile"},"occupancy_based_adjustment":{"$ref":"#/components/schemas/CapiOccupancyBasedAdjustment"},"booking_factor":{"$ref":"#/components/schemas/CapiBookingFactor"},"extra_person_fee":{"$ref":"#/components/schemas/CapiExtraPersonFee"},"weekly_discount":{"$ref":"#/components/schemas/CapiWeeklyDiscount"},"monthly_discount":{"$ref":"#/components/schemas/CapiMonthlyDiscount"},"min_weekend_price":{"$ref":"#/components/schemas/CapiMinWeekendPrice"}},"description":"Map of customization name → its settings. Include any one or more of the customizations\nbelow in a single request. Unknown or unsupported customization names are rejected.\n","title":"CapiCustomizationsMap"},"CapiCustomizationsResponse":{"type":"object","properties":{"customizations":{"$ref":"#/components/schemas/CapiCustomizationsMap"}},"title":"CapiCustomizationsResponse"},"CapiError":{"type":"object","properties":{"error_code":{"type":"string","description":"Machine-readable error code (see endpoint descriptions)."},"error":{"type":"string","description":"Human-readable message."},"details":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}},"description":"Per-customization error details for aggregated validation failures (optional)."}},"title":"CapiError"},"CapiListingCustomizationsWriteRequest":{"type":"object","properties":{"listing_id":{"type":"string"},"pms_name":{"type":"string"},"customizations":{"$ref":"#/components/schemas/CapiCustomizationsMap"}},"required":["listing_id","pms_name","customizations"],"title":"CapiListingCustomizationsWriteRequest"},"Customizations_updateCapiListingCustomizations_Response_200":{"type":"object","properties":{"status":{"type":"string"},"applied":{"type":"array","items":{"type":"string"},"description":"Spec keys that were written (optional)."}},"title":"Customizations_updateCapiListingCustomizations_Response_200"},"V1CustomizationProfilesGetParametersProfileType":{"type":"string","enum":["minstay","pricing","checkincheckout","oba"],"title":"V1CustomizationProfilesGetParametersProfileType"},"CapiCustomizationProfileEntry":{"type":"object","properties":{"id":{"type":"integer","description":"The profile id to use in `custom_seasonal_profile` season writes\n(`minstay` / `pricing` / `checkincheckout`) or as `oba_profile_id` for\n`occupancy_based_adjustment` saved mode (`oba`).\n"},"name":{"type":"string","description":"Display name (unique per account and profile type)."},"archived":{"type":"boolean","description":"Whether the profile is archived (legacy `NULL` reads as `false`)."}},"description":"A profile reference — id, display name and archived flag only.","title":"CapiCustomizationProfileEntry"},"CapiCustomizationProfilesResponseProfiles":{"type":"object","properties":{"minstay":{"type":"array","items":{"$ref":"#/components/schemas/CapiCustomizationProfileEntry"}},"pricing":{"type":"array","items":{"$ref":"#/components/schemas/CapiCustomizationProfileEntry"}},"checkincheckout":{"type":"array","items":{"$ref":"#/components/schemas/CapiCustomizationProfileEntry"}},"oba":{"type":"array","items":{"$ref":"#/components/schemas/CapiCustomizationProfileEntry"}}},"description":"Profiles grouped by type. Types filtered out by `profile_type` are omitted;\na type with no profiles is an empty array.\n","title":"CapiCustomizationProfilesResponseProfiles"},"CapiCustomizationProfilesResponse":{"type":"object","properties":{"profiles":{"$ref":"#/components/schemas/CapiCustomizationProfilesResponseProfiles","description":"Profiles grouped by type. Types filtered out by `profile_type` are omitted;\na type with no profiles is an empty array.\n"}},"title":"CapiCustomizationProfilesResponse"},"CapiGroupCustomizationsWriteRequest":{"type":"object","properties":{"group_id":{"type":"integer"},"customizations":{"$ref":"#/components/schemas/CapiCustomizationsMap"}},"required":["group_id","customizations"],"title":"CapiGroupCustomizationsWriteRequest"},"Customizations_updateCapiGroupCustomizations_Response_200":{"type":"object","properties":{"status":{"type":"string"},"applied":{"type":"array","items":{"type":"string"},"description":"Spec keys that were written (optional)."}},"title":"Customizations_updateCapiGroupCustomizations_Response_200"},"CapiAccountCustomizationsWriteRequest":{"type":"object","properties":{"pms_name":{"type":"string"},"customizations":{"$ref":"#/components/schemas/CapiCustomizationsMap"}},"required":["pms_name","customizations"],"title":"CapiAccountCustomizationsWriteRequest"},"Customizations_updateCapiAccountCustomizations_Response_200":{"type":"object","properties":{"status":{"type":"string"},"applied":{"type":"array","items":{"type":"string"},"description":"Spec keys that were written (optional)."}},"title":"Customizations_updateCapiAccountCustomizations_Response_200"},"V1ListingOptimizerSummaryGetParametersStatus":{"type":"string","enum":["pending","processing","completed","error","delisted","archived","deleted"],"title":"V1ListingOptimizerSummaryGetParametersStatus"},"OptimizerListingRow":{"type":"object","properties":{"listing_id":{"type":"string","description":"Unique listing ID."},"pms_name":{"type":"string","description":"PMS the listing belongs to."},"listing_name":{"type":"string","description":"Listing title, or listing_id if no title is set."},"status":{"type":"string","description":"Current optimizer status. One of `pending`, `processing`, `completed`, `error`, `delisted`, `archived`, `deleted`."},"analyzed_at":{"type":["string","null"],"description":"ISO 8601 timestamp of the last analysis run. `null` if not yet analyzed."},"overall_score":{"type":["number","null"],"format":"double","description":"Overall Listing Optimizer score (0–10, two decimal places). `null` if not yet scored."},"city":{"type":["string","null"],"description":"City where the listing is located."},"state":{"type":["string","null"],"description":"State or region where the listing is located."},"subscribed":{"type":"boolean","description":"Whether the listing has an active PriceLabs subscription."},"subscription_end":{"type":["string","null"],"description":"Date (YYYY-MM-DD) when the subscription ends. `null` if not applicable."},"can_rerun":{"type":"boolean","description":"Whether the listing can be re-analyzed now."},"manual_reruns_remaining":{"type":["integer","null"],"description":"Number of manual re-runs remaining this month."}},"description":"Fields returned for each listing in the Listing Optimizer summary response.","title":"OptimizerListingRow"},"V1ListingOptimizerSummaryGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"has_optimizer_report":{"type":"boolean","description":"Whether an Optimizer report exists for this account."},"listings":{"type":"array","items":{"$ref":"#/components/schemas/OptimizerListingRow"},"description":"Optimizer summary row for each active listing."}},"required":["has_optimizer_report","listings"],"title":"V1ListingOptimizerSummaryGetResponsesContentApplicationJsonSchemaData"},"Listing_Optimizer_getListingOptimizerSummary_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/V1ListingOptimizerSummaryGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Listing Optimizer_getListingOptimizerSummary_Response_200"},"OptimizerCategoryScore":{"type":"object","properties":{"score":{"type":"string","description":"Letter grade for this category (e.g. `A`, `B`, `C`)."},"improvements":{"type":"string","description":"Actionable tip to improve this category's score. Categories surface either this or `description`, not both."},"description":{"type":"string","description":"Explanatory note about this category's score, for categories that don't have an actionable tip. Categories surface either this or `improvements`, not both."}},"description":"Score and guidance for a single Listing Optimizer category from the latest analysis run.","title":"OptimizerCategoryScore"},"OptimizerScoreBreakdown":{"type":"object","properties":{"overall_score":{"type":"number","format":"double","description":"Underlying 0–100 score behind the top-level `overall_score` letter-grade breakdown."},"listing_title":{"$ref":"#/components/schemas/OptimizerCategoryScore"},"listing_description":{"$ref":"#/components/schemas/OptimizerCategoryScore"},"image_score":{"$ref":"#/components/schemas/OptimizerCategoryScore"},"amenities":{"$ref":"#/components/schemas/OptimizerCategoryScore"},"review_count":{"$ref":"#/components/schemas/OptimizerCategoryScore"},"review_summary":{"$ref":"#/components/schemas/OptimizerCategoryScore"},"star_rating":{"$ref":"#/components/schemas/OptimizerCategoryScore"},"guest_favorite":{"$ref":"#/components/schemas/OptimizerCategoryScore"},"consistency_score":{"$ref":"#/components/schemas/OptimizerCategoryScore"}},"description":"Category-level scores, keyed by category: `overall_score` (the underlying 0–100 score) and one `OptimizerCategoryScore` per category — `listing_title`, `listing_description`, `image_score`, `amenities`, `review_count`, `review_summary`, `star_rating`, `guest_favorite`, `consistency_score`.\n\nShared by both `scores` (latest run, includes `improvements`/`description` guidance) and `previous_scores` (prior run, `score` only — the guidance fields are simply omitted since they're optional).\n","title":"OptimizerScoreBreakdown"},"V1ListingOptimizerReportGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"listing_id":{"type":"string","description":"Unique listing ID."},"pms_name":{"type":"string","description":"PMS the listing belongs to."},"overall_score":{"type":["number","null"],"format":"double","description":"Overall Listing Optimizer score (0–10, two decimal places). `null` if not yet scored."},"payment_restricted":{"type":"boolean","description":"Present and `true` when the account does not have paid Optimizer access for this listing. When `true`, `scores` and `previous_scores` are omitted."},"scores":{"$ref":"#/components/schemas/OptimizerScoreBreakdown","description":"Category-level scores and improvement details from the latest analysis run. Present only when `payment_restricted` is absent or `false`."},"previous_scores":{"oneOf":[{"$ref":"#/components/schemas/OptimizerScoreBreakdown"},{"type":"null"}],"description":"Scores from the previous analysis run, for comparison. `null` if no prior run exists. Present only when `payment_restricted` is absent or `false`."}},"description":"Listing Optimizer report for the listing.","title":"V1ListingOptimizerReportGetResponsesContentApplicationJsonSchemaData"},"Listing_Optimizer_getListingOptimizerReport_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/V1ListingOptimizerReportGetResponsesContentApplicationJsonSchemaData","description":"Listing Optimizer report for the listing."}},"required":["data"],"title":"Listing Optimizer_getListingOptimizerReport_Response_200"},"GetListingOptimizerReportRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}},"title":"GetListingOptimizerReportRequestBadRequestError"},"GetListingOptimizerReportRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}},"title":"GetListingOptimizerReportRequestNotFoundError"},"GetListingOptimizerReportRequestUnprocessableEntityError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}},"title":"GetListingOptimizerReportRequestUnprocessableEntityError"},"V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaDataCurrentRankingsSegmentsItemsDates":{"type":"object","properties":{"rank":{"type":["integer","null"],"description":"Search result rank (1 = top position)."},"page":{"type":["integer","null"],"description":"Search result page number."},"price":{"type":["number","null"],"format":"double","description":"Listed price on that date."}},"title":"V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaDataCurrentRankingsSegmentsItemsDates"},"V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaDataCurrentRankingsSegmentsItems":{"type":"object","properties":{"guest_count":{"type":"integer"},"los":{"type":"string"},"dates":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaDataCurrentRankingsSegmentsItemsDates"},"description":"Date-keyed ranking entries."}},"title":"V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaDataCurrentRankingsSegmentsItems"},"V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaDataCurrentRankings":{"type":"object","properties":{"updated_at":{"type":"string","description":"Timestamp of the last ranking update."},"current_rank_min":{"type":["integer","null"],"description":"Minimum rank achieved across all dates in the current snapshot."},"segments":{"type":"array","items":{"$ref":"#/components/schemas/V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaDataCurrentRankingsSegmentsItems"},"description":"One entry per (guest_count, LOS) combination."}},"description":"Current search-result ranking data broken into guest-count × LOS segments. `null` if ranking data is unavailable.","title":"V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaDataCurrentRankings"},"V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaDataRankingHistoryItems":{"type":"object","properties":{"guest_count":{"type":"integer"},"los":{"type":"string"},"dates":{"type":"array","items":{"type":"string","format":"date"},"description":"Ordered list of dates covered by this segment's history."},"ranks":{"type":"object","additionalProperties":{"type":"array","items":{"type":"number","format":"double"}},"description":"Arrays of rank values (one per day in `dates`, same order). Key names are defined by the upstream ranking service and are not a fixed set — treat them as opaque identifiers rather than a documented enum. Non-finite values are represented as `null`."}},"title":"V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaDataRankingHistoryItems"},"V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"listing_id":{"type":"string","description":"Unique listing ID."},"pms_name":{"type":"string","description":"PMS the listing belongs to."},"neighborhood_count":{"type":["integer","null"],"description":"Number of competing listings in the listing's neighborhood. `null` if unavailable."},"current_rankings":{"oneOf":[{"$ref":"#/components/schemas/V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaDataCurrentRankings"},{"type":"null"}],"description":"Current search-result ranking data broken into guest-count × LOS segments. `null` if ranking data is unavailable."},"ranking_history":{"type":["array","null"],"items":{"$ref":"#/components/schemas/V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaDataRankingHistoryItems"},"description":"Historical ranking data by (guest_count, LOS) segment. `null` if history is unavailable."}},"description":"Listing Optimizer ranking data for the listing.","title":"V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaData"},"Listing_Optimizer_getListingOptimizerRanking_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/V1ListingOptimizerRankingGetResponsesContentApplicationJsonSchemaData","description":"Listing Optimizer ranking data for the listing."}},"required":["data"],"title":"Listing Optimizer_getListingOptimizerRanking_Response_200"},"GetListingOptimizerRankingRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}},"title":"GetListingOptimizerRankingRequestBadRequestError"},"GetListingOptimizerRankingRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message."}},"title":"GetListingOptimizerRankingRequestNotFoundError"},"LogsRequestLogType":{"type":"string","enum":["listing","group","account"],"description":"Entity type to which the logs belong.","title":"LogsRequestLogType"},"LogsRequestActionsItems":{"type":"string","enum":["base_price","base_price_from_parent","base_price_from_parent_during_mapping","min_price","min_price_from_parent","min_price_from_parent_during_mapping","max_price","max_price_from_parent","max_price_from_parent_during_mapping","push_price","api_push_price","add_custom_pricing","add_custom_pricing_from_parent","add_custom_pricing_from_parent_during_mapping","api_add_custom_pricing","api_add_custom_pricing_from_parent","remove_custom_pricing","remove_custom_pricing_from_parent","remove_custom_pricing_from_parent_during_mapping","api_remove_custom_pricing","api_remove_custom_pricing_from_parent","dso_warnings_snoozed","add_custom_pricing_group","remove_custom_pricing_group","dso_warnings_snoozed_group","add_custom_pricing_portal","remove_custom_pricing_portal","dso_warnings_snoozed_portal"],"title":"LogsRequestActionsItems"},"LogsListingFilter":{"type":"object","properties":{"listing_id":{"type":"string","description":"The listing identifier."},"pms":{"type":"string","description":"The PMS name for the listing."}},"required":["listing_id","pms"],"title":"LogsListingFilter"},"LogsRequest":{"type":"object","properties":{"log_type":{"$ref":"#/components/schemas/LogsRequestLogType","description":"Entity type to which the logs belong."},"actions":{"type":"array","items":{"$ref":"#/components/schemas/LogsRequestActionsItems"},"description":"Action keys to filter by. Allowed values depend on `log_type`."},"listings":{"type":"array","items":{"$ref":"#/components/schemas/LogsListingFilter"},"description":"Listing identifiers to filter by. Each entry requires `listing_id` and `pms`.\nOnly applicable when `log_type` is `listing`.\n"},"group_names":{"type":"array","items":{"type":"string"},"description":"Group names to filter by.\nOnly applicable when `log_type` is `group`.\n"},"pms_names":{"type":"array","items":{"type":"string"},"description":"PMS names to filter by.\nOnly applicable when `log_type` is `account`.\n"},"user_ids":{"type":"array","items":{"type":"integer"},"description":"User IDs to filter logs by specific team members.\n"},"start_date":{"type":"string","format":"date","description":"Start of date range filter (YYYY-MM-DD). Defaults to 30 days ago."},"end_date":{"type":"string","format":"date","description":"End of date range filter (YYYY-MM-DD). Defaults to today."},"offset":{"type":"integer","minimum":0,"maximum":1000,"default":0,"description":"Number of records to skip. Defaults to 0, maximum 1000."},"limit":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Number of records to return. Defaults to 50, maximum 200."}},"required":["log_type"],"title":"LogsRequest"},"LogEntryAction":{"type":"string","enum":["base_price","base_price_from_parent","base_price_from_parent_during_mapping","min_price","min_price_from_parent","min_price_from_parent_during_mapping","max_price","max_price_from_parent","max_price_from_parent_during_mapping","push_price","api_push_price","add_custom_pricing","add_custom_pricing_from_parent","add_custom_pricing_from_parent_during_mapping","api_add_custom_pricing","api_add_custom_pricing_from_parent","remove_custom_pricing","remove_custom_pricing_from_parent","remove_custom_pricing_from_parent_during_mapping","api_remove_custom_pricing","api_remove_custom_pricing_from_parent","dso_warnings_snoozed","add_custom_pricing_group","remove_custom_pricing_group","dso_warnings_snoozed_group","add_custom_pricing_portal","remove_custom_pricing_portal","dso_warnings_snoozed_portal"],"description":"Raw action key. One of the values listed under the `actions` filter parameter.\n","title":"LogEntryAction"},"LogEntryLogType":{"type":"string","enum":["listing","group","account"],"title":"LogEntryLogType"},"LogsEntityType":{"type":"string","enum":["listing","group","account"],"title":"LogsEntityType"},"LogsEntity":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/LogsEntityType"},"listing_id":{"type":"string","description":"Listing identifier (only present for listing entities)."},"name":{"type":["string","null"],"description":"Display name of the listing. Returns \"N/A\" for deleted listings."},"group_name":{"type":"string","description":"Group name (only present for group entities). Returns \"GroupDeleted\" for deleted groups."},"pms_name":{"type":"string","description":"PMS identifier (present for listing and account entities)."},"pms_display_name":{"type":"string","description":"Human-readable PMS display name (present for listing and account entities)."}},"required":["type"],"description":"Entity shape varies by type:\n- `listing`: includes `listing_id`, `name`, `pms_name`, `pms_display_name`\n- `group`: includes `group_name`\n- `account`: includes `pms_name`, `pms_display_name`\n\nIf a listing has been deleted, `name` returns `\"N/A\"`.\nIf a group has been deleted, `group_name` returns `\"GroupDeleted\"`.\n","title":"LogsEntity"},"LogsUser":{"type":"object","properties":{"id":{"type":"integer"},"email":{"type":["string","null"]}},"required":["id","email"],"title":"LogsUser"},"LogsPriceChangeOldValue":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"title":"LogsPriceChangeOldValue"},"LogsPriceChangeNewValue":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"title":"LogsPriceChangeNewValue"},"LogsPriceChange":{"type":"object","properties":{"old_value":{"oneOf":[{"$ref":"#/components/schemas/LogsPriceChangeOldValue"},{"type":"null"}]},"new_value":{"oneOf":[{"$ref":"#/components/schemas/LogsPriceChangeNewValue"},{"type":"null"}]},"source":{"type":["string","null"],"description":"Where the change was made (e.g. `review_calendar`, `parent_sync`). Only present for base price changes."}},"description":"Returned for base, minimum, and maximum price updates.\n`source` is only included for base price changes.\n","title":"LogsPriceChange"},"LogsStatusToggleNewValue":{"type":"string","enum":["ON","OFF"],"title":"LogsStatusToggleNewValue"},"LogsStatusToggle":{"type":"object","properties":{"new_value":{"$ref":"#/components/schemas/LogsStatusToggleNewValue"}},"description":"Returned when a sync setting or DSO warning snooze was toggled on or off.\nOnly `new_value` is included.\n","title":"LogsStatusToggle"},"LogsDsoChange":{"type":"object","properties":{"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"price":{"type":["string","null"],"description":"Override price value."},"price_type":{"type":["string","null"],"description":"`fixed` or `percent`."},"min_price":{"type":["string","null"],"description":"Minimum price override."},"min_price_type":{"type":["string","null"],"description":"`fixed` or `percent`."},"max_price":{"type":["string","null"],"description":"Maximum price override."},"max_price_type":{"type":["string","null"],"description":"`fixed` or `percent`."},"base_price":{"type":["string","null"],"description":"Base price override."},"min_stay":{"type":["integer","null"],"description":"Minimum stay requirement (only present if > 0)."},"lead_time_expiry":{"type":["string","null"]},"availability":{"type":["string","null"]},"reason":{"type":["string","null"]},"check_in":{"type":["string","null"],"description":"Allowed check-in days (e.g. \"Mo, We, Fr\"). Only present when check-in/check-out restrictions are enabled."},"check_out":{"type":["string","null"],"description":"Allowed check-out days (e.g. \"Tu, Th, Sa\"). Only present when check-in/check-out restrictions are enabled."},"merged_keys":{"type":["array","null"],"items":{"type":"string"},"description":"Keys that were merged from an existing override."},"parent_listing_id":{"type":["string","null"],"description":"Present when the DSO was inherited from a parent listing."},"parent_listing_name":{"type":["string","null"],"description":"Display name of the parent listing."}},"required":["start_date","end_date"],"description":"Returned when a date-specific override was added or removed.\nOnly fields that have a value are included beyond `start_date` and `end_date`.\n","title":"LogsDsoChange"},"LogEntryChanges":{"oneOf":[{"$ref":"#/components/schemas/LogsPriceChange"},{"$ref":"#/components/schemas/LogsStatusToggle"},{"$ref":"#/components/schemas/LogsDsoChange"}],"description":"What changed. The fields returned depend on the action — see the schemas below.\n","title":"LogEntryChanges"},"LogsMetadata":{"type":"object","properties":{"ip_address":{"type":["string","null"]},"device_type":{"type":["string","null"],"description":"Request context. Typically `web`, `mobile`, or `api`."}},"title":"LogsMetadata"},"LogEntry":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/LogEntryAction","description":"Raw action key. One of the values listed under the `actions` filter parameter.\n"},"action_label":{"type":"string","description":"Human-readable label for the action."},"log_type":{"$ref":"#/components/schemas/LogEntryLogType"},"entity":{"$ref":"#/components/schemas/LogsEntity"},"user":{"$ref":"#/components/schemas/LogsUser"},"changes":{"$ref":"#/components/schemas/LogEntryChanges","description":"What changed. The fields returned depend on the action — see the schemas below.\n"},"metadata":{"$ref":"#/components/schemas/LogsMetadata"},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the action was performed."}},"required":["action","action_label","log_type","entity","user","changes","metadata","created_at"],"title":"LogEntry"},"LogsPagination":{"type":"object","properties":{"offset":{"type":"integer","description":"Number of records skipped."},"limit":{"type":"integer","description":"Number of records returned per request."},"total":{"type":"integer","description":"Total number of matching log entries."}},"required":["offset","limit","total"],"title":"LogsPagination"},"LogsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LogEntry"}},"pagination":{"$ref":"#/components/schemas/LogsPagination"}},"required":["data","pagination"],"title":"LogsResponse"},"LogsError":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"error_code":{"type":"string"}},"title":"LogsError"},"V1AddListingDataPostResponsesContentApplicationJsonSchemaLatLngListingsItems":{"type":"object","properties":{},"title":"V1AddListingDataPostResponsesContentApplicationJsonSchemaLatLngListingsItems"},"PMS_Specific_addNewListingsFromPMS_Response_200":{"type":"object","properties":{"success":{"type":"string","description":"A success message (e.g. \"Successfully connected with BookingSync\")"},"lat_lng_listings":{"type":"array","items":{"$ref":"#/components/schemas/V1AddListingDataPostResponsesContentApplicationJsonSchemaLatLngListingsItems"},"description":"An array of listing IDs with missing latitude or longitude. Update the latitude and longitude information in BookingSync and try this API call again to add these listing IDs in your PriceLabs account."},"listing_ids":{"type":"array","items":{"type":"string"},"description":"An array of listing IDs that have been successfully added in the PriceLabs account. Head over to your PriceLabs account to review prices for these listings."}},"title":"PMS Specific_addNewListingsFromPMS_Response_200"},"AddNewListingsFromPMSRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing the invalid request"}},"title":"AddNewListingsFromPMSRequestBadRequestError"}}}}