Interface RecommendationsActionCreator

The recommendations action creators.

interface RecommendationsActionCreator {
    fetchMoreRecommendations(
        payload: FetchRecommendationsPayload,
    ): AsyncThunkAction<
        null
        | QueryRecommendationsCommerceAPIThunkReturn,
        FetchRecommendationsPayload,
        AsyncThunkCommerceOptions<StateNeededByFetchRecommendations>,
    >;
    fetchRecommendations(
        payload: FetchRecommendationsPayload,
    ): AsyncThunkAction<
        QueryRecommendationsCommerceAPIThunkReturn,
        FetchRecommendationsPayload,
        AsyncThunkCommerceOptions<StateNeededByFetchRecommendations>,
    >;
    promoteChildToParent(
        payload: PromoteChildToParentPayload,
    ): { payload: PromoteChildToParentPayload; type: string };
    registerRecommendationsSlot(
        payload: SlotIdPayload,
    ): { payload: SlotIdPayload; type: string };
}

Index

Methods

fetchMoreRecommendations fetchRecommendations promoteChildToParent registerRecommendationsSlot

Methods

fetchMoreRecommendations

fetchMoreRecommendations(
    payload: FetchRecommendationsPayload,
): AsyncThunkAction<
    null
    | QueryRecommendationsCommerceAPIThunkReturn,
    FetchRecommendationsPayload,
    AsyncThunkCommerceOptions<StateNeededByFetchRecommendations>,
>
Fetches an additional page of recommendations and appends it to the current list.
Parameters
- payload: FetchRecommendationsPayload
  The action creator payload.
Returns AsyncThunkAction<
    null
    | QueryRecommendationsCommerceAPIThunkReturn,
    FetchRecommendationsPayload,
    AsyncThunkCommerceOptions<StateNeededByFetchRecommendations>,
>
A dispatchable action.
- Defined in packages/headless/src/features/commerce/recommendations/recommendations-actions-loader.ts:51

fetchRecommendations

fetchRecommendations(
    payload: FetchRecommendationsPayload,
): AsyncThunkAction<
    QueryRecommendationsCommerceAPIThunkReturn,
    FetchRecommendationsPayload,
    AsyncThunkCommerceOptions<StateNeededByFetchRecommendations>,
>
Fetches recommendations.
Parameters
- payload: FetchRecommendationsPayload
  The action creator payload.
Returns AsyncThunkAction<
    QueryRecommendationsCommerceAPIThunkReturn,
    FetchRecommendationsPayload,
    AsyncThunkCommerceOptions<StateNeededByFetchRecommendations>,
>
A dispatchable action.
- Defined in packages/headless/src/features/commerce/recommendations/recommendations-actions-loader.ts:37

promoteChildToParent

promoteChildToParent(
payload: PromoteChildToParentPayload,
): { payload: PromoteChildToParentPayload; type: string }
Promotes a child product to a parent product.
Parameters
- payload: PromoteChildToParentPayload
  The action creator payload.
Returns { payload: PromoteChildToParentPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/commerce/recommendations/recommendations-actions-loader.ts:65

registerRecommendationsSlot

registerRecommendationsSlot(
payload: SlotIdPayload,
): { payload: SlotIdPayload; type: string }
Registers a recommendations slot.
Parameters
- payload: SlotIdPayload
  The action creator payload.
Returns { payload: SlotIdPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/commerce/recommendations/recommendations-actions-loader.ts:75

Interface RecommendationsActionCreator

Index

Methods

Methods

fetchMoreRecommendations

Parameters

Returns AsyncThunkAction<
    null
    | QueryRecommendationsCommerceAPIThunkReturn,
    FetchRecommendationsPayload,
    AsyncThunkCommerceOptions<StateNeededByFetchRecommendations>,
>

fetchRecommendations

Parameters

Returns AsyncThunkAction<
    QueryRecommendationsCommerceAPIThunkReturn,
    FetchRecommendationsPayload,
    AsyncThunkCommerceOptions<StateNeededByFetchRecommendations>,
>

promoteChildToParent

Parameters

Returns { payload: PromoteChildToParentPayload; type: string }

registerRecommendationsSlot

Parameters

Returns { payload: SlotIdPayload; type: string }

Settings

On This Page

Interface RecommendationsActionCreator

Index

Methods

Methods

fetchMoreRecommendations

Parameters

Returns AsyncThunkAction< null | QueryRecommendationsCommerceAPIThunkReturn, FetchRecommendationsPayload, AsyncThunkCommerceOptions<StateNeededByFetchRecommendations>,>

fetchRecommendations

Parameters

Returns AsyncThunkAction< QueryRecommendationsCommerceAPIThunkReturn, FetchRecommendationsPayload, AsyncThunkCommerceOptions<StateNeededByFetchRecommendations>,>

promoteChildToParent

Parameters

Returns { payload: PromoteChildToParentPayload; type: string }

registerRecommendationsSlot

Parameters

Returns { payload: SlotIdPayload; type: string }

Settings

On This Page

Returns AsyncThunkAction<
null
| QueryRecommendationsCommerceAPIThunkReturn,
FetchRecommendationsPayload,
AsyncThunkCommerceOptions<StateNeededByFetchRecommendations>,
>

Returns AsyncThunkAction<
QueryRecommendationsCommerceAPIThunkReturn,
FetchRecommendationsPayload,
AsyncThunkCommerceOptions<StateNeededByFetchRecommendations>,
>