Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

OrderStatus Container

Version: 3.2.0

The OrderStatus container provides the following configuration options:

ParameterTypeReq?Description
classNamestringNoAdditional CSS classes to apply to the container
orderDataOrderDataModelNoA structured object containing order data. Used as an initial value or fallback if data is not fetched from the backend.
statusTitlestringNoCustom title text to display above the order status indicator.
statusStatusEnumPropsNoThe current order status value used to display the status indicator.
routeCreateReturnfunctionNoFunction that returns the URL for the create return page.
routeOnSuccessfunctionNoFunction that returns the URL to redirect to after a successful action.
onErrorfunctionNoCallback function triggered when error

This container exposes the following slots for customization:

SlotTypeRequiredDescription
OrderActionsSlotPropsYes

The following example demonstrates how to use the OrderStatus container:

import { render as provider } from '@dropins/storefront-order/render.js';
import { OrderStatus } from '@dropins/storefront-order/containers/OrderStatus.js';
await provider.render(OrderStatus, {
className: "Example Name",
orderData: orderData,
statusTitle: "Example Title",
slots: {
// Add custom slot implementations here
}
})(block);