Interface InstantProductsActionCreators

The instant products action creators.

See Dispatch actions.

interface InstantProductsActionCreators {
    clearExpiredProducts(
        payload: CoreInstantProductPayload,
    ): { payload: CoreInstantProductPayload; type: string };
    promoteChildToParent(
        payload: PromoteChildToParentPayload,
    ): { payload: PromoteChildToParentPayload; type: string };
    registerInstantProducts(
        payload: CoreInstantProductPayload,
    ): { payload: CoreInstantProductPayload; type: string };
    updateInstantProductsQuery(
        payload: UpdateInstantProductQueryPayload,
    ): { payload: UpdateInstantProductQueryPayload; type: string };
}

Index

Methods

clearExpiredProducts promoteChildToParent registerInstantProducts updateInstantProductsQuery

Methods

clearExpiredProducts

clearExpiredProducts(
payload: CoreInstantProductPayload,
): { payload: CoreInstantProductPayload; type: string }
Clears expired instant products.
Parameters
- payload: CoreInstantProductPayload
  The action creator payload.
Returns { payload: CoreInstantProductPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/commerce/instant-products/instant-products-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/instant-products/instant-products-actions-loader.ts:47

registerInstantProducts

registerInstantProducts(
payload: CoreInstantProductPayload,
): { payload: CoreInstantProductPayload; type: string }
Registers instant products.
Parameters
- payload: CoreInstantProductPayload
  The action creator payload.
Returns { payload: CoreInstantProductPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/commerce/instant-products/instant-products-actions-loader.ts:57

updateInstantProductsQuery

updateInstantProductsQuery(
payload: UpdateInstantProductQueryPayload,
): { payload: UpdateInstantProductQueryPayload; type: string }
Updates the query for instant products.
Parameters
- payload: UpdateInstantProductQueryPayload
  The action creator payload.
Returns { payload: UpdateInstantProductQueryPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/commerce/instant-products/instant-products-actions-loader.ts:67