Developers
Showcases9

Reorder showcases

PUT/showcases/order

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.

Discover the required set through GET /showcases with the same parent_id (omit it for the top level), following every cursor page without narrowing filters such as status, kind or search. A fully paginated list is still limited by credential visibility; verify that the credential can read the entire required set before reordering. On order_set_mismatch, re-read the set and check scope and visibility instead of blindly retrying stale IDs.

The response returns the complete reordered collection in a single response, including collections larger than 200 items. This reorder response is not paginated.

Authorization

AuthorizationBearer <token>

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

In: header

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.

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

curl -X PUT "https://example.com/showcases/order" \  -H "Content-Type: application/json" \  -d '{    "ids": [      "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"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Create a showcase POST

Creates 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.

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`.