Class OrdersModule

Wraps the /orders API endpoints (merchant-authenticated).

Example

const { orders } = await hadawi.orders.list();
const { order, contributions } = await hadawi.orders.get(orders[0].id);
await hadawi.orders.fulfill(order.id);
await hadawi.orders.deliver(order.id);

Constructors

constructor

Methods

list get fulfill deliver

Constructors

constructor

Methods

list

get

  • get(orderId: string): Promise<OrderDetail>

    Fetch a single order with its full contribution breakdown. The order.session field includes the item snapshot and funding stats.

    Parameters

    • orderId: string

    Returns Promise<OrderDetail>

fulfill

  • fulfill(orderId: string): Promise<Order>

    Transition the order from funded / notified → fulfilling. Call this when you have confirmed the order and started processing it.

    Parameters

    • orderId: string

    Returns Promise<Order>

deliver

  • deliver(orderId: string): Promise<Order>

    Transition the order from fulfilling → delivered. Call this once the item has been shipped / handed over.

    Parameters

    • orderId: string

    Returns Promise<Order>

Settings

Member Visibility

On This Page

Constructors
Methods