Skip to content
Systey

Offer, terms and operating systems

Request, parameters and responses for this API endpoint.

GET/api/v1/customer/catalog/{id}

Overview

This endpoint requires an active API key with read access.

Headers & parameters

AuthorizationBearer $SYSTEY_API_KEY · required

idpath · required

{"type":"string","format":"uuid"}

Example request

Replace placeholders with your own values. Persist $REQUEST_UUID before a mutation if this endpoint requires an Idempotency-Key.

cURL
curl -i -X GET "https://systey.com/api/v1/customer/catalog/<resource UUID>" \
  -H "Authorization: Bearer $SYSTEY_API_KEY"

Response

HTTP 200
Schema fields and requirements
FieldTypeRequired
dataobjectYes
data.id

uuid

stringYes
data.namestringYes
data.descriptionstringYes
data.category

"VPS" | "DOMAIN" | "WEBSPACE" | "DEVELOPMENT" | "MANAGED_SERVICE"

stringYes
data.serverLinestring | nullYes
data.billingCycle

"ONCE" | "MONTHLY" | "YEARLY"

stringYes
data.commercialModel

"CONTRACT" | "PREPAID"

stringYes
data.renewalMode

"NONE" | "AUTOMATIC" | "CUSTOMER"

stringYes
data.priceCentsintegerYes
data.setupCentsintegerYes
data.taxRateBpsintegerYes
data.discountBpsintegerYes
data.setupDiscountBpsintegerYes
data.discountMode

"PERCENT" | "AMOUNT" | "PRICE"

stringYes
data.discountAmountCentsintegerYes
data.discountStartsAt

date-time | null

string | nullYes
data.discountEndsAt

date-time | null

string | nullYes
data.stock

integer | null

integer | nullYes
data.contractTermMonthsnumber | nullYes
data.minimumTermMonthsnumber | nullYes
data.renewalMonthsnumber | nullYes
data.noticeDaysnumber | nullYes
data.specificationItemsarrayYes
data.specificationItems[]object—
data.specificationItems[].labelstringYes
data.specificationItems[].valuestringYes
data.specificationsstringYes
data.termsstringYes
data.catalogVersion

date-time

stringYes
data.currency

const: "EUR"

stringYes
data.recurringGrossCentsintegerYes
data.initialTotalCentsintegerYes
data.ordersEnabledbooleanYes
data.operatingSystemsarrayYes
data.operatingSystems[]object—
data.operatingSystems[].id

uuid

stringYes
data.operatingSystems[].labelstringYes
data.domainSandbox

"true" | "false"

string—

Errors

Error responses contain error and optionally message and details. Rate limit: 120 requests per minute per key. On HTTP 429 respect Retry-After.