Error

A valid request URL is required to generate request examples

null

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

API Reference

Record that a Shopify staff member opened the app

Called once per app load from inside Shopify admin with the Shopify session token as the bearer. Answers JSON null straight after auth; behind the response it exchanges the token for an online grant, upserts the staff member’s verified email (read back by /users/me), and sends shopify_app_launched plus PostHog group/identify events. Not useful from a staff (Access) identity: it needs a Shopify session token signed by the public app.

POST

arm

launch

Error

A valid request URL is required to generate request examples

null

{
  "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.

Query Parameters

merchant_id

string

required

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

Response

Accepted; the launch work runs behind the response.