Create a showcase
/showcasesCreates a showcase or a showcase group. New showcases and groups are always created with the draft status.
Showcases follow a two-level hierarchy: groups exist only at the top level and can contain showcases. To create a showcase inside a group, set parent_id to the group's public ID; if parent_id does not reference a group, the request is rejected with hierarchy_violation. A showcase created inside a group is always created with the showcase kind.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
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.
length <= 64Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/showcases" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "kind": "group", "name": "string" }'{ "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" }}List showcases GET
Lists showcases and showcase groups in the account, ordered by position and paginated with a cursor. By default, only top-level items are returned; use `parent_id` to list the showcases inside a group. The collection can also be filtered by `status`, `kind`, and name (`q`). Set `deleted=true` to list showcases in the trash instead of active ones. Credentials limited to specific showcases only see those showcases.
Reorder showcases PUT
Sets the display order of the showcases at one level of the hierarchy: the top level when `parent_id` is omitted, or the showcases inside the group identified by `parent_id`. The request must contain the complete set of showcase IDs at that level. If the supplied set does not match, the request is rejected with `order_set_mismatch` and the existing order remains unchanged.