A valid request URL is required to generate request examples{
"client_name": "<string>",
"client_id": "<string>",
"redirect_to": {
"kind": "loopback",
"host": "<string>",
"scheme": "<string>"
},
"scopes": [
"depict:read"
],
"shop": "<string>",
"merchant_id": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"client_name": "<string>",
"redirect_to": {
"kind": "loopback",
"host": "<string>",
"scheme": "<string>"
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}An AI assistant's pending connection request, for the consent panel
Reads the request an MCP client (an AI assistant such as Claude Code) parked when it started signing in to a store’s endpoint: which client asks, where approving sends the browser, for which scopes, on which store. The Settings page calls it with the link’s mcp_txn to render the consent panel, then POST /mcp/consent to approve. Read-only; a request lasts 10 minutes.
A valid request URL is required to generate request examples{
"client_name": "<string>",
"client_id": "<string>",
"redirect_to": {
"kind": "loopback",
"host": "<string>",
"scheme": "<string>"
},
"scopes": [
"depict:read"
],
"shop": "<string>",
"merchant_id": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"client_name": "<string>",
"redirect_to": {
"kind": "loopback",
"host": "<string>",
"scheme": "<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
The mcp_txn parameter of the Settings link the assistant's sign-in opened.
^[A-Za-z0-9_-]{20,}$Response
The pending request.
The name the assistant registered under, e.g. Claude Code; null when it gave none. Anyone can register any name: redirect_to is what identifies where the code goes.
The OAuth client id the assistant registered.
Where approving sends the browser, and with it the authorization code, read from the redirect URI the client registered: its name is free text, this is where the code goes. loopback: an app on this computer (http or https on localhost, 127.0.0.1 or [::1]); https: a website; http: a website without TLS; custom: an app's own URL scheme, with no host.
- Option 1
- Option 2
Show child attributes
Show child attributes
What it asks for that Depict grants: depict:read reads the store's data, depict:write changes it.
depict:read, depict:write The store's myshopify domain; null when it has none.
The store the assistant would act on.
Was this page helpful?