Skip to main content

updateShipmentStatus

Update the shipment status of an order.

Import​

import { updateShipmentStatus } from "@evershop/evershop/oms/services";

Syntax​

updateShipmentStatus(orderId: number, status: string, conn?: PoolClient): Promise<void>

Parameters​

orderId

Type: number

Order ID (not UUID).

status

Type: string

New shipment status.

conn (optional)

Type: PoolClient

Database connection. If not provided, creates new connection.

Return Value​

Returns Promise<void>.

Examples​

Basic Update​

import { updateShipmentStatus } from "@evershop/evershop/oms/services";

await updateShipmentStatus(123, 'shipped');

See Also​