{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/staging-api.hmr.ph" } ], "info": { "name": "API Documentation", "_postman_id": "b8c99d0e-5c44-4fcf-a1ae-ead6ff222a9e", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Customer Management", "description": "\nList of all Customer related endpoints", "item": [ { "name": "Authentication", "description": "Endpoints for managing customer's session", "item": [ { "name": "Generate Token", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/token", "query": [], "raw": "{{baseUrl}}\/auth\/token" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": { "mode": "raw", "raw": "{\"account_reference\":\"johndoe\",\"password\":\"i8WnzwH58PY4Xzr\",\"signature\":\"No-Example\"}" }, "description": "This endpoint allows you to generate a session token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"token_type\": \"Bearer\",\n \"access_token\": \"28|EIiQyqqRqDdrlCfV6POQr3YfzM2176OsX5vs4Kkk250b61d7\",\n \"refresh_token\": \"28|EIiQyqqRqDdrlCfV6POQr3YfzM2176OsX5vs4Kkk250b61d7\",\n \"expires_at\": \"2023-10-23T05:42:29.000000Z\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"These credentials do not match our records.\",\n \"errors\": {\n \"account_reference\": [\n \"These credentials do not match our records.\"\n ]\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Generate Token using Refresh Tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/refresh-token", "query": [], "raw": "{{baseUrl}}\/auth\/refresh-token" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": { "mode": "raw", "raw": "{\"signature\":\"No-Example\"}" }, "description": "This endpoint allows you to generate new session token using the refresh token." }, "response": [ { "header": [], "code": 200, "body": "{\n \"token_type\": \"Bearer\",\n \"access_token\": \"28|EIiQyqqRqDdrlCfV6POQr3YfzM2176OsX5vs4Kkk250b61d7\",\n \"expires_at\": \"2023-10-23T05:42:29.000000Z\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\",\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/logout", "query": [], "raw": "{{baseUrl}}\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": { "mode": "raw", "raw": "{\"signature\":\"No-Example\"}" }, "description": "This endpoint allows you to destroy the current active session token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": 1,\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\",\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] } ] }, { "name": "Customer Credentials", "description": "Endpoints for managing customer credentials", "item": [ { "name": "Forgot Password", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/forgot-password", "query": [], "raw": "{{baseUrl}}\/auth\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": { "mode": "raw", "raw": "{\"email\":\"natalie.gislason@example.net\",\"signature\":\"No-Example\"}" }, "description": "This endpoint allows you to request a \"Forgot Password\" token that will be sent to the specified email.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Deactivate Authenticated Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/deactivate", "query": [], "raw": "{{baseUrl}}\/auth\/deactivate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": { "mode": "raw", "raw": "{\"password\":\"provident\",\"signature\":\"No-Example\"}" }, "description": "This endpoint allows you to deactivate customer's account." }, "response": [] }, { "name": "Validate \"Forgot Password\" Token", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/forgot-password\/:token\/validate", "query": [], "raw": "{{baseUrl}}\/auth\/forgot-password\/:token\/validate", "variable": [ { "id": "token", "key": "token", "value": "9Ur2URVyTdwSW62QoVhGdHIUenrtZYlTYwYPrzLfaoqYv6bQYGoiaTVcS5LF", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": null, "description": "This endpoint allows you to check if the \"Forgot Password\" token is valid.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "5" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 200, "body": "{\"valid_token\":false}", "name": "" } ] }, { "name": "\"Forgot Password\" Token Based Update Password", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/update-password", "query": [], "raw": "{{baseUrl}}\/auth\/update-password" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": { "mode": "raw", "raw": "{\"password\":\"i8WnzwH58PY4Xzr\",\"token\":\"9Ur2URVyTdwSW62QoVhGdHIUenrtZYlTYwYPrzLfaoqYv6bQYGoiaTVcS5LF\",\"signature\":\"No-Example\"}" }, "description": "This endpoint allows you to update password based on \"Forgot Password\" request.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Change Active Session Customer Password", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/customer\/change-password", "query": [], "raw": "{{baseUrl}}\/auth\/customer\/change-password" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": { "mode": "raw", "raw": "{\"current_password\":\"i8WnzwH58PY4Xzr\",\"new_password\":\"i8WnzwH58PY4Xzr\",\"signature\":\"No-Example\"}" }, "description": "This endpoint allows you to update the active session customer password." }, "response": [] }, { "name": "Update Mobile Number", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/customer\/update-mobile-number", "query": [], "raw": "{{baseUrl}}\/auth\/customer\/update-mobile-number" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": { "mode": "raw", "raw": "{\"mobile_number\":\"639119731246\",\"signature\":\"No-Example\"}" }, "description": "This endpoint allows you to update customer's existing mobile number.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": 1,\n \"mobile_number\": \"6399******70\",\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\",\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The Mobile No. field is required.\",\n \"errors\": {\n \"mobile_number\": [\n \"The Mobile No. field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Retrieve Active Session Customer Details", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/customer", "query": [], "raw": "{{baseUrl}}\/auth\/customer" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": null, "description": "This endpoint allows you to retrieve customer's details." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Registration", "description": "Endpoints for managing registration.", "item": [ { "name": "Create Customer Account", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/register", "query": [], "raw": "{{baseUrl}}\/auth\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": { "mode": "raw", "raw": "{\"customer_firstname\":\"ycsfkfahpnqdfaxjf\",\"customer_lastname\":\"ciu\",\"customer_middlename\":\"iektbg\",\"customer_suffixname\":\"xfqxkszjazzpainlbu\",\"mobile_no\":\"639234392441\",\"username\":\"ualjgemkfte\",\"email\":\"amy13@example.com\",\"password\":\"#8?Wk3%?y\",\"consent\":true,\"verification_type\":\"Email\",\"verification_code\":\"sit\",\"auction_newsletter\":false,\"retail_newsletter\":true,\"signature\":\"No-Example\"}" }, "description": "This endpoint allows you to create a customer account.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": 1,\n \"message\": ... (Message varies on the type of verification used.)\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": ...,\n \"errors\": {\n ...\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Generate Registration Verification Code", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/register\/verification-code", "query": [], "raw": "{{baseUrl}}\/auth\/register\/verification-code" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": { "mode": "raw", "raw": "{\"verification_type\":\"Email\",\"account_reference\":\"doloremque\",\"signature\":\"No-Example\"}" }, "description": "This endpoint allows you to generate a verification code that will be sent to a specified mobile number\/email.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Resend Email Confirmation", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/email-confirmation\/resend", "query": [], "raw": "{{baseUrl}}\/auth\/email-confirmation\/resend" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": { "mode": "raw", "raw": "{\"email\":\"vincenzo.kassulke@example.net\",\"signature\":\"No-Example\"}" }, "description": "This endpoint allows you to resend new email confirmation.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": 1,\n \"status\": \"Confirmation email has been sent. Please check your email.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": ...,\n \"errors\": {\n ...\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "Generate Mobile Verification Code", "request": { "url": { "host": "{{baseUrl}}", "path": "auth\/mobile-verification\/generate", "query": [], "raw": "{{baseUrl}}\/auth\/mobile-verification\/generate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-Api-Key", "value": "No-Example" }, { "key": "X-Client-ID", "value": "No-Example" } ], "body": { "mode": "raw", "raw": "{\"mobile_no\":\"639123456789\",\"signature\":\"No-Example\"}" }, "description": "This endpoint allows you to generate a verification code that will be sent to a specified mobile number.\n