Publish the catalog
Makes the draft of the whole CATALOG part live: capacity and places, rules (deposits, rounding, weekday rules),
opening hours, services and packages - everything written through catalog:write and availability:write
endpoints and the admin. The storefront part (gallery, contact, "my page") is not touched. The studio must
already be published (409: the first publication is the whole studio, done in the admin) and have at least one
active service (409 CANNOT_PUBLISH_WITHOUT_SERVICES). Audited with the API key as the actor. Requires the catalog:write scope and an
Idempotency-Key header.
ApiKeyAuth catalog:writeAuthorizationBearer <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
Idempotency-Key*stringCaller-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.
length <= 64The publish state after publishing.
application/json- response
visibility*string"NEVER_PUBLISHED""PUBLISHED""HIDDEN"publishedAt*|date-timehasUnpublishedChanges*booleanparts*array<>curl -X POST 'https://api.shyni.io/api/v1/catalog/publish' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \ -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13'Response 200
The publish state after publishing.
{ "visibility": "NEVER_PUBLISHED", "publishedAt": "2019-08-24T14:15:22Z", "hasUnpublishedChanges": true, "parts": [ { "part": "CATALOG", "hasUnpublishedChanges": true, "sections": [ { "key": "kapacita", "changes": 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 409
The request is well-formed but the studio's current state forbids it.
{ "code": "CONFLICT", "message": "The voucher cannot be deactivated because it is not active."}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."}