Skip to content

Read offering

GET
/offerings/{offering_id}
curl --request GET \
--url https://quikstik-core.fly.dev/offerings/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>' \
--header 'x-tenant-id: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Reads a single offering by id.

offering_id
required
string format: uuid
x-tenant-id
required
string format: uuid

Tenant identifier (UUID).

Authn/authz semantics are intentionally TBD for this contract slice; this header exists to keep the contract explicitly multi-tenant from day 0.

Offering

Media typeapplication/json
object
offering_id
required
string format: uuid
catalog_product_id

Tenant-defined stable product identifier (TBD).

string
nullable
display_name
required
string
kind

Offering kind discriminator (TBD).

string
nullable
description

Long-form description (TBD; Island Time v1 descriptions are not present in the artifact).

string
nullable
variants
required
Array<object>
object
variant_id
required
string format: uuid
display_name
required
string
sku

Traditional SKU identifier (if applicable; vocabulary only).

string
nullable

Example generated

{
"offering_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"catalog_product_id": "example",
"display_name": "example",
"kind": "example",
"description": "example",
"variants": [
{
"variant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"display_name": "example",
"sku": "example"
}
]
}

Not found