Error

A valid request URL is required to generate request examples

{
  "redirect_to": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "client_name": "<string>",
  "redirect_to": {
    "kind": "loopback",
    "host": "<string>",
    "scheme": "<string>"
  }
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

API Reference

Approve an AI assistant's connection request

Approves a request read with GET /mcp/consent: grants the MCP client the scopes it asked for and the user approved, on the request’s store, and answers the client’s OAuth redirect. Navigate the top-level window to redirect_to to finish connecting. Side effects: one OAuth grant for the store, replacing the approving user’s earlier grants of the same client (other users’ grants of it stay); it lasts 30 days, or 24 hours when a superuser approves; the client’s registration is renewed for 90 days; the request is used up (approving it again answers 404).

POST

/

mcp

/

consent

Error

A valid request URL is required to generate request examples

{
  "redirect_to": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "client_name": "<string>",
  "redirect_to": {
    "kind": "loopback",
    "host": "<string>",
    "scheme": "<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.

Body

application/json

txn

string

required

The mcp_txn parameter of the Settings link the assistant's sign-in opened.

Pattern: ^[A-Za-z0-9_-]{20,}$

scopes

string[]

required

The scopes the user approved; only those the assistant also asked for are granted.

Response

Granted; follow redirect_to.

redirect_to

string

required

The assistant's OAuth redirect, carrying the authorization code; navigate the top-level window there to finish connecting.