Developers
Showcases9

List showcase products

GET/showcases/{showcase_id}/products

Lists the products in a showcase in summary form, ordered by position and paginated with a cursor. Requires both the showcases.read and products.read permissions.

Credentials limited to specific products only see those products.

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

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "position"
  • "-position"

Header Parameters

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/showcases/string/products"
{  "data": [    {      "id": "string",      "name": "string",      "object": "product",      "position": 0,      "status": "published"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Duplicate a showcase POST

Creates a copy of the showcase in the same account. Copying a showcase to a different account is not supported.

Reorder showcase products PUT

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