Skip to main content
Base URL: https://yoursite.com/wp-json/utb/v1 All endpoints require authentication.

List orders

GET /wp-json/utb/v1/orders
Returns a paginated list of WooCommerce orders. Each order is built by OrderDataBuilder and includes customer data, line items, form submissions, and uploaded files.

Query parameters

page
integer
default:"1"
Page number. Minimum: 1.
per_page
integer
default:"50"
Number of results per page. Minimum: 1, maximum: 100.
status
string
Filter by WooCommerce order status. Accepted values: pending, processing, on-hold, completed, cancelled, refunded, failed.
order_id
integer
Filter by a specific order ID.
id
integer
Alias for order_id.
flow_id
string
Filter by UTB flow ID (e.g. utb_cep_programs, certificados_academicos).
date_from
string
Return orders created on or after this date. Format: YYYY-MM-DD.
date_to
string
Return orders created on or before this date. Format: YYYY-MM-DD.

Response

orders
object[]
Array of order objects. See order object below.
pagination
object
curl "https://yoursite.com/wp-json/utb/v1/orders?status=completed&per_page=10" \
  -H "X-UTB-API-Key: your-api-key-here"

Get a single order

GET /wp-json/utb/v1/orders/{id}
Returns the full data payload for a single order.

Path parameters

id
integer
required
The WooCommerce order ID.
curl "https://yoursite.com/wp-json/utb/v1/orders/1042" \
  -H "X-UTB-API-Key: your-api-key-here"

Order object

order
object
Core WooCommerce order fields.
customer
object
Billing and shipping information for the order’s customer.
items
object[]
One object per WooCommerce line item.
metadata
object
Order-level metadata.

Example response

{
  "order": {
    "id": 1042,
    "number": "1042",
    "status": "completed",
    "currency": "COP",
    "total": "150000.00",
    "subtotal": "150000.00",
    "discount_total": "0.00",
    "date_created": "2026-03-18T14:00:00+00:00",
    "date_paid": "2026-03-18T14:01:22+00:00",
    "payment_method": "wompi",
    "payment_method_title": "Wompi",
    "transaction_id": "txn_abc123",
    "customer_note": ""
  },
  "customer": {
    "id": 7,
    "email": "[email protected]",
    "first_name": "Maria",
    "last_name": "Garcia",
    "phone": "3001234567",
    "billing": { "address_1": "Cra 7 # 45-10", "city": "Bogotá", "country": "CO" },
    "shipping": {}
  },
  "items": [
    {
      "item_id": 88,
      "product_id": 210,
      "product_name": "Inscripción Diplomado Gestión",
      "sku": "DIP-GEST-001",
      "quantity": 1,
      "subtotal": "150000.00",
      "total": "150000.00",
      "flow_id": "utb_cep_programs",
      "flow_name": "Programas CEP",
      "form_submission": { "cep_programa": "DIP-GEST" },
      "program_details": {
        "id": 12,
        "codigo": "DIP-GEST",
        "nombre": "Diplomado en Gestión",
        "sku": "DIP-GEST-001",
        "precio_base": "150000.00",
        "activo": true,
        "precio_final": "150000.00",
        "aplica_descuento_utb": false
      },
      "uploaded_files": {},
      "product_metadata": { "webhook_url": "https://erp.ejemplo.co/webhooks/inscripciones", "enviar_automatico": true }
    }
  ],
  "metadata": {
    "created_at": "2026-03-18T14:00:00+00:00",
    "updated_at": "2026-03-18T14:01:22+00:00",
    "submission_id": 53,
    "payment_status": "completed"
  }
}

Build docs developers (and LLMs) love