Search Rate recommendation

POST

/v1/object-types/hospitality.rate_recommendation/search

const url = 'https://api.aerandil.com/v1/object-types/hospitality.rate_recommendation/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","cursor":"example","filters":[{"property":"id","type":"eq","value":"example"}],"limit":1,"order":"asc","property_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","scope":{"level":"tenant"},"sort_by":"created_at"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.rate_recommendation/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

A typed rate recommendation issued by an agent against a specific (rate_plan, room_type, business_date, occupancy) tuple. Mostly-immutable post-issue: the recommendation payload (recommended_amount, lift, confidence, forecast_snapshot, factors_considered, rationale) is frozen at write time so the audit trail is the rationale at decision time, not against today’s forecast. The decision_* fields mutate exactly once on the transition out of suggested (apply / modified_and_apply / reject / expire / supersede) — that single mutation is gated by the decision_status_transitions cross-link validator.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.rate_recommendation:read

Request Body^required

application/json

object

branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid

cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string

filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array

One of:

object

property

required

Allowed value: id

type

required

Allowed value: eq

value

required

string

limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer

>= 1 <= 500

order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string

default: asc

Allowed values: asc desc

property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid

scope

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string

default: created_at

Allowed values: created_at updated_at id business_date occupancy target_field lift_pct confidence confidence_score rationale_text issued_at expires_at expires_on decision_status decided_at rejection_reason

Responses

200

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

application/json

object

data

required

Array<object>

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.rate_recommendation

properties

required

object

applied_amount

Rate recommendation applied amount

The amount actually applied (equals recommended_amount for plain apply; differs for modified_and_applied)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

business_date

required

Business date the recommendation applies to

string format: date

confidence

required

Operator-facing confidence ordinal

string

Allowed values: low medium high

confidence_score

Calibrated probability (0..=1) — set when the model emits one

string format: decimal

current_amount

Rate recommendation current amount

Snapshot of the target amount at issue time

object

amount

required

string format: decimal

currency

required

string format: iso-4217

decided_at

When the recommendation transitioned out of suggested

string format: date-time

decision_status

required

Lifecycle state

string

Allowed values: suggested applied modified_and_applied rejected expired superseded

delta_amount

Rate recommendation delta amount

Convenience: recommended_amount - current_amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

expires_at

required

After this, decision_status moves to expired

string format: date-time

expires_on

The house business day this lapses after. When set, the house's open business date decides expiry (not the wall clock) and expires_at is the nominal end of that day in the house's timezone

string format: date

factors_considered

required

Signals the recommendation conditioned on (the strategy that fired)

Array<string>

Allowed values: pickup_pace booking_curve competitive_set event_calendar historical_pattern segment_mix channel_mix length_of_stay_distribution cancellation_rate no_show_rate package_attachment group_displacement weather other

forecast_snapshot

Rate recommendation forecast snapshot

Forecast snapshot frozen at issue time (per §B.2)

object

ari_score

string format: decimal

as_of

required

string format: date-time

competitive_set_adr

object

amount

required

string format: decimal

currency

required

string format: iso-4217

competitive_set_occupancy_pct

string format: decimal

event_calendar_signal

string

forecast_kind

required

string

Allowed values: internal_pms external_rms external_str_compset hybrid other

mpi_score

string format: decimal

on_books_revenue

object

amount

required

string format: decimal

currency

required

string format: iso-4217

on_books_rooms

integer

pickup_last_24h

integer

pickup_last_7d

integer

rgi_score

string format: decimal

transient_adr_forecast

object

amount

required

string format: decimal

currency

required

string format: iso-4217

transient_rooms_forecast

integer

required

Recommendation id

string

issued_at

required

When the agent emitted the recommendation

string format: date-time

lift_pct

Convenience: (recommended_amount / current_amount) - 1

string format: decimal

occupancy

required

Occupancy (adult count for the target rate)

integer

rationale_text

Human-readable explanation surfaced to operators

string

recommended_amount

Rate recommendation recommended amount

Proposed new amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

rejection_reason

Free-text reason set on reject (the gold-standard decision log pattern — see proposal §6.3)

string

target_field

required

Target rate_per_night field (bar_anchor for bar_grid plans; amount for open-pricing plans)

string

Allowed values: bar_anchor amount

provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object

pins

object

key

additional properties

object

pinned_at

string format: date-time

pinned_by

object

reason

required

string

properties

object

key

additional properties

object

external_id

string

recorded_at

required

string format: date-time

source

required

string

source_updated_at

string format: date-time

stream

string

scope

required

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer

>= 1

has_more

required

boolean

next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string

Example

{
  "data": [
    {
      "object_type": "hospitality.rate_recommendation",
      "properties": {
        "confidence": "low",
        "decision_status": "suggested",
        "factors_considered": [
          "pickup_pace"
        ],
        "forecast_snapshot": {
          "forecast_kind": "internal_pms"
        },
        "target_field": "bar_anchor"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Validation error — unknown property or filter type mismatch.

Search Rate recommendation

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required