The Product Catalog API allows client applications to create, retrieve, update, and delete product information.
\nThis API is typically used in e-commerce platforms, inventory management systems, and admin dashboards where products need to be managed efficiently.
\nThis API uses Bearer Token authentication.
\nAll requests must include an Authorization header with a valid access token.
\nExample:
Authorization: Bearer
Request format: JSON
\nResponse format: JSON
\nList all available products
\nView product details
\nAdd new products to the catalog
\nUpdate existing product information
\nRemove discontinued products
\n{
\"error\": \"Unauthorized\",
\"message\": \"Access token is missing or invalid\",
\"timestamp\": \"2026-02-17T11:25:00Z\"
}
{
\"id\": \"p101\",
\"name\": \"Wireless Mouse\",
\"description\": \"Ergonomic wireless mouse\",
\"category\": \"Electronics\",
\"price\": 1499,
\"stock\": 25,
\"status\": \"active\",
\"createdAt\": \"2024-12-10T08:00:00Z\",
\"updatedAt\": \"2025-01-20T18:10:00Z\"
}
Authorization: Bearer
Content-Type: application/json
Retrieves a list of products from the product catalog.
\nThis endpoint can be used to display all available products in an application such as
an e-commerce website or inventory management system.
page
\nPage number of the results to retrieve.
\nlimit
\nNumber of products to return per page.
\nAuthorization: Bearer
Content-Type: application/json
200 OK
\nReturns a successful response containing a list of products.
\n","urlObject":{"protocol":"https","path":["v1","products"],"host":["api","example","com"],"query":[],"variable":[]}},"response":[{"id":"45573846-1097-4804-b7dc-a60bad5531dc","name":"200 OK - List of Products","originalRequest":{"method":"GET","header":[],"url":"https://api.example.com/v1/products"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 13 Feb 2026 02:24:25 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1847"},{"key":"Connection","value":"keep-alive"},{"key":"access-control-allow-credentials","value":"true"},{"key":"Cache-Control","value":"max-age=43200"},{"key":"Content-Encoding","value":"gzip"},{"key":"etag","value":"W/\"160d-1eMSsxeJRfnVLRBmYJSbCiJZ1qQ\""},{"key":"expires","value":"-1"},{"key":"nel","value":"{\"report_to\":\"heroku-nel\",\"response_headers\":[\"Via\"],\"max_age\":3600,\"success_fraction\":0.01,\"failure_fraction\":0.1}"},{"key":"pragma","value":"no-cache"},{"key":"report-to","value":"{\"group\":\"heroku-nel\",\"endpoints\":[{\"url\":\"https://nel.heroku.com/reports?s=nZhVoyypA48y5%2FAbO7Xs3zB0bF7iL4sfOiMaa6sQUvA%3D\\u0026sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d\\u0026ts=1763569631\"}],\"max_age\":3600}"},{"key":"reporting-endpoints","value":"heroku-nel=\"https://nel.heroku.com/reports?s=nZhVoyypA48y5%2FAbO7Xs3zB0bF7iL4sfOiMaa6sQUvA%3D&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&ts=1763569631\""},{"key":"Server","value":"cloudflare"},{"key":"vary","value":"Origin, Accept-Encoding"},{"key":"via","value":"2.0 heroku-router"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-powered-by","value":"Express"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"999"},{"key":"x-ratelimit-reset","value":"1763569633"},{"key":"Age","value":"15696"},{"key":"Accept-Ranges","value":"bytes"},{"key":"cf-cache-status","value":"HIT"},{"key":"CF-RAY","value":"9cd0de8cda2a4021-SIN"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"p101\",\n \"name\": \"Wireless Mouse\",\n \"description\": \"Ergonomic wireless mouse with adjustable DPI\",\n \"category\": \"Electronics\",\n \"price\": 999,\n \"stock\": 120,\n \"status\": \"active\",\n \"createdAt\": \"2025-01-05T09:30:00Z\",\n \"updatedAt\": \"2025-02-01T12:15:00Z\"\n },\n {\n \"id\": \"p102\",\n \"name\": \"Bluetooth Keyboard\",\n \"description\": \"Compact Bluetooth keyboard with backlight\",\n \"category\": \"Electronics\",\n \"price\": 1999,\n \"stock\": 5,\n \"status\": \"inactive\",\n \"createdAt\": \"2024-12-10T08:00:00Z\",\n \"updatedAt\": \"2025-01-20T18:10:00Z\"\n },\n {\n \"id\": \"p103\",\n \"name\": \"USB-C Hub\",\n \"description\": \"Multi-port USB-C hub with HDMI and USB ports\",\n \"category\": \"Accessories\",\n \"price\": 2499,\n \"stock\": 0,\n \"status\": \"not_available\",\n \"createdAt\": \"2024-11-01T11:45:00Z\",\n \"updatedAt\": \"2025-02-08T10:00:00Z\"\n }\n]"},{"id":"71883f1e-a41a-4413-816b-47b9996dd0d4","name":"401 Unauthorized - Missing or Invalid Access Token","originalRequest":{"method":"GET","header":[],"url":"https://api.example.com/v1/products"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Access token is missing or invalid\"\r\n}"}],"_postman_id":"5af73be7-803a-4906-ac2c-4fac310cde5a"},{"name":"Get Product by ID","id":"e06d911c-a007-4f91-8d06-577470a2ea73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.example.com/v1/products/{{id}}","description":"This endpoint retrieves detailed information about a single product using its unique product ID.
\nIt is commonly used on:
\nProduct detail pages
\nAdmin dashboards
\nInventory management systems
\nOnly one product is returned in the response.
\n","urlObject":{"protocol":"https","path":["v1","products","{{id}}"],"host":["api","example","com"],"query":[],"variable":[]}},"response":[{"id":"34fef861-3a30-4e78-bff2-4dc4dc356230","name":"200 OK - Product Details","originalRequest":{"method":"GET","header":[],"url":"https://api.example.com/v1/products/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Date","value":"Mon, 16 Feb 2026 14:23:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"access-control-allow-origin","value":"*"},{"key":"etag","value":"W/\"16d-ryVvNeDR+OwaJd+i2vi/OPo/G4Y\""},{"key":"x-powered-by","value":"Express"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Nel","value":"{\"report_to\":\"cf-nel\",\"success_fraction\":0.0,\"max_age\":604800}"},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v4?s=dMiV%2FXgH0ZKeUywOkCO%2BmZn5fZ7j%2B5NMtPTts0E3H79umZQqyFZ2O77AsbBCyJjwXzK2jIdQKqL%2BKOaAn%2B%2FZwUR5hzGFyKvNhZLVLxSb%2FXjgftRdVt4pLxrXahk%3D\"}]}"},{"key":"Content-Encoding","value":"br"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9cedb39dbef6fde7-SIN"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"p102\",\n \"name\": \"Bluetooth Keyboard\",\n \"description\": \"Compact Bluetooth keyboard with backlight\",\n \"category\": \"Electronics\",\n \"price\": 1999,\n \"stock\": 5,\n \"status\": \"inactive\",\n \"createdAt\": \"2024-12-10T08:00:00Z\",\n \"updatedAt\": \"2025-01-20T18:10:00Z\"\n}"},{"id":"126f6a2f-65af-4eeb-bb9a-0a34d6b7d371","name":"404 Not Found - Product Not Found","originalRequest":{"method":"GET","header":[],"url":"https://api.example.com/v1/products/{{id}}"},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"Product not found\",\r\n \"message\": \"No product exists with the given productId\",\r\n \"productId\": 999,\r\n \"timestamp\": \"2026-02-16T14:30:00Z\"\r\n}"},{"id":"9c13554c-a8c6-460b-bdd1-0df8f39d284c","name":"401 Unauthorized - Missing or Invalid Access Token","originalRequest":{"method":"GET","header":[],"url":"https://api.example.com/v1/products/{{id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Access token is missing or invalid\"\r\n}"}],"_postman_id":"e06d911c-a007-4f91-8d06-577470a2ea73"},{"name":"Create Product","id":"5c631b15-457c-484b-a9b0-dd366b92b799","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Wireless Mouse\",\r\n \"description\": \"Ergonomic wireless mouse with adjustable DPI\",\r\n \"category\": \"Electronics\",\r\n \"price\": 1499,\r\n \"stock\": 25,\r\n \"status\": \"active\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/products","description":"Creates a new product in the product catalog.
\nThis endpoint is used by admin users to add new products that can be displayed
in product listings and product detail pages.
Authentication: Requires Bearer Token authentication.
\nHeaders:
\nContent-Type: application/json
\nAuthorization: Bearer
\nUpdates an existing product by ID.
\nAll product fields must be provided.
\nRequires authorization.
\n","urlObject":{"protocol":"https","path":["v1","products","{{id}}"],"host":["api","example","com"],"query":[],"variable":[]}},"response":[{"id":"1a762125-034f-48e0-a603-d1606b21f888","name":"200 OK - Product Updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Wireless Mouse\",\r\n \"description\": \"Ergonomic wireless mouse with adjustable DPI\",\r\n \"category\": \"Electronics\",\r\n \"price\": 1499,\r\n \"stock\": 30,\r\n \"status\": \"active\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/products/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"p101\",\r\n \"name\": \"Wireless Mouse\",\r\n \"description\": \"Ergonomic wireless mouse with adjustable DPI\",\r\n \"category\": \"Electronics\",\r\n \"price\": 1499,\r\n \"stock\": 30,\r\n \"status\": \"active\",\r\n \"updatedAt\": \"2025-02-18T10:30:00Z\"\r\n}"},{"id":"35765a64-ba30-4f27-91c2-2166ce079100","name":"400 Bad Request - Invalid Product Data","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Wireless Mouse\",\r\n \"description\": \"Ergonomic wireless mouse with adjustable DPI\",\r\n \"category\": \"Electronics\",\r\n \"price\": -1499,\r\n \"stock\": 30,\r\n \"status\": \"active\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/products/{{id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"Validation failed\",\r\n \"message\": \"Price must be greater than 0\"\r\n}"},{"id":"9a8df608-c075-403d-8469-2a9a1e2afd12","name":"401 Unauthorized - Missing or Invalid Access Token","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Wireless Mouse\",\r\n \"description\": \"Ergonomic wireless mouse with adjustable DPI\",\r\n \"category\": \"Electronics\",\r\n \"price\": 1499,\r\n \"stock\": 30,\r\n \"status\": \"active\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/products/{{id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Access token is missing or invalid\"\r\n}"},{"id":"d81c5142-d36a-4210-a7be-156679af3d0f","name":"404 Not Found - Product Not Found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Wireless Mouse\",\r\n \"description\": \"Ergonomic wireless mouse with adjustable DPI\",\r\n \"category\": \"Electronics\",\r\n \"price\": 1499,\r\n \"stock\": 30,\r\n \"status\": \"active\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/products/{{id}}"},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"Not Found\",\r\n \"message\": \"Product with given ID does not exist\"\r\n}"}],"_postman_id":"bcb64bf9-2bab-4cc4-8cc8-37091523db5e"},{"name":"Update Product (Partial)","id":"d28d14cd-d486-4737-a72a-cff10eeac91e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"price\": 1399,\r\n \"stock\": 40\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/products/{{id}}","description":"Partially updates one or more fields of an existing product.
\nOnly the fields provided in the request body will be updated.
\nRequires authorization.
\n","urlObject":{"protocol":"https","path":["v1","products","{{id}}"],"host":["api","example","com"],"query":[],"variable":[]}},"response":[{"id":"e5145f72-2485-40e4-9636-b93496ffe389","name":"200 OK - Product Partially Updated","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"price\": 1399,\r\n \"stock\": 40\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/products/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"p101\",\r\n \"price\": 1399,\r\n \"stock\": 40,\r\n \"updatedAt\": \"2025-02-19T09:45:00Z\"\r\n}"},{"id":"749c5718-912f-43fd-96b8-3c80d209bfb0","name":"400 Bad Request - Invalid Field Value","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"price\": -500\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/products/{{id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"Validation failed\",\r\n \"message\": \"Price must be greater than 0\"\r\n}"},{"id":"330aad07-22f4-4a27-b83f-3eaf8d63bc05","name":"401 Unauthorized - Missing or Invalid Access Token","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"price\": 1399,\r\n \"stock\": 40\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/products/{{id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Access token is missing or invalid\"\r\n}"},{"id":"44b44fe2-d442-42c7-bfa4-e6c080fe3772","name":"404 Not Found - Product Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"price\": 1399,\r\n \"stock\": 40\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.example.com/v1/products/{{id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"Not Found\",\r\n \"message\": \"Product with given ID does not exist\"\r\n}"}],"_postman_id":"d28d14cd-d486-4737-a72a-cff10eeac91e"},{"name":"Delete Product","id":"cde4038b-1f41-4005-847b-b8572737e4dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://api.example.com/v1/products/{{id}}","description":"Deletes a product from the catalog using its unique product ID.
\nThis action is irreversible and requires authorization.
\n","urlObject":{"protocol":"https","path":["v1","products","{{id}}"],"host":["api","example","com"],"query":[],"variable":[]}},"response":[{"id":"c2a50e59-38c9-4926-8ad4-6d86445d0d96","name":"204 No Content - Product Deleted","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://api.example.com/v1/products/{{id}}"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"f8a71fea-9edc-4eac-816b-20327fedfd53","name":"401 Unauthorized - Missing or Invalid Access Token","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://api.example.com/v1/products/{{id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Access token is missing or invalid\"\r\n}"},{"id":"a999a6eb-461a-4b8f-8bd9-cd1c0ba53f6a","name":"404 Not Found - Product Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://api.example.com/v1/products/{{id}}"},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"error\": \"Not Found\",\r\n \"message\": \"Product with given ID does not exist\"\r\n}"}],"_postman_id":"cde4038b-1f41-4005-847b-b8572737e4dd"}]}