Skip to main content

Status List Functions

Retrieve all registered statuses from the OMS configuration.

Import​

import {
  getOrderStatusList,
  getPaymentStatusList,
  getShipmentStatusList
} from '@evershop/evershop/oms/services';

Functions​

getOrderStatusList​

getOrderStatusList(): Record<string, OrderStatus>

Returns all registered order statuses.

getPaymentStatusList​

getPaymentStatusList(): Record<string, PaymentStatus>

Returns all registered payment statuses.

getShipmentStatusList​

getShipmentStatusList(): Record<string, ShipmentStatus>

Returns all registered shipment statuses.

Examples​

import { getPaymentStatusList } from '@evershop/evershop/oms/services';

const statuses = getPaymentStatusList();
// {
//   pending: { name: 'Pending', badge: 'default', isDefault: true },
//   paid: { name: 'Paid', badge: 'success' },
//   ...
// }

See Also​