The install screen's welcome carousel

Error

A valid request URL is required to generate request examples

{
  "version": 123,
  "slides": [
    {
      "id": "<string>",
      "title": "<string>",
      "asset": "<string>",
      "image_url": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

GET

welcome-slides

Error

A valid request URL is required to generate request examples

{
  "version": 123,
  "slides": [
    {
      "id": "<string>",
      "title": "<string>",
      "asset": "<string>",
      "image_url": "<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.

Response

The saved slides.

version

integer

required

0 when the back office never saved: the app keeps its built-in carousel.

slides

object[]

required

Carousel order; only slides switched on in the back office (at most 12).

Show child attributes