Catalog

Set the default variant prices

PUT
/api/v1/catalog/variants

Replaces the default prices of a new service. A detailing studio: variants must list every code of GET /catalog/variants once (label and customerPickable are accepted and ignored, the car sizes name themselves). A GENERIC studio defines its own variants here: 1-30 entries with a code of 1-16 characters (A-Z, 0-9, _, starting with a letter; 400 with field: variants[i].code otherwise), an optional label (1-80 characters, default the code), customerPickable (default true; at least one variant must be) - the list is kept in the order sent and becomes the codes POST /orders and a service's variants accept. Every entry has a priceMultiplier between 0.1 and 10 and extraMinutes 0-600. Existing services keep their own prices. Operational: effective at once, not part of any publish. Audited with the API key as the actor when the value changes. Requires the catalog:write scope and an Idempotency-Key header.

Authorization

ApiKeyAuth catalog:write
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:write

Header Parameters

Idempotency-Key*string

Caller-chosen idempotency token for this write. A retry under the SAME key with the SAME body replays the first response; the SAME key with a DIFFERENT body is 422 IDEMPOTENCY_KEY_MISMATCH. See Idempotency above.

Lengthlength <= 64

Request Body

application/json
  1. body
variants*array<>

Response Body

The variants.

application/json
  1. response
codes*array<string>

The variants the studio's industry offers, in display order.

defaults*array<>|null
Example Request
curl -X PUT 'https://api.shyni.io/api/v1/catalog/variants' \  -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \  -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \  -H 'Content-Type: application/json' \  -d '{  "variants": [    {      "code": "string",      "priceMultiplier": 0    }  ]}'

Response 200

The variants.

{  "codes": [    "string"  ],  "defaults": [    {      "code": "string",      "label": "string",      "customerPickable": true,      "priceMultiplier": 0,      "extraMinutes": 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 422

The same Idempotency-Key was already used for a request with a different body, use a new key (see Idempotency above).

{  "code": "IDEMPOTENCY_KEY_MISMATCH",  "message": "This Idempotency-Key was already used for a different request. Use a new key."}

Response 429

Burst rate limit exceeded.

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