Managing Orders

API Endpoints for 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.

GET '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

Get a specific order by ID.

Authorizations

Path parameters

idinteger · int64Required

ID of the order

Responses

200

Order retrieved successfully

401

Unauthorized

404

Order not found

500

Internal Server Error

get

HTTPcURLJavaScriptPython

GET /api/open-api/v1/orders/{id} HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*

No content

GET '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.

Fetch all orders

get

Authorizations

Query parameters

per_pageintegerOptional

Number of results per page

Example: 25

pageintegerOptional

Number of page

Example: 2

order_bystringOptional

Field to sort orders by

Example: created_at

orderstring · enumOptional

Sort order (asc or desc)

Example: descPossible values:

configurator_idintegerOptional

Filter orders by specific configurator ID

Example: 127

start_datestring · dateOptional

Filter orders created after this date

Example: 2024-01-01

end_datestring · dateOptional

Filter orders created before this date

Example: 2024-12-31

Responses

200

Successful response

application/json

401

Unauthorized

500

Internal Server Error

get

HTTPcURLJavaScriptPython

GET /api/open-api/v1/orders HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*

{
  "data": [
    {
      "configurator": {
        "id": 1,
        "configurator_name": "Custom 3D Configurator"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total": 200,
    "last_page": 8,
    "next_page_url": "https://api.example.com/orders?page=2",
    "prev_page_url": null
  }
}