List Offerings
GET /v1/product/:tenant/offerings
Retrieves a list of offerings (products/services) available to purchase. Each item includes status, identifiers, pricing, localization (country/currency), media, VAT, nested selectable packages, and any required sub-components (with inputs, amounts, and products).
Query Parameters
~filter[tenant]- Parameter for ~filter[tenant]
Request Example
GET /v1/product/:tenant/offerings
Response Example
[
{
"status": { "active": true, "deleted": false },
"vendor": { "name": "Example Vendor" },
"_id": "offering-id-1",
"id": "offering-id-1",
"tenant": "tenant-id-1",
"type": 1,
"sales_channel": "Shop",
"name": "Example Offering A",
"ingress": "Short marketing blurb",
"description": "{\"blocks\":[{\"text\":\"Example description.\"}],\"entityMap\":{}}",
"tags": ["Example"],
"sku": "SKU-EX-001",
"keys": [],
"media": [
"https://example.cdn/img-1.png",
"https://example.cdn/img-2.png"
],
"country": { "code": "NO", "_id": "country-id-1" },
"currency": { "code": "EUR", "_id": "currency-id-1" },
"price": 0,
"resell": false,
"msp": false,
"image": "https://example.cdn/logo-a.png",
"vat": {
"countrycode": "",
"type": "ZERO_RATE_VAT",
"rate": 0,
"_id": "vat-id-1",
"__v": 0
},
"payment_period": 720,
"subscription_term": 8640,
"subscription": true,
"amount": { "default": 1 },
"select": [
{
"_id": "select-id-1",
"id": "select-id-1",
"type": 2,
"name": "Example Package",
"description": "",
"default": true,
"active": true,
"price": 700,
"sku": "",
"tags": [],
"featurelist": [],
"vendor": { "name": "Example Vendor" },
"status": { "active": true, "deleted": false },
"country": { "code": "NO", "_id": "country-id-2" },
"currency": { "code": "NOK", "_id": "currency-id-2" },
"tenant": "tenant-id-1",
"sales_channel": "Shop",
"resell": false,
"msp": false,
"image": "https://example.cdn/package-a.png",
"vat": {
"countrycode": "",
"type": "ZERO_RATE_VAT",
"rate": 0,
"_id": "vat-id-2",
"__v": 0
},
"amount": { "default": 1 },
"input": { "enabled": false },
"keys": [],
"media": [],
"permission_features": [],
"integration": [],
"services": ["offering-id-1"],
"created": "2025-01-01T00:00:00.000Z",
"updated": "2025-01-02T00:00:00.000Z",
"__v": 1,
"customInputs": [],
"required": [
{
"_id": "component-id-1",
"id": "component-id-1",
"group_id": "component-id-1",
"tenant": "tenant-id-1",
"name": "Required Component 1",
"status": { "active": true, "deleted": false },
"sales_channel": "Shop",
"type": 3,
"subscription": true,
"referenced": false,
"default": true,
"active": true,
"description": "Short component description.",
"amount": { "min": 1, "max": 1000, "default": 1 },
"input": { "type": "numberInput", "name": "Units", "enabled": true },
"products": [
{
"_id": "product-id-1",
"sku": "SKU-COMP-001",
"cost_price": null,
"price": 719,
"amount": { "default": 1, "min": 1, "max": 1000 }
}
],
"services": ["offering-id-1"],
"managementLink": { "title": "Example Management", "url": "https://example.com" },
"keys": [],
"media": [],
"country": { "code": "NO", "_id": "country-id-3" },
"currency": { "code": "NOK", "_id": "currency-id-3" },
"list_price": 7199,
"resell": false,
"msp": false,
"permission_features": [],
"integrations": [],
"integration": [],
"created": "2025-01-01T00:00:00.000Z",
"updated": "2025-01-02T00:00:00.000Z",
"__v": 1,
"customInputs": []
},
{
"_id": "component-id-2",
"id": "component-id-2",
"group_id": "component-id-2",
"tenant": "tenant-id-1",
"name": "Required Component 2",
"status": { "active": true, "deleted": false },
"sales_channel": "Shop",
"type": 3,
"subscription": true,
"referenced": false,
"default": false,
"active": true,
"description": "",
"amount": { "min": 1, "max": null, "default": 1 },
"input": {},
"products": [
{
"_id": "product-id-2",
"sku": "SKU-COMP-002",
"cost_price": null,
"price": 1000,
"amount": { "default": 1, "min": 1 }
}
],
"services": ["offering-id-1"],
"managementLink": { "title": "", "url": "" },
"keys": [],
"media": [],
"country": { "code": "NO", "_id": "country-id-4" },
"currency": { "code": "NOK", "_id": "currency-id-4" },
"list_price": 0,
"resell": false,
"msp": null,
"permission_features": [],
"integrations": [],
"integration": [],
"created": "2025-01-01T00:00:00.000Z",
"updated": "2025-01-02T00:00:00.000Z",
"__v": 1,
"categories": [],
"consumption": { "metadata": {} },
"customInputs": [],
"ingress": "",
"properties": {},
"shop_enabled": false,
"stock": 0
}
],
"optional": []
}
],
"required": [],
"optional": [],
"integration": [],
"permission_features": [],
"created": "2025-01-01T00:00:00.000Z",
"updated": "2025-01-02T00:00:00.000Z",
"customInputs": []
},
{
"status": { "active": true, "deleted": false },
"vendor": { "name": "Example Vendor" },
"_id": "offering-id-2",
"id": "offering-id-2",
"tenant": "tenant-id-1",
"type": 1,
"sales_channel": "Shop",
"name": "Example Offering B",
"ingress": "Another short blurb",
"description": "{\"blocks\":[{\"text\":\"Backup as a Service description.\"}],\"entityMap\":{}}",
"tags": ["Backup"],
"sku": "SKU-EX-002",
"keys": [],
"media": ["https://example.cdn/baas.png"],
"image": "https://example.cdn/logo-b.png",
"subscription_term": 8640,
"payment_period": 720,
"price": 0,
"resell": false,
"msp": false,
"country": { "code": "NO", "_id": "country-id-5" },
"currency": { "code": "EUR", "_id": "currency-id-5" },
"vat": {
"countrycode": "",
"type": "ZERO_RATE_VAT",
"rate": 0,
"_id": "vat-id-3",
"__v": 0
},
"amount": { "default": 1 },
"select": [],
"required": [],
"optional": [],
"integration": [],
"permission_features": [],
"created": "2025-01-01T00:00:00.000Z",
"updated": "2025-01-02T00:00:00.000Z",
"customInputs": []
}
]