• Preparing search index...
  • The search index is not available
@shopify/cli-kit
  • @shopify/cli-kit
  • node/api/business-platform
  • businessPlatformRequestDoc

Function businessPlatformRequestDoc

  • businessPlatformRequestDoc<TResult, TVariables extends Variables>(
        query: TypedDocumentNode<TResult, TVariables>,
        token: string,
        variables?: TVariables,
        cacheOptions?: CacheOptions,
    ): Promise<TResult>
  • Executes a GraphQL query against the Business Platform Destinations API. Uses typed documents.

    Type Parameters

    • TResult
    • TVariables extends Variables

    Parameters

    • query: TypedDocumentNode<TResult, TVariables>

      GraphQL query to execute.

    • token: string

      Business Platform token.

    • Optionalvariables: TVariables

      GraphQL variables to pass to the query.

    • OptionalcacheOptions: CacheOptions

      Cache options for the request. If not present, the request will not be cached.

    Returns Promise<TResult>

    The response of the query of generic type .

    • Defined in packages/cli-kit/src/public/node/api/business-platform.ts:56

Settings

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

Generated using TypeDoc