Orders API

v1.0 • REST • JSON

Full CRUD management for order accounts. Create, retrieve, update, and delete order records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints Auth Required
Base URL https://bogusapi.com/api/orders

Quick Reference

GET
/api/orders List all orders (paginated)
200 GET
/api/orders/{id} Get one order by ID
200 POST
/api/orders Create a new order
201 PUT
/api/orders/{id} Replace order data
204 DEL
/api/orders/{id} Remove a order
204 GET
/api/orders/{id} Order not found example
404
GET /api/orders 200 OK

Get All Orders

Retrieves a paginated list of all orders in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/orders/{id} 200 OK

Get Single Order

Fetch the full profile for a specific order using their numeric ID. Returns all order fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique order identifier
Response: 200 OK
GET /api/orders/{id} 404 Not Found

Order Not Found

Returned when the requested order ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing order resources.

Response: 404 Not Found 
{}
POST /api/orders 201 Created

Create Order

Registers a new order with the provided details. On success, returns the newly created order object — including the auto-generated ID, timestamp, and resolved role names.

Request Body
FieldTypeRequiredDescription
firstName string Required Order's given name
lastName string Required Order's family name
email string Required Unique email address
password string Required Plaintext password for the account
roleIds integer[] Optional IDs of roles to assign on creation
Body
Response: 201 Created
PUT /api/orders/{id} 200 OK

Update Order

Fully replaces an existing order's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
FieldTypeRequiredDescription
firstName string Required Updated first name
lastName string Required Updated last name
email string Required Updated email address
roleIds integer[] Optional New role assignment (replaces existing)
Body
Response: 200 OK
DELETE /api/orders/{id} 204 No Content

Delete Order

Permanently removes a order from the system by their ID. This action is irreversible — once deleted, the order record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the order to delete
Response: 204 No Content 
{}