ShyniAPI
Catalog

Set the photo of a service

PUT
/api/v1/services/{id}/image

Points the service at a photo that already exists in the studio's library (imageId); null removes the photo. To add a new photo, upload it with POST /images first. An id of another studio, or a photo that is being deleted, is 404 with field: imageId. Draft. 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

Path Parameters

id*string

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
imageId*|

An image id of the studio's library; null removes the photo.

Response Body

The draft service.

application/json
  1. response

A service as the catalog write endpoints show it: the DRAFT row the studio edits, with every field the write endpoints change. id is the logical id every endpoint takes; the live storefront shows the row only after POST /catalog/publish.

id*string
slug*string
name*string
description*

Formatted text (a studio's own wording with bold, italic, links and lists). The same text in three projections, so an integration picks what suits it.

Forward compatibility: json.v is the schema version; new node and mark types may be added in later versions - skip nodes you don't know and fall back to plain.

scope*ServiceScope
Value in"PRIMARY""SECONDARY""ADDON"
basePrice*integer

Amount in minor units of currency (hellers for CZK).

Formatint64
currency*string
durationMinutes*integer
employeesRequired*integer
postWorkStrategy*string
Value in"NONE""NEXT_WORKING_DAY""FIXED_DURATION"
postWorkMinutes*integer|null
variants*array<>
discountPercent*integer
pricingMode*string
Value in"EXACT""FROM""ON_REQUEST"
minAdvanceDays*integer
renewalIntervalMonths*integer|null
multiDay*boolean
storefrontVisible*boolean
sortOrder*integer
categoryId*string
highlight*string
Value in"NONE""MOST_POPULAR""BEST_VALUE""RECOMMENDED"
active*boolean

false = archived.

imageId*string|null
includes*array<string>
forWhom*string|null
recommendedAddonIds*array<string>
orderAudience*string

KNOWN_CARS = orderable only for a car that already has a completed order at the studio (POST /orders needs a knownCarToken).

Value in"ALL""KNOWN_CARS"
soldOnlyWithServiceIds*array<string>

Add-on only (empty otherwise) - ids of the services it may be ordered with; empty = with any primary service.

Example Request
curl -X PUT 'https://api.shyni.io/api/v1/services/string/image' \  -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \  -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \  -H 'Content-Type: application/json' \  -d '{  "imageId": "string"}'

Response 200

The draft service.

{  "id": "string",  "slug": "string",  "name": "string",  "description": {    "plain": "string",    "html": "string",    "json": {      "v": 0,      "doc": {}    }  },  "scope": "PRIMARY",  "basePrice": 0,  "currency": "string",  "durationMinutes": 0,  "employeesRequired": 0,  "postWorkStrategy": "NONE",  "postWorkMinutes": 0,  "variants": [    {      "code": "string",      "priceMultiplier": 0,      "extraMinutes": 0    }  ],  "discountPercent": 0,  "pricingMode": "EXACT",  "minAdvanceDays": 0,  "renewalIntervalMonths": 0,  "multiDay": true,  "storefrontVisible": true,  "sortOrder": 0,  "categoryId": "string",  "highlight": "NONE",  "active": true,  "imageId": "string",  "includes": [    "string"  ],  "forWhom": "string",  "recommendedAddonIds": [    "string"  ],  "orderAudience": "ALL",  "soldOnlyWithServiceIds": [    "string"  ]}

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 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."}

Highlight a service PUT

Previous Page

List service categories GET

Next Page