Function useBasket

  • Gets a basket.

    Parameters

    • apiOptions: NullableParameters<{
          headers?: {
              [key: string]: string;
          };
          parameters?: {
              basketId?: string;
              locale?: string;
              organizationId?: string;
              siteId?: string;
          };
      }>
    • queryOptions: ApiQueryOptions<{
          (options?): Promise<Basket>;
          <T>(options?, rawResponse?): Promise<T extends true
              ? Response
              : Basket>;
      }> = {}

    Returns UseQueryResult<Basket, unknown>

    A TanStack Query query hook with data from the Shopper Baskets getBasket endpoint.

    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

Settings

Member Visibility

Theme