Skip to main content

Order Loader Functions

Load complete order data including items, shipping address, and billing address.

Import​

import { loadOrderById, loadOrderByUUID } from '@evershop/evershop/oms/services';

loadOrderById​

loadOrderById(orderId: number): Promise<OrderDetails | null>

Load an order by its database ID.

loadOrderByUUID​

loadOrderByUUID(uuid: string): Promise<OrderDetails | null>

Load an order by its UUID.

Return Type​

type OrderDetails = OrderRow & {
  items: OrderItemRow[];
  shippingAddress: OrderAddressRow | null;
  billingAddress: OrderAddressRow | null;
};

Examples​

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

const order = await loadOrderById(2070);
if (order) {
  console.log(order.order_number);       // '12070'
  console.log(order.items.length);        // 3
  console.log(order.shippingAddress);     // { full_name: 'John', ... }
}

See Also​