Reorder showcase products
/showcases/{showcase_id}/products/orderSets the display order of the products in a showcase. Requires both the products.update and showcases.update permissions.
The request must contain the complete set of product IDs currently in the showcase. If the supplied set does not match, the request is rejected with order_set_mismatch and the existing order remains unchanged. This operation does not move products between showcases; to change a product's showcase, update the product's showcase_id.
Send the showcase's current ETag value in the If-Match header to avoid overwriting a newer version.
Discover the required set through GET /showcases/{showcase_id}/products, 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.
Credential: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Public ID of the showcase, prefixed with shw_.
Header Parameters
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.
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.
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
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/showcases/string/products/order" \ -H "Content-Type: application/json" \ -d '{ "ids": [ "string" ] }'{ "data": [ { "id": "string", "name": "string", "object": "product", "position": 0, "status": "published" } ], "page": { "limit": 1, "next_cursor": "string", "prev_cursor": "string" }}