Storefront

Discard the unpublished page changes

DELETE
/api/v1/storefront/draft

Reverts every STOREFRONT section whose draft differs from the live version back to the live version - the undo of everything written since the last POST /storefront/publish, in one transaction. The studio must already be published. Not audited, as on the admin. Requires the storefront:write scope and an Idempotency-Key header.

Authorization

ApiKeyAuth storefront: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: storefront: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

Response Body

The publish state after the discard.

application/json
  1. response
visibility*string
Value in"NEVER_PUBLISHED""PUBLISHED""HIDDEN"
publishedAt*|
Formatdate-time
hasUnpublishedChanges*boolean
parts*array<>
Example Request
curl -X DELETE 'https://api.shyni.io/api/v1/storefront/draft' \  -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \  -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13'

Response 200

The publish state after the discard.

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