Read Package version

GET

/v1/object-types/hospitality.package_version/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.package_version/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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.package_version/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

Immutable per-version content row for a package. Carries the wrapper price + allocation rule that were in force when the version was minted, plus a frozen content snapshot of the components that participated. The active version is the one with version_status = active and effective_to IS NULL; the operational handle is the package_has_active_version 1:1 link. A package_sale pins to a specific row via package_sale_uses_package_version so cross-version revenue analytics (GROUP BY package_version_id) are queryable.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.package_version:read

Parameters

Path Parameters

required

string format: uuid

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

Query Parameters

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

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.package_version

properties

required

object

allocation_rule

required

Allocation rule for this version

string

Allowed values: pro_rata room_residual

content_snapshot

Frozen component identities + per-version overrides at version-mint time (opaque to the engine)

contracted_price

Package version contracted price

Wrapper price for this version

object

amount

required

string format: decimal

currency

required

string format: iso-4217

effective_from

required

When this version became active

string format: date-time

effective_to

When this version was superseded (null while active)

string format: date-time

required

Version id

string

supersede_reason

Operator note explaining the supersedence (e.g. 'Q3 seasonal repricing'). Free text; not parsed.

string

supersedes_version_id

Prior version this one replaces (null on v1; set on every subsequent supersede). Self-reference; the link surface (`package_version_supersedes`) carries the same edge for graph walks.

string format: uuid

version_number

required

Monotonic version number (1, 2, 3, ...) per package

integer

version_status

required

Per-version status (active | superseded | deprecated)

string

Allowed values: active superseded deprecated

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

Example

{
  "object_type": "hospitality.package_version",
  "properties": {
    "allocation_rule": "pro_rata",
    "version_status": "active"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).