Orders API

Handle checkout flows, manage order history, and control payment state transitions.

POST/client/v1/orders

Create Order

Initiate a new purchase. Requires authenticated user session.

Request BodyJSON

itemsRequired · Array

List of product variant IDs and quantities.

shipping_address_idRequired · String

ID of the customer's saved address.

gatewayRequired · String

Payment gateway code (e.g., cod, zalopay).

Sample Request

{
  "items": [
    { "variant_id": 7070350562, "quantity": 1 }
  ],
  "shipping_address_id": 1000000001,
  "gateway": "cod"
}

Success Response

201 Created

{
  "success": true,
  "data": {
    "id": 1234567890,
    "total_price": 4995000,
    "status": "open",
    "payment_status": "pending"
  }
}

GET/client/v1/orders/:id

Order Detail

Track order status, items, and payment information.

Request BodyJSON

idRequired · String

The 10-digit numeric ID of the order.

Sample Request

// GET /client/v1/orders/1234567890

Success Response

200 OK

{
  "success": true,
  "data": {
    "id": 1234567890,
    "order_number": "CM-45678",
    "items": [...],
    "shipping_address": {...},
    "timeline": [...]
  }
}

POST/client/v1/orders/cancel

Cancel Order

Request cancellation of an order. Only allowed for 'draft' or 'open' orders.

Request BodyJSON

idRequired · String

The 10-digit numeric ID of the order.

reasonOptional · String

Optional reason for cancellation.