Run an allow-listed Shopify Admin GraphQL operation for the merchant

Error

A valid request URL is required to generate request examples

{
  "data": "<unknown>",
  "errors": [
    "<unknown>"
  ],
  "extensions": "<unknown>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

POST

shopify

proxy

{merchant_id}

admin-api

graphql.json

Error

A valid request URL is required to generate request examples

{
  "data": "<unknown>",
  "errors": [
    "<unknown>"
  ],
  "extensions": "<unknown>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

Path Parameters

merchant_id

string

required

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

Body

application/json

operationName

string

required

Must name one of the portal's allow-listed Admin API operations; anything else is refused with 403.

Minimum string length: 1

query

string

required

The GraphQL document; must match the allow-listed one.

Minimum string length: 1

variables

object

Show child attributes

{key}

any

Response

Shopify's response.

Shopify's GraphQL response body, forwarded verbatim.

data

any

errors

any[]

extensions

any

{key}

any