InstantProductsActions

This is for:

Developer
Note

This component was introduced in version 2.74.0.

The instant products action creators.

See Dispatch Actions.

Loader Function

loadInstantProductsActions

Loads the commerce instant products reducer and returns the available instant products actions.

Parameters

  • engine: CommerceEngine

    The commerce engine.

Returns InstantProductsActionCreators: The instant products action creators.

InstantProductsActionCreators

clearExpiredProducts

Clears expired instant products.

Parameters

  • payload: CoreInstantProductPayload

    The action creator payload.

Returns PayloadAction<ClearExpiredInstantProductsPayload>: A dispatchable action.

promoteChildToParent

Promotes a child product to a parent product.

Parameters

Returns PayloadAction<PromoteChildToParentPayload>: A dispatchable action.

registerInstantProducts

Registers instant products.

Parameters

  • payload: CoreInstantProductPayload

    The action creator payload.

Returns PayloadAction<RegisterInstantProductPayload>: A dispatchable action.

updateInstantProductsQuery

Updates the query for instant products.

Parameters

Returns PayloadAction<UpdateInstantProductQueryPayload>: A dispatchable action.

PromoteChildToParentPayload

Properties

  • child: Omit<BaseProduct, 'children' | 'totalNumberOfChildren'>

  • query: string

    The initial basic query expression for instant products.

  • id: string

    The search box ID.

UpdateInstantProductQueryPayload

Properties

  • query: string

    The initial basic query expression for instant products.

  • id: string

    The search box ID.