Skip to main content

registerPSOStatusMapping

Register a PSO (Payment-Shipment-Order) mapping that determines how the order status is automatically resolved when payment or shipment status changes.

Import​

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

Syntax​

registerPSOStatusMapping(
  paymentStatus: string | '*',
  shipmentStatus: string | '*',
  orderStatus: string
): void

Parameters​

paymentStatus — Payment status ID or '*' to match any payment status.

shipmentStatus — Shipment status ID or '*' to match any shipment status.

orderStatus — The order status to set when both conditions match.

Examples​

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

export default async () => {
  // Specific match
  registerPSOStatusMapping('paid', 'delivered', 'completed');

  // Wildcard shipment
  registerPSOStatusMapping('refunded', '*', 'closed');

  // Wildcard payment
  registerPSOStatusMapping('*', 'canceled', 'canceled');
};

See Also​