Broadleaf Microservices
  • v1.0.0-latest-prod

Order Management System (OMS)

Export Package Name: Oms

Components

Export Sub-Package Name: components

How to pull in the module and its components
import { Oms } from '@broadleaf/admin-components';

const { FulfillmentAction } = Oms.components;
Component Name Description

FulfillmentAction

Used to render a button that executes a fulfillment-related action such as creating a return or printing a shipping label.

FulfillmentCreateReturnModal

Renders a modal that allows the user to create a fulfillment return.

FulfillmentItemSummary

Renders a component that contains a summary of fulfillment item information.

FulfillmentStatusChangeModal

Renders a modal that contains a summary of fulfillment item information that will qualify for the status change action.

FulfillmentView

View component that renders the Order Fulfillment screen and its components. This component provides a consolidated view of an order fulfillment and its relationships.

ItemsOrderViewSection

Renders the Items section within the Order Fulfillment view.

NotesOrderViewSection

Renders the Notes section within the Order Fulfillment view.

OrderView

View component that renders the Order details screen. This component provides a consolidated view of an order and its relationships.

PaymentsOrderViewSection

Renders the Payments section within the Order Fulfillment view.

PopoverLabel

Renders a clickable label which, when acted upon, will render a popover with the provided content.

ReturnsOrderViewSection

Renders the Returns section within the Order Fulfillment view.

SummaryOrderViewSection

Renders the Summary section within the Order Fulfillment view.


Constants

Export Sub-Package Name: constants

How to pull in the module and its components
import { Oms } from '@broadleaf/admin-components';

const { ReturnAuthorizationItemReturnType } = Oms.constants;
Component Name Description

ReturnAuthorizationItemReturnType

Constants that indicate if a return should or should not result in a refund being issued.

ReturnAuthorizationStatus

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.

ReturnConfirmationStatus

Constants that indicate if the status of the return confirmation is pending or completed.


Contexts

Export Sub-Package Name: contexts

How to pull in the module and its components
import { Oms } from '@broadleaf/admin-components';

const { StatusChangeContext } = Oms.contexts;
Component Name Description

StatusChangeContext

Defines a context that contains common info to share for the various StatusChange components.


Elements

Export Sub-Package Name: elements

How to pull in the module and its components
import { Oms } from '@broadleaf/admin-components';

const { CreateReturnAction } = Oms.elements;
Component Name Description

CreateReturnAction

Renders an action component that allows the user to create a return via a modal, as well as related hooks and contexts.

SectionPagination

Renders a component for paginating order view sections.

StatusChangeFields

Renders fields for the order or fulfillment order status change operation that is being executed.


Hooks

Export Sub-Package Name: hooks

How to pull in the module and its components
import { Oms } from '@broadleaf/admin-components';

const { useFulfillmentState } = Oms.hooks;
Component Name Description

useFulfillmentState

A hook used for providing the state for the fulfillment view.

useInitialValuesForCreateReturnAction

A hook that returns the initial form values for the status change form.


Utilities

Export Sub-Package Name: utils

How to pull in the module and its components
import { Oms } from '@broadleaf/admin-components';

const { FulfillmentItemUtils } = Oms.utils;
Component Name Description

FulfillmentItemUtils

A utilities helper class that fetches fulfillment item details such as name, SKU, prices, totals, and attributes, among others.

FulfillmentUtils

A utilities helper class that fetches fulfillment and order details such as order number, customer details, totals, and fulfillment method, among others.

OrderItemUtils

A utilities helper class that fetches order item details and finds an order item in a list that matches the passed predicate.

OrderStatusUtils

A utilities helper class that retrieves the status options from the fulfillment and order view metadata.