List links of Sell-limit recommendation

GET

/v1/object-types/hospitality.sell_limit_recommendation/objects/{id}/links/{link_type}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.sell_limit_recommendation/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/links/hospitality.link.sell_limit_recommendation_applied_to_availability_day?direction=out';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url 'https://api.aerandil.com/v1/object-types/hospitality.sell_limit_recommendation/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/links/hospitality.link.sell_limit_recommendation_applied_to_availability_day?direction=out' \
  --header 'Authorization: Bearer <token>'

List the neighbours of an instance along a typed link. Direction is inferred when the source binds the link on exactly one side; symmetric links (same object type on both ends) require an explicit ?direction=out or ?direction=in.

A typed overbooking recommendation issued by an agent against one room type over a date range: the oversell headroom the type may sell past its sellable rooms on every night of the range (oversell_limit), or the explicit reset to the operator’s declared limit — with the reading behind it frozen at issue: the rooms on the books, the share of them believed to arrive, the walk cost and the marginal rate the limit balances, and the walks expected at it. Applying it moves each ledger row’s oversell_limit through the overlay set_availability writes, bounded by the row’s oversell_ceiling (the declared limit where none is set) and by what is already sold. The decision_* fields mutate exactly once on the transition out of suggested.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.sell_limit_recommendation:read

Parameters

Path Parameters

required

string format: uuid

Object id (UUID v7, server-generated at create time).

link_type

required

Allowed values: hospitality.link.sell_limit_recommendation_applied_to_availability_day hospitality.link.sell_limit_recommendation_at_property hospitality.link.sell_limit_recommendation_for_room_type hospitality.link.sell_limit_recommendation_part_of_run hospitality.link.sell_limit_recommendation_superseded_by

API name of the link type. Narrowed to link types that bind this source object type on at least one side.

Query Parameters

direction

Allowed values: out in

Edge direction to follow. Optional when the link binds the source on exactly one side; required for symmetric links.

limit

integer

>= 1 <= 500

cursor

string

as_of

string format: date-time

RFC3339 temporal window: return neighbours whose edge was in effect at this instant ([effective_from, effective_to)) instead of now.

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Neighbours along the typed link.

application/json

object

data

required

Array<object>

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

string

properties

required

object

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

direction

required

Allowed values: out in

has_more

required

boolean

link_type

required

string

next_cursor

string

Example

{
  "data": [
    {
      "scope": {
        "level": "tenant"
      }
    }
  ],
  "direction": "out"
}

404

No object with that id, or link type unknown.

422

Validation error — direction conflicts with the link’s binding.