Orders
Managing orders using API endpoints
Overview of Simplio3D API Orders Endpoints
The Simplio3D API provides a set of endpoints that allow users to manage orders efficiently. Among these endpoints, the GET /orders/{orderId}
endpoint is specifically designed to retrieve detailed information about a particular order by its unique ID. This enables users to monitor and track individual orders, ensuring they have access to up-to-date status and details of their transactions.
For more information on utilizing the Orders endpoints, please refer to the API documentation for additional details and examples.
GET /orders/{orderId}
GET Endpoint: Retrieve an Order by ID
Endpoint URL
GET open-api/v1/orders/{orderId}
Description
Retrieve detailed information about a specific order using its unique identifier.
Path Parameter
orderId
: The unique identifier for the order you wish to retrieve.
Response
200 OK
: Successfully retrieved the order details.404 Not Found
: No order was found with the provided ID.500 Internal Server Error
: An error occurred on the server.
Example Request
Example Response
POST /orders
POST Endpoint: Create a New Order
Endpoint URL
POST /orders
Description
This endpoint allows you to create a new order in the system.
Request Headers
Content-Type: application/json
Authorization: Bearer <token>
Request Body
Response
200 OK: Order created successfully
400 Bad Request: Invalid input data
401 Unauthorized: Missing or invalid authentication token
Example
GET /orders
GET Endpoint: Fetch All Orders
Endpoint URL
Description
This endpoint retrieves a comprehensive list of all orders in the system, allowing users to manage and review order details efficiently.
Query Parameters
status (optional): Filter orders by their status (e.g.,
pending
,completed
).limit (optional): Limit the number of orders returned.
offset (optional): Specify the starting point for the list of orders returned.
Headers
Authorization: Bearer token required for authentication.
Response
200 OK: Successfully retrieved the list of orders.
Content: JSON array of order objects, each containing:
order_id
: Unique identifier for the order.customer_name
: Name of the customer.total_amount
: Total amount of the order.status
: Current status of the order.created_at
: Timestamp of order creation.
Example Request
Example Response
Error Responses
401 Unauthorized: Authentication failed; token missing or invalid.
500 Internal Server Error: An error occurred on the server.
Last updated
Was this helpful?