Orders

List, retrieve, and cancel orders. Orders are created through the checkout flow.

GET/api/v1/orders

List Orders

Returns orders for the authenticated customer.

Example Request

curl

curl https://storefront.cimplify.io/api/v1/orders \
  -H "X-API-Key: pk_test_your_api_key"

Example Response

JSON

{
  "success": true,
  "data": [
    {
      "id": "ord_abc123",
      "order_number": "ORD-1234",
      "status": "confirmed",
      "order_type": "delivery",
      "items": [
        {
          "product_id": "prod_abc123",
          "product_name": "Espresso",
          "variant_name": "Double",
          "quantity": 2,
          "unit_price": "6.00",
          "total": "12.00"
        }
      ],
      "subtotal": "25.00",
      "tax_amount": "2.22",
      "total_price": "27.22",
      "currency": "USD",
      "customer_name": "Jane Smith",
      "created_at": "2025-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "total_count": 5,
      "page_size": 20,
      "current_page": 1
    }
  }
}

GET/api/v1/orders/{id}

Get Order

Example Request

curl

curl https://storefront.cimplify.io/api/v1/orders/ord_abc123 \
  -H "X-API-Key: pk_test_your_api_key"

POST/api/v1/orders/{id}/cancel

Cancel Order

Example Request

curl

curl -X POST https://storefront.cimplify.io/api/v1/orders/ord_abc123/cancel \
  -H "X-API-Key: pk_test_your_api_key"

Order Statuses

Status	Description
`pending`	Order received, awaiting confirmation
`confirmed`	Order confirmed by business
`preparing`	Order is being prepared
`ready`	Ready for pickup or delivery
`completed`	Order fulfilled
`cancelled`	Order cancelled

Order Object

Field	Type	Description
`id`	string	Unique order identifier
`order_number`	string	Human-readable order number
`status`	string	Current order status
`order_type`	string	delivery, pickup, or dine_in
`items`	array	Line items
`subtotal`	string	Subtotal before tax
`tax_amount`	string	Tax amount
`total_price`	string	Final total
`currency`	string	ISO 4217 currency code
`customer_name`	string	Customer name
`created_at`	string	ISO 8601 timestamp