Catalog

List the draft packages

GET
/api/v1/catalog/draft/packages

The packages as the studio is editing them - the DRAFT the admin shows, archived packages included (active: false) - with their components and the component ids, so an integrator can learn the ids the package endpoints take and see what it wrote before publishing. GET /services stays the published catalog. Ordered by sortOrder. Requires the catalog:read scope; a publishable key cannot call it.

Authorization

ApiKeyAuth catalog:read
headerAuthorizationBearer <shyni_sk_live_*>

An API key, issued once and never retrievable again: an organization key in the developer portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....

Scope: catalog:read

Query Parameters

page?integer
Range1 <= value
Default1
perPage?integer
Range1 <= value <= 100
Default20

Response Body

One page of draft packages.

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://api.shyni.io/api/v1/catalog/draft/packages' \  -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY'

Response 200

One page of draft packages.

{  "data": [    {      "id": "string",      "slug": "string",      "name": "string",      "description": {        "plain": "string",        "html": "string",        "json": {          "v": 0,          "doc": {}        }      },      "scope": "PRIMARY",      "basePrice": 0,      "currency": "string",      "durationMinutes": 0,      "postWorkStrategy": "NONE",      "postWorkMinutes": 0,      "variants": [        {          "code": "string",          "priceMultiplier": 0,          "extraMinutes": 0        }      ],      "discountPercent": 0,      "multiDay": true,      "sortOrder": 0,      "highlight": "NONE",      "active": true,      "components": [        {          "id": "string",          "serviceId": "string",          "quantity": 0,          "sortOrder": 0        }      ]    }  ],  "meta": {    "page": 0,    "perPage": 0,    "total": 0  }}

Response 400

A parameter, header or request body is missing, malformed, or out of range. A request body property the endpoint does not define answers UNKNOWN_FIELD instead, with field naming it.

{  "code": "INVALID_INPUT",  "message": "Parameter perPage must be between 1 and 100."}

Response 401

Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).

{  "code": "INVALID_API_KEY",  "message": "Missing or invalid API key."}

Response 403

The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys, Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio. See Authentication and Scopes above.

{  "code": "INSUFFICIENT_SCOPE",  "message": "This API key does not have the permission this endpoint requires."}

Response 404

The resource does not exist, or belongs to a different studio.

{  "code": "NOT_FOUND",  "message": "Order not found."}

Response 429

Burst rate limit exceeded.

{  "code": "RATE_LIMITED",  "message": "Too many requests. Retry after the time given in the Retry-After header."}