Interface AdminRequestOptions<TResult, TVariables>

interface AdminRequestOptions<TResult, TVariables extends Variables> {
    preferredBehaviour?: RequestModeInput;
    query: TypedDocumentNode<TResult, TVariables>;
    responseOptions?: GraphQLResponseOptions<TResult>;
    session: AdminSession;
    variables?: TVariables;
    version?: string;
}

Type Parameters

TResult
TVariables extends Variables

Index

Properties

preferredBehaviour? query responseOptions? session variables? version?

Properties

`Optional`preferredBehaviour

preferredBehaviour?: RequestModeInput

Custom request behaviour for retries and timeouts.

query

query: TypedDocumentNode<TResult, TVariables>

GraphQL query to execute.

`Optional`responseOptions

responseOptions?: GraphQLResponseOptions<TResult>

Control how API responses will be handled.

session

session: AdminSession

Shopify admin session including token and Store FQDN.

`Optional`variables

variables?: TVariables

GraphQL variables to pass to the query.

`Optional`version

version?: string

API version.