Error
A valid request URL is required to generate request examples{
"messages": [
{
"id": 123,
"program_id": "<string>",
"surface": "<string>",
"payload": {
"title": "<string>",
"body": "<string>",
"buttons": [
{
"label": "<string>",
"href": "<string>",
"primary": true
}
]
},
"queued_at": "<string>",
"seen_at": "<string>",
"clicked_at": "<string>"
}
],
"template": {
"version": 123,
"setup": {
"headline": {
"title": "<string>",
"body": "<string>"
},
"steps": {},
"hidden": [
"<string>"
],
"order": [
"<string>"
]
},
"search_setup": {
"headline": {
"title": "<string>",
"body": "<string>"
},
"steps": {},
"hidden": [
"<string>"
],
"order": [
"<string>"
]
},
"recommendations_setup": {
"headline": {
"title": "<string>",
"body": "<string>"
},
"steps": {},
"hidden": [
"<string>"
],
"order": [
"<string>"
]
}
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}API Reference
The merchant's open onboarding messages and setup-guide copy
Lists the in-app messages the onboarding programme queued for the merchant that are neither dismissed nor expired, plus the copy (headline, per-step text, hidden steps, order) of the Home, Search and Recommendations setup guides from the shared back-office template. Read-only and uncached; the portal polls it while Home is open.
GET
/
onboarding-messages
Error
A valid request URL is required to generate request examples{
"messages": [
{
"id": 123,
"program_id": "<string>",
"surface": "<string>",
"payload": {
"title": "<string>",
"body": "<string>",
"buttons": [
{
"label": "<string>",
"href": "<string>",
"primary": true
}
]
},
"queued_at": "<string>",
"seen_at": "<string>",
"clicked_at": "<string>"
}
],
"template": {
"version": 123,
"setup": {
"headline": {
"title": "<string>",
"body": "<string>"
},
"steps": {},
"hidden": [
"<string>"
],
"order": [
"<string>"
]
},
"search_setup": {
"headline": {
"title": "<string>",
"body": "<string>"
},
"steps": {},
"hidden": [
"<string>"
],
"order": [
"<string>"
]
},
"recommendations_setup": {
"headline": {
"title": "<string>",
"body": "<string>"
},
"steps": {},
"hidden": [
"<string>"
],
"order": [
"<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>.
Was this page helpful?

