> For the complete documentation index, see [llms.txt](https://docs.catfee.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.catfee.io/en/api-reference/order-detail.md).

# Get Order Detail

Query an order using its platform order ID or the client order ID provided when creating it.

### Query by Order ID

{% openapi src="/files/6qXC6RrOuqtzIYmAmGSc" path="/v1/order/{id}" method="get" %}
[api.json](https://4164384423-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa332YYkbT2p9snj9atS0%2Fuploads%2Fgit-blob-686dfe3c6ef251a9d69c042fbd858c32a092401d%2Fapi.json?alt=media)
{% endopenapi %}

### Query by Client Order ID

Use the `client_order_id` provided when creating the order to look it up, without supplying the order `id` returned by the platform.

{% openapi src="/files/6qXC6RrOuqtzIYmAmGSc" path="/v1/order" method="get" %}
[api.json](https://4164384423-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa332YYkbT2p9snj9atS0%2Fuploads%2Fgit-blob-686dfe3c6ef251a9d69c042fbd858c32a092401d%2Fapi.json?alt=media)
{% endopenapi %}

### Time-Based Rental Order Status

These rules apply to orders returned by the Rental Open API: `POST /v1/order` (including idempotent responses), `GET /v1/order/{id}`, `GET /v1/order?client_order_id=...`, and `POST /v1/reclaim/{id}`. Other services retain their own documented status behavior.

`code=0` means the API request succeeded. It does not mean delegation is complete. Check both `status` and `confirm_status` to track the order.

| Field and value                       | Meaning                                                                                                                                               |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `status=PAYMENT_SUCCESS`              | Normal status: delegation is pending or in progress. Delegation is not yet complete.                                                                  |
| `status=DELEGATE_SUCCESS`             | The delegation transaction was submitted; check `confirm_status` for on-chain confirmation. This value is also returned during and after reclamation. |
| Any other `status` value              | Treat as failure.                                                                                                                                     |
| `confirm_status=UNCONFIRMED`          | Delegation has not yet been confirmed.                                                                                                                |
| `confirm_status=DELEGATION_CONFIRMED` | Delegation was confirmed on-chain. This value is also returned during and after reclamation confirmation.                                             |
| Any other `confirm_status` value      | Treat as failure.                                                                                                                                     |

The only normal `status` values are `PAYMENT_SUCCESS` and `DELEGATE_SUCCESS`. The only normal `confirm_status` values are `UNCONFIRMED` and `DELEGATION_CONFIRMED`. Treat any other value in either field as failure.

Reclamation is handled internally. These endpoints do not expose reclamation states through these two fields:

| Internal state                                                                             | API response                          |
| ------------------------------------------------------------------------------------------ | ------------------------------------- |
| `status` is `RECLAIM_SUCCESS`, `RECLAIMING`, or `RECLAIM_FAIL`                             | `status=DELEGATE_SUCCESS`             |
| `confirm_status` is `RECLAIM_CONFIRMED`, `RECLAIM_CONFIRMING`, or `RECLAIM_CONFIRMED_FAIL` | `confirm_status=DELEGATION_CONFIRMED` |

Each field is mapped independently; all other values are returned unchanged. A successful reclaim request does not mean reclamation is complete on-chain. Do not wait for either field to change to a reclamation status.

`DELEGATION_CONFIRMED` records successful delivery of the delegation, not the amount of energy currently available. Success values can remain after expiry or early reclamation. Check `expired_timestamp`, reclamation details, and the receiving address's on-chain resources to determine current availability.

### User Balance

The order object returned by these endpoints includes `balance`, an integer representing the user's current balance in **SUN** (1 TRX = 1,000,000 SUN). It is not the order amount or a historical balance saved when the order was paid.