import { Oms } from '@broadleaf/admin-components';
const { FulfillmentAction } = Oms.components;
Oms
components
import { Oms } from '@broadleaf/admin-components';
const { FulfillmentAction } = Oms.components;
Component Name | Description |
---|---|
|
Used to render a button that executes a fulfillment-related action such as creating a return or printing a shipping label. |
|
Renders a modal that allows the user to create a fulfillment return. |
|
Renders a component that contains a summary of fulfillment item information. |
|
Renders a modal that contains a summary of fulfillment item information that will qualify for the status change action. |
|
View component that renders the Order Fulfillment screen and its components. This component provides a consolidated view of an order fulfillment and its relationships. |
|
Renders the Items section within the Order Fulfillment view. |
|
Renders the Notes section within the Order Fulfillment view. |
|
View component that renders the Order details screen. This component provides a consolidated view of an order and its relationships. |
|
Renders the Payments section within the Order Fulfillment view. |
|
Renders a clickable label which, when acted upon, will render a popover with the provided content. |
|
Renders the Returns section within the Order Fulfillment view. |
|
Renders the Summary section within the Order Fulfillment view. |
constants
import { Oms } from '@broadleaf/admin-components';
const { ReturnAuthorizationItemReturnType } = Oms.constants;
Component Name | Description |
---|---|
|
Constants that indicate if a return should or should not result in a refund being issued. |
|
Constants that indicate if the status of the return process is pending, if some items are confirmed, if all items are confirmed, and if the return was cancelled or completed. |
|
Constants that indicate if the status of the return confirmation is pending or completed. |
contexts
import { Oms } from '@broadleaf/admin-components';
const { StatusChangeContext } = Oms.contexts;
Component Name | Description |
---|---|
|
Defines a context that contains common info to share for the various |
elements
import { Oms } from '@broadleaf/admin-components';
const { CreateReturnAction } = Oms.elements;
Component Name | Description |
---|---|
|
Renders an action component that allows the user to create a return via a modal, as well as related hooks and contexts. |
|
Renders a component for paginating order view sections. |
|
Renders fields for the order or fulfillment order status change operation that is being executed. |
hooks
import { Oms } from '@broadleaf/admin-components';
const { useFulfillmentState } = Oms.hooks;
Component Name | Description |
---|---|
|
A hook used for providing the state for the fulfillment view. |
|
A hook that returns the initial form values for the status change form. |
utils
import { Oms } from '@broadleaf/admin-components';
const { FulfillmentItemUtils } = Oms.utils;
Component Name | Description |
---|---|
|
A utilities helper class that fetches fulfillment item details such as name, SKU, prices, totals, and attributes, among others. |
|
A utilities helper class that fetches fulfillment and order details such as order number, customer details, totals, and fulfillment method, among others. |
|
A utilities helper class that fetches order item details and finds an order item in a list that matches the passed predicate. |
|
A utilities helper class that retrieves the status options from the fulfillment and order view metadata. |