Developers
Showcases9

Update a showcase

PATCH/showcases/{showcase_id}

Updates an existing showcase. Only the fields present in the request are changed.

Updating status requires the showcases.publish permission in addition to showcases.update. Setting parent_id moves the showcase into a group, or to the top level when null; moves that would break the two-level hierarchy are rejected with hierarchy_violation. Setting deleted to false restores a showcase from the trash.

position is 1-based within the showcase's level, in the new level when parent_id changes; a value greater than the number of showcases at that level places the showcase at the end. A showcase moved to another level without position is placed at the end.

Replicated showcases accept only status; a request that includes any other field returns the replica_readonly error code.

Send the current ETag value in the If-Match header to avoid overwriting changes made since the showcase was retrieved.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

showcase_id*string

Public ID of the showcase, prefixed with shw_.

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

If-Match?string

Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. * matches the current revision. Any other value fails with 400 and the if_match_invalid error code. When omitted, the update is applied to the current revision.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/showcases/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "deleted": true,    "id": "string",    "image": "string",    "kind": "group",    "name": "string",    "object": "showcase",    "parent_id": "string",    "position": 0,    "products_count": 0,    "revision": "string",    "status": "published",    "updated_at": "2019-08-24T14:15:22Z"  }}

Retrieve a showcase GET

Retrieves a showcase by its public ID, including the number of products it contains. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the showcase to avoid overwriting a newer version. Showcases that do not exist or are not accessible with the current credentials return `404 Not Found`.

Delete a showcase DELETE

Moves the showcase to the trash. Its child showcases, the products in the showcase, and its copies in replicated accounts are moved to the trash along with it. Replicated showcases are read-only and cannot be deleted. Attempts to delete them return the `replica_readonly` error code.