Fulfillment Service

FulfillmentServiceContext

• admin

  An admin context for the fulfillment service request. Returned only if there is a session for the shop.

  AdminApiContext

• payload

  The payload from the fulfillment service request.

  FulfillmentServicePayload

• session

  A session with an offline token for the shop. Returned only if there is a session for the shop.

  unknown

AdminApiContext

Provides utilities that apps can use to make requests to the Admin API.

• graphql

  Methods for interacting with the Shopify Admin GraphQL API

  GraphQLClient<AdminOperations>

GraphQLClient

• query

  Operation extends keyof Operations

• options

  GraphQLQueryOptions<Operation, Operations>

interface Promise<T> {
    /**
     * Attaches callbacks for the resolution and/or rejection of the Promise.
     * @param onfulfilled The callback to execute when the Promise is resolved.
     * @param onrejected The callback to execute when the Promise is rejected.
     * @returns A Promise for the completion of which ever callback is executed.
     */
    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;

    /**
     * Attaches a callback for only the rejection of the Promise.
     * @param onrejected The callback to execute when the Promise is rejected.
     * @returns A Promise for the completion of the callback.
     */
    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>;
}, interface Promise<T> {}, Promise: PromiseConstructor, interface Promise<T> {
    readonly [Symbol.toStringTag]: string;
}, interface Promise<T> {
    /**
     * Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
     * resolved value cannot be modified from the callback.
     * @param onfinally The callback to execute when the Promise is settled (fulfilled or rejected).
     * @returns A Promise for the completion of the callback.
     */
    finally(onfinally?: (() => void) | undefined | null): Promise<T>;
}

GraphQLQueryOptions

• apiVersion

  The version of the API to use for the request.

  unknown

• headers

  Additional headers to include in the request.

  Record<string, any>

• signal

  An optional AbortSignal to cancel the request.

  AbortSignal

• tries

  The total number of times to try the request if it fails.

  number

• variables

  The variables to pass to the operation.

  ApiClientRequestOptions<Operation, Operations>

FulfillmentServicePayload

Record<string, any> & {
  kind: string;
}