A valid request URL is required to generate request examples{
"surface_id": "<string>",
"context": "product",
"market_id": "<string>",
"available_markets": [
"<string>"
],
"generated_at": "<string>",
"shuffle_seed": 123,
"slots": [
{
"position": 123,
"product_id": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Compose a recommendation surface
Composes a surface by id (or an unsaved draft of it) from the merchant’s current candidate pools, as the storefront would, and returns the product id per slot with the shuffle seed used. Pass anchor for a product or category surface and recent_views to exercise history-seeded steps. Use it to test what shoppers would see; for the editor’s saved-surface preview by name, see the surface preview routes. Read-only: nothing is written or recomputed.
A valid request URL is required to generate request examples{
"surface_id": "<string>",
"context": "product",
"market_id": "<string>",
"available_markets": [
"<string>"
],
"generated_at": "<string>",
"shuffle_seed": 123,
"slots": [
{
"position": 123,
"product_id": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
Body
11Show child attributes
Show child attributes
1Show child attributes
Show child attributes
11 <= x <= 1000 <= x <= 4294967295Show child attributes
Show child attributes
Response
The composed slots, dense from position 0.
Was this page helpful?