Products API

v1.0 • REST • JSON

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

GET POST PUT DELETE 5 Endpoints
Base URL https://bogusapi.com/api/products

Quick Reference

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

Get All Products

Retrieves a paginated list of all products 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/products/{id} 200 OK

Get Single Product

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

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

Product Not Found

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

Response: 404 Not Found
POST /api/products 201 Created

Create Product

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

Request Body
Field Type Required Description
name string Required Name
description string Required Description
price decimal Required Price
stock integer Required Stock
categoryId integer Optional Category id
Body
Response: 201 Created
PUT /api/products/{id} 200 OK

Update Product

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

Request Body
Field Type Required Description
name string Required Name
description string Required Description
price decimal Required Price
stock integer Required Stock
categoryId integer Optional Category id
Body
Response: 200 OK
DELETE /api/products/{id} 204 No Content

Delete Product

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

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