• Preparing search index...
  • The search index is not available
@shopify/cli-kit
  • @shopify/cli-kit
  • node/api/admin
  • adminRequest

Function adminRequest

  • adminRequest<T>(
        query: string,
        session: AdminSession,
        variables?: GraphQLVariables,
    ): Promise<T>
  • Executes a GraphQL query against the Admin API.

    Type Parameters

    • T

    Parameters

    • query: string

      GraphQL query to execute.

    • session: AdminSession

      Shopify admin session including token and Store FQDN.

    • Optionalvariables: GraphQLVariables

      GraphQL variables to pass to the query.

    Returns Promise<T>

    The response of the query of generic type .

    • Defined in packages/cli-kit/src/public/node/api/admin.ts:34

Settings

Member Visibility
@shopify/cli-kit
  • Loading...

Generated using TypeDoc