Read Retail product

GET

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

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

Read an existing instance.

A SKU-level retail product. Belongs to a retail_product_line and is available at venues / properties via M:N temporal links. Bridges to the venue POS catalogue via service_item_is_retail_product (a venue’s POS may sell the same SKU as a catalogue item); the two surfaces overlap intentionally so the same physical SKU has one identity across DTC and in-venue channels.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.retail_product: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.retail_product

properties

required

object

barcode

Barcode

string

bundle_size

Bundle size (multi-pack SKUs)

integer

code

required

SKU

string

cost_amount

Retail product cost amount

Cost of goods (margin reporting)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

cost_currency

Cost currency (ISO 4217)

string format: iso-4217

currency

required

Currency (ISO 4217)

string format: iso-4217

description

Description

string

image_url

Image URL

string

is_dtc_only

required

DTC-only (no in-venue placement)

boolean

kind

required

Product kind (mirrors retail_product_line.kind)

string

Allowed values: bath_body skincare fragrance candle home_goods wellness_consumable merchandise minibar_collab apparel other

name

required

Product name

string

unit_price

required

Retail product unit price

Unit price

object

amount

required

string format: decimal

currency

required

string format: iso-4217

volume_ml

Volume (millilitres)

integer

weight_grams

Weight (grams)

integer

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.retail_product",
  "properties": {
    "kind": "bath_body"
  },
  "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).