A TanStack Query query hook with data from the Shopper Promotions getPromotionsForCampaign
endpoint.
apiOptions - Options to pass through to commerce-sdk-isomorphic
, with null
accepted for unset API parameters.
queryOptions - TanStack Query query options, with enabled
by default set to check that all required API parameters have been set.
commerce-sdk-isomorphic
documentation for more information on the parameters and returned data type.useQuery
reference for more information about the return value.
Handles get promotion by filter criteria. Returns an array of enabled promotions matching the specified filter criteria. In the request URL, you must provide a campaign_id parameter, and you can optionally specify a date range by providing start_date and end_date parameters. Both parameters are required to specify a date range, as omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled promotions, since the server does not consider promotion qualifiers or schedules.