Search Documentation

Search for a documentation page...

Orders

Browse and manage orders with the Commerce SDK.

Browse Orders

Fetch a paginated list of orders:

const orders = await commerce.orderBrowse({
  limit: 20,
  offset: 0,
});

Parameters

ParameterTypeDescription
limitnumberMax items to return
offsetnumberNumber of items to skip

Get an Order

Fetch a single order by ID:

const order = await commerce.orderGet({ id: "order_abc123" });

Response

{
  id: "order_abc123",
  status: "completed",
  totalAmount: "5000",
  currency: "usd",
  items: [
    {
      variantId: "var_123",
      quantity: 2,
      price: "2500",
      product: { name: "Classic Tee", ... },
    }
  ],
  customer: {
    id: "cust_xyz",
    email: "customer@example.com",
    name: "Jane Doe",
  },
  shippingAddress: { ... },
  createdAt: "2024-01-15T10:30:00Z",
}

Update an Order

Update order status or details:

const updated = await commerce.orderUpdate(
  { id: "order_abc123" },
  { status: "shipped" },
);

Customer Orders

Fetch orders for a specific customer:

const customerOrders = await commerce.customerOrdersBrowse({
  id: "cust_xyz",
});

Order Status Flow

Orders follow this status progression:

  1. pending — order created, payment processing
  2. completed — payment confirmed
  3. shipped — order shipped to customer
  4. delivered — order delivered
  5. cancelled — order cancelled
  6. refunded — payment refunded
PreviousCartCommerce SDKNextCollectionsCommerce SDK