GET ?action=get_work_order

Returns work order status and details for a customer-facing order status page. Authenticated by reference code plus either a confirmation token or customer email. Does not expose admin notes or internal fields.

Request Parameters

ref — string — Required. Work order reference code (query string).

token — string — Optional*. Confirmation token returned by create_work_order.

email — string — Optional*. Customer email on the order.

At least one of token or email must be provided.

Response Fields

reference_code — string — Work order reference code

status — string — pending, pending_payment, payment_submitted, completed, canceled, payment_failed, or awaiting_webhook

type — string — Work order type: new_activation, renewal, trial_upgrade, or new_trial

source — string — Origin source e.g. woocommerce or api

customer_email — string — Customer email address

customer_name — string or null — Customer full name

currency — string — Currency code e.g. USD

cart — array — Cart items (removed and adjustment items excluded)

snap_total — float — Sum of cart item prices before any adjustment

order_total — float — Final total after adjustment

prev_paid — float — Amount already paid toward this order

balance_due — float — Remaining balance due

has_partials — boolean — True if partial payments have been made and a balance remains

payment_history — array — Record of individual payments made against this order

adjustment — object or null — Price adjustment applied to the order (see Adjustment Object below)

payment_method — object or null — Payment method details (see Payment Method Object below)

created_at — string — Order creation datetime (UTC)

updated_at — string — Order last updated datetime (UTC)

Adjustment Object

direction — string — fee or discount

label — string or null — Display label for the adjustment

amount — float — Adjustment amount

Payment Method Object

id — integer — Payment method ID

name — string — Display label, falls back to internal name

processor — string or null — Processor identifier

mode — string — automated or manual

is_automated — boolean — Whether this is a fully automated gateway

instructions — string or null — Payment instructions for manual methods

config — object — Processor-specific configuration (empty object if not set)

Example

curl -X GET "https://YOUR_DOMAIN/api/api.php?action=get_work_order&ref=WO-2026-00042&token=abc123def456..." \
  -H "X-Panelr-API-Key: YOUR_API_KEY"