Function useGiftCertificate

useGiftCertificate(apiOptions, queryOptions?): UseQueryResult<GiftCertificate, unknown>
Action to retrieve an existing gift certificate.

Parameter
apiOptions - Options to pass through to commerce-sdk-isomorphic, with null accepted for unset API parameters.

Parameter
queryOptions - TanStack Query query options, with enabled by default set to check that all required API parameters have been set.

See
- Salesforce Developer Center for more information about the API endpoint.
- commerce-sdk-isomorphic documentation for more information on the parameters and returned data type.
- TanStack Query useQuery reference for more information about the return value.
Parameters
- apiOptions: NullableParameters<{
      body: GiftCertificateRequest;
      headers?: {
          [key: string]: string;
      };
      parameters?: {
          organizationId?: string;
          siteId?: string;
      };
  }>
- queryOptions: ApiQueryOptions<{
      (options): Promise<GiftCertificate>;
      <T>(options, rawResponse?): Promise<T extends true
          ? Response
          : GiftCertificate>;
  }> = {}
Returns UseQueryResult<GiftCertificate, unknown>
A TanStack Query query hook with data from the Shopper Gift Certificates getGiftCertificate endpoint.
- Defined in src/hooks/ShopperGiftCertificates/query.ts:27