Preview an unsaved draft of a surface

Error

A valid request URL is required to generate request examples

{
  "surface_id": "<string>",
  "context": "product",
  "market_id": "<string>",
  "available_markets": [
    "<string>"
  ],
  "generated_at": "<string>",
  "slots": [
    {
      "position": 123,
      "product_id": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

POST

recommendations

surfaces

{surface_name}

preview

Error

A valid request URL is required to generate request examples

{
  "surface_id": "<string>",
  "context": "product",
  "market_id": "<string>",
  "available_markets": [
    "<string>"
  ],
  "generated_at": "<string>",
  "slots": [
    {
      "position": 123,
      "product_id": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

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.

Path Parameters

surface_name

string

required

The surface's URL-safe name.

Pattern: ^[a-z0-9_-]+$

Query Parameters

merchant_id

string

required

Lite merchant id, e.g. shopify-<shop id>.

anchor_id

string

Product or collection id for an anchored surface; empty = absent.

market_id

string

Market to compose for; absent or empty = the default market.

Body

application/json

surface

object

The editor's unsaved surface (its name must be the path's); absent = preview the saved one.

Show child attributes

Response

The composed slots, dense from position 0, pins included.

surface_id

string

required

context

enum<string>

required

Available options:

product,

category,

any

market_id

string

required

available_markets

string[]

required

generated_at

string

required

slots

object[]

required

Show child attributes