Function usePromotions

  • Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters. Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.

    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

    Parameters

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

    Returns UseQueryResult<PromotionResult, unknown>

    A TanStack Query query hook with data from the Shopper Promotions getPromotions endpoint.

Settings

Member Visibility

Theme