---
title: "Order Status"
method: GET
path: "/status"
tags: ["Forms"]
---

# Order Status

`GET /status`

This API provides the current status of a previously submitted order.

Order Status Metrix:

|Code|Status|Sub Status|Description|
|----|------|----------|--------|
|S1|SUBMITTED|Approved|The enrollment has been successfully submitted to the supplier but service has not started|
|S2|SUBMITTED|Approved with Deposit Needed|The enrollment has been successfully submitted to the supplier but a deposit is needed to turn on service|
|S3|SUBMITTED|Approved with Deposit Waiver Needed|The enrollment has been successfully submitted to the supplier but a deposit waiver is needed to turn on service|
|S4|SUBMITTED|Processing||
|F3|FAILED|Declined|The enrollment has been declined by the supplier|
|A1|ACTIVE|Active|Electricity service is actively being provided to the user|
|C1|CLOSED|Expired|The service term has expired|
|C2|CLOSED|Declined|The enrollment has been declined by the supplier after the enrollment|
|C3|CLOSED|Canceled|The enrollment has been canceled by the customer after the enrollment|

## Query parameters

- `order_id` string, required

## Response `200`

OK

- SuccessForm
  - `status` 'PENDING' | 'FAILED' | 'SUBMITTED' | 'ACTIVE' | 'CLOSED'
  - `agent` 'Distributor' | 'Supplier' | 'Customer'
  - `sub_status` 'Processing' | 'Account Number' | 'Confirm Plan' | 'Deposit Required' | 'Validation' | 'Approved' | 'Approved with Deposit Needed' | 'Approved with Deposit Waiver Needed' | 'Active' | 'Expired' | 'Declined' | 'Canceled'
  - `description` string
  - `code` 'P1' | 'P2' | 'P3' | 'P4' | 'P5' | 'F1' | 'F2' | 'F3' | 'F4' | 'S1' | 'S2' | 'S3' | 'S4' | 'A1' | 'C1' | 'C2' | 'C3'
  - `metadata` object
    - `deposit_paid` boolean
    - `deposit_amount` number
    - `deposit_payment_link` string
    - `deposit_text` string
    - `service_start_date` string
    - `account_number` string
    - `order_id` string — Wattb order id
    - `reference_id` string — Supplier order id
    - `secondary_id` object — optional id
      - `key` string
      - `value` string
    - `error_message` string
    - `status_reason` string

## Other responses

- `204` — Unable to find any information
- `400` — Bad request
- `500` — Internal server error

---

[API](https://skmtc.net/wattbuy/apis/wattbuy-apis.md) · [All operations](https://skmtc.net/wattbuy/apis/wattbuy-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wattbuy/wattbuy-apis/revisions/97771153b652/schema)