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

# Order

## Order object

## The Order object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"components":{"schemas":{"Order":{"type":"object","description":"An equipment order placed by the dealer. Null fields are omitted from the response.","readOnly":true,"properties":{"id":{"type":"integer","description":"Order ID."},"user_id":{"type":"integer","description":"ID of the user the order belongs to."},"seller_id":{"type":"integer","description":"ID of the seller the order was placed with."},"type":{"type":"string","description":"Order type.","enum":["bank","equip","bank_service","bank_license","bank_license_camera"]},"status":{"type":"string","description":"Order status.","enum":["created","settled","gathered","shipped","shipped_partially","canceled"]},"amount":{"type":"integer","description":"Number of items ordered."},"sum":{"type":"number","description":"Order total."},"with_vat":{"type":"boolean","description":"Whether the total includes VAT."},"payer":{"type":"string","description":"Payer name."},"recipient":{"type":"string","description":"Recipient name."},"contacts":{"type":"string","description":"Recipient contact details."},"place":{"type":"string","description":"Delivery address."},"comment":{"type":"string","description":"Free-text comment."},"remark":{"type":"string","description":"Additional remark. Omitted when empty."},"link":{"type":"string","description":"Link associated with the order."},"creation_time":{"type":"string","description":"When the order was created, as `YYYY-MM-DD HH:MM:SS`."},"positions":{"type":"array","description":"Line items of the order.","items":{"$ref":"#/components/schemas/OrderPosition"}}}},"OrderPosition":{"type":"object","description":"A line item of an order.","readOnly":true,"properties":{"id":{"type":"integer","description":"Position ID."},"order_id":{"type":"integer","description":"ID of the parent order."},"equip_id":{"type":"integer","description":"ID of the equipment model ordered. The equipment catalogue is not exposed by this API, so this ID is only meaningful when matched against an order placed through the Admin Panel."},"type":{"type":"string","description":"Position type."},"name":{"type":"string","description":"Display name of the ordered item."},"amount":{"type":"integer","description":"Quantity."},"price":{"type":"number","description":"Unit price."}}}}}}
```

Fields with no value are omitted from the response rather than returned as `null`.

## API actions

API path: `panel/order`.

***

*required permissions*: `tracker_bundles: "read"`.

## Read order

> Read a single equipment order belonging to the current dealer.\
> \
> An order that exists but belongs to another dealer returns error code 201, the same as one that does not exist, so a caller cannot use this operation to probe for other dealers' order IDs.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Admin Panel API","version":"1.2.0"},"tags":[{"name":"Order","description":"Equipment orders placed by the dealer. All resources under the /panel/order/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Enter the panel session hash with the \"NVX \" prefix, e.g. \"NVX fa7bf873fab9333144e171372a321b06\". Obtain the hash from the accountAuth operation.","name":"Authorization","in":"header"}},"schemas":{"Order":{"type":"object","description":"An equipment order placed by the dealer. Null fields are omitted from the response.","readOnly":true,"properties":{"id":{"type":"integer","description":"Order ID."},"user_id":{"type":"integer","description":"ID of the user the order belongs to."},"seller_id":{"type":"integer","description":"ID of the seller the order was placed with."},"type":{"type":"string","description":"Order type.","enum":["bank","equip","bank_service","bank_license","bank_license_camera"]},"status":{"type":"string","description":"Order status.","enum":["created","settled","gathered","shipped","shipped_partially","canceled"]},"amount":{"type":"integer","description":"Number of items ordered."},"sum":{"type":"number","description":"Order total."},"with_vat":{"type":"boolean","description":"Whether the total includes VAT."},"payer":{"type":"string","description":"Payer name."},"recipient":{"type":"string","description":"Recipient name."},"contacts":{"type":"string","description":"Recipient contact details."},"place":{"type":"string","description":"Delivery address."},"comment":{"type":"string","description":"Free-text comment."},"remark":{"type":"string","description":"Additional remark. Omitted when empty."},"link":{"type":"string","description":"Link associated with the order."},"creation_time":{"type":"string","description":"When the order was created, as `YYYY-MM-DD HH:MM:SS`."},"positions":{"type":"array","description":"Line items of the order.","items":{"$ref":"#/components/schemas/OrderPosition"}}}},"OrderPosition":{"type":"object","description":"A line item of an order.","readOnly":true,"properties":{"id":{"type":"integer","description":"Position ID."},"order_id":{"type":"integer","description":"ID of the parent order."},"equip_id":{"type":"integer","description":"ID of the equipment model ordered. The equipment catalogue is not exposed by this API, so this ID is only meaningful when matched against an order placed through the Admin Panel."},"type":{"type":"string","description":"Position type."},"name":{"type":"string","description":"Display name of the ordered item."},"amount":{"type":"integer","description":"Quantity."},"price":{"type":"number","description":"Unit price."}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API (not a HTTP code)"},"description":{"type":"string","description":"An error description"}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/panel/order/read":{"post":{"tags":["Order"],"summary":"Read order","operationId":"orderRead","description":"Read a single equipment order belonging to the current dealer.\n\nAn order that exists but belongs to another dealer returns error code 201, the same as one that does not exist, so a caller cannot use this operation to probe for other dealers' order IDs.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["order_id"],"properties":{"order_id":{"type":"integer","description":"Order ID.","minimum":1}}}}}},"responses":{"200":{"description":"The order","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"value":{"$ref":"#/components/schemas/Order"}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Operation not permitted, error code 13: the session lacks the required permission.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

* 201 – Not found in the database - if the specified order does not exist, or belongs to another dealer.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-api/panel-api/resources/order.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.