# Managing Orders

### Overview

The Simplio3D API provides robust capabilities for managing order-related operations. The order endpoints are essential for retrieving and interacting with order data, enhancing the efficiency and functionality of client applications.

### <mark style="color:green;">GET</mark> 'Get Order by ID'

This API endpoint retrieves a specific order using its unique identifier. The client must provide a valid order ID to fetch the order details, which typically include information such as order date, items, quantity, and status.

## Get order by ID

> Get a specific order by ID.

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"tags":[{"name":"Orders","description":"API Endpoints for managing order"}],"servers":[{"url":"https://app.simplio3d.com","description":"API Open Base URL"},{"url":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter token in format (Bearer <your_token>)"}}},"paths":{"/api/open-api/v1/orders/{id}":{"get":{"tags":["Orders"],"summary":"Get order by ID","description":"Get a specific order by ID.","operationId":"eb76b24e9cf6682e8eed49c296501063","parameters":[{"name":"id","in":"path","description":"ID of the order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Order retrieved successfully"},"401":{"description":"Unauthorized"},"404":{"description":"Order not found"},"500":{"description":"Internal Server Error"}}}}}}
```

### <mark style="color:green;">GET</mark> 'Fetch All Orders'

This API endpoint fetches a list of all orders. It allows clients to view existing orders, with optional filtering and pagination parameters to manage the retrieved data efficiently. This endpoint is useful for obtaining an overview of order history or status updates.

The endpoint is designed to retrieve a comprehensive list of all orders available within the system. Clients can leverage this endpoint to access a paginated and optionally filtered dataset of orders. This is particularly useful for applications that need to present an overview of order histories, track order statuses, or analyze order trends over time. Key features include:

* **Pagination**: Retrieve orders in manageable chunks to optimize performance and user experience.
* **Filtering**: Apply criteria such as date ranges, statuses, or customer IDs to narrow down results to relevant data sets.
* **Order Details**: View summary information for each order, including order ID, date, status, and total amount.

This endpoint is an essential tool for applications aimed at providing insights and management capabilities around order data.

## GET /api/open-api/v1/orders

> Fetch all orders

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"tags":[{"name":"Orders","description":"API Endpoints for managing order"}],"servers":[{"url":"https://app.simplio3d.com","description":"API Open Base URL"},{"url":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Enter token in format (Bearer <your_token>)"}}},"paths":{"/api/open-api/v1/orders":{"get":{"tags":["Orders"],"summary":"Fetch all orders","operationId":"c8f29adea587435e7ae6bc3f61862859","parameters":[{"name":"per_page","in":"query","description":"Number of results per page","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"Number of page","required":false,"schema":{"type":"integer"}},{"name":"order_by","in":"query","description":"Field to sort orders by","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Sort order (asc or desc)","required":false,"schema":{"type":"string","enum":["asc","desc"]}},{"name":"configurator_id","in":"query","description":"Filter orders by specific configurator ID","required":false,"schema":{"type":"integer"}},{"name":"start_date","in":"query","description":"Filter orders created after this date","required":false,"schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"Filter orders created before this date","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"properties":{"data":{"type":"array","items":{"properties":{"configurator":{"properties":{"id":{"type":"integer"},"configurator_name":{"type":"string"}},"type":"object"}},"type":"object"}},"pagination":{"properties":{"current_page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer"},"last_page":{"type":"integer"},"next_page_url":{"type":"string","nullable":true},"prev_page_url":{"type":"string","nullable":true}},"type":"object"}},"type":"object"}}}},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}}}}}}
```

## The OrdersResource object

```json
{"openapi":"3.0.0","info":{"title":"Simplio3D-Open REST API","version":"1.0.0"},"components":{"schemas":{"OrdersResource":{"title":"Order Resource","description":"Order resource representation","properties":{"id":{"description":"Unique identifier for the order","type":"integer"},"price":{"description":"Total price of the order","type":"number","format":"float"},"status":{"description":"Status of the order","type":"string"},"customer_details":{"description":"Details of the customer","type":"object"},"configurator_summary":{"description":"Summary of the configurator options selected","type":"object"},"configurator_snapshot":{"description":"URL of the configurator snapshot image","type":"string","format":"url"},"configurator_print_map":{"description":"Array of URLs for configurator print maps","type":"array","items":{"type":"string","format":"url"}},"invoice_url":{"description":"URL for downloading the order invoice","type":"string","format":"url"},"order_shopify":{"description":"Shopify order ID if applicable","type":"string"},"created_at":{"description":"Timestamp when the order was created","type":"string","format":"date-time"},"updated_at":{"description":"Timestamp when the order was last updated","type":"string","format":"date-time"}},"type":"object"}}}}
```


---

# Agent Instructions: 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:

```
GET https://docs.simplio3d.com/api-reference/partner-api/managing-orders.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.