{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/ecomapi.bmehul.com" } ], "info": { "name": "ECom API", "_postman_id": "a5765e59-e414-42d7-8ee1-e2fc8e413ce1", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Generate Administrator", "description": "", "item": [ { "name": "Generate the admin user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/generate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/generate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"johndoe@example.com\",\"password\":\"Secret\",\"confirm_password\":\"Secret\"}" }, "description": "API to generate the super administrator. It is only a one-time call\nin the entire lifetime of the application.", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Common Endpoints", "description": "", "item": [ { "name": "Authentication", "description": "The endpoints that are common for all the users in the whole application.", "item": [ { "name": "Registration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/common\/register", "query": [], "raw": "{{baseUrl}}\/api\/common\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"johndoe@example.com\",\"password\":\"Secret\",\"confirm_password\":\"Secret\"}" }, "description": "API to register a user in the application.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"success\",\n \"message\": \"You have registered successfully.\",\n \"data\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"updated_at\": \"2023-06-01T14:46:10.000000Z\",\n \"created_at\": \"2023-06-01T14:46:10.000000Z\",\n \"id\": 2\n }\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The first name field is required. (and 4 more errors)\",\n \"errors\": {\n \"first_name\": [\n \"The first name field is required.\",\n ],\n \"last_name\": [\n \"The last name field is required.\",\n ],\n \"email\": [\n \"The email field is required.\",\n ],\n \"password\": [\n \"The password field is required.\",\n ],\n \"confirm_password\": [\n \"The confirm password field is required.\",\n ]\n }\n}\n", "name": "" } ] }, { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/common\/login", "query": [], "raw": "{{baseUrl}}\/api\/common\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"userone@example.com\",\"password\":\"Secret\"}" }, "description": "Login the user (admin and non-admin), and generate the bearer token.\nThis token will be used for further requests in the admin user panel or in the non-admin user panel.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/common\/logout", "query": [], "raw": "{{baseUrl}}\/api\/common\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Logout the admin user or non-admin user. When they log out, all the tokens\nrelated to their account will also get deleted." }, "response": [] } ] }, { "name": "Password Resetting", "description": "The endpoints URL for request password change and resetting the same.", "item": [ { "name": "Send Password Reset Link", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/common\/forgot-password", "query": [], "raw": "{{baseUrl}}\/api\/common\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"userone@example.com\"}" }, "description": "Send the password reset link to the provided email address via an E-Mail.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Reset Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/common\/reset-password", "query": [], "raw": "{{baseUrl}}\/api\/common\/reset-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"johndoe@example.com\",\"token\":\"PZj7o5NBJmWhmaJ6mAH8zMSOck5vFTlPOuaT\",\"new_password\":\"Secret\",\"repeat_new_password\":\"Secret\"}" }, "description": "Reset the admin's or the user's password with the new password.\nDeletes the record from the database table after resetting.", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Account Settings", "description": "The endpoints related to the user account of both admin user and non-admin user.", "item": [ { "name": "General Settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/common\/account-settings\/general", "query": [], "raw": "{{baseUrl}}\/api\/common\/account-settings\/general" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"johndoe@example.com\"}" }, "description": "Update the general settings of the user." }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"success\",\n \"message\": \"General Settings updated successfully.\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"created_at\": \"2023-05-17T00:00:00.000000Z\",\n \"updated_at\": \"2023-05-17T00:00:00.000000Z\",\n \"deleted_at\": null\n }\n}\n", "name": "" } ] }, { "name": "Change Password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/common\/account-settings\/change-password", "query": [], "raw": "{{baseUrl}}\/api\/common\/account-settings\/change-password" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"current_password\":\"Pa$$w0rd\",\"new_password\":\"Secret\",\"new_password_confirmation\":\"Secret\"}" }, "description": "Update the password of the currently authenticated admin user.\nIt will be updated only when the current password is matched." }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"success\",\n \"message\": \"Password updated successfully.\",\n \"data\": []\n}\n", "name": "" } ] } ] } ] }, { "name": "Administrator Endpoints", "description": "", "item": [ { "name": "Categories", "description": "", "item": [ { "name": "List All categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/categories", "query": [ { "key": "page", "value": "1", "description": "The page number. Defaults to 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/admin\/categories?page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display all the categories with pagination.\nAt a time, there are total of 16 records that will be displayed." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Qui Nobis Nisi\",\n \"slug\": \"qui-nobis-nisi\",\n \"meta_title\": \"Qui Nobis Nisi Laravel E-Commerce API\",\n \"meta_description\": \"Qui Nobis Nisi Laravel E-Commerce API\",\n \"meta_keywords\": \"Qui Nobis Nisi Laravel E-Commerce API\"\n },\n {\n \"id\": 2,\n \"name\": \"Aut Et Quidem\",\n \"slug\": \"aut-et-quidem\",\n \"meta_title\": \"Aut Et Quidem Laravel E-Commerce API\",\n \"meta_description\": \"Aut Et Quidem Laravel E-Commerce API\",\n \"meta_keywords\": \"Aut Et Quidem Laravel E-Commerce API\"\n },\n {\n \"id\": 3,\n \"name\": \"Nostrum Aut Optio\",\n \"slug\": \"nostrum-aut-optio\",\n \"meta_title\": \"Nostrum Aut Optio Laravel E-Commerce API\",\n \"meta_description\": \"Nostrum Aut Optio Laravel E-Commerce API\",\n \"meta_keywords\": \"Nostrum Aut Optio Laravel E-Commerce API\"\n },\n {\n \"id\": 4,\n \"name\": \"Perspiciatis Commodi Est\",\n \"slug\": \"perspiciatis-commodi-est\",\n \"meta_title\": \"Perspiciatis Commodi Est Laravel E-Commerce API\",\n \"meta_description\": \"Perspiciatis Commodi Est Laravel E-Commerce API\",\n \"meta_keywords\": \"Perspiciatis Commodi Est Laravel E-Commerce API\"\n },\n {\n \"id\": 5,\n \"name\": \"Nisi In Eveniet\",\n \"slug\": \"nisi-in-eveniet\",\n \"meta_title\": \"Nisi In Eveniet Laravel E-Commerce API\",\n \"meta_description\": \"Nisi In Eveniet Laravel E-Commerce API\",\n \"meta_keywords\": \"Nisi In Eveniet Laravel E-Commerce API\"\n },\n {\n \"id\": 6,\n \"name\": \"Possimus Placeat Ad\",\n \"slug\": \"possimus-placeat-ad\",\n \"meta_title\": \"Possimus Placeat Ad Laravel E-Commerce API\",\n \"meta_description\": \"Possimus Placeat Ad Laravel E-Commerce API\",\n \"meta_keywords\": \"Possimus Placeat Ad Laravel E-Commerce API\"\n },\n {\n \"id\": 7,\n \"name\": \"Maiores Quia Ut\",\n \"slug\": \"maiores-quia-ut\",\n \"meta_title\": \"Maiores Quia Ut Laravel E-Commerce API\",\n \"meta_description\": \"Maiores Quia Ut Laravel E-Commerce API\",\n \"meta_keywords\": \"Maiores Quia Ut Laravel E-Commerce API\"\n },\n {\n \"id\": 8,\n \"name\": \"Qui Repellat Molestias\",\n \"slug\": \"qui-repellat-molestias\",\n \"meta_title\": \"Qui Repellat Molestias Laravel E-Commerce API\",\n \"meta_description\": \"Qui Repellat Molestias Laravel E-Commerce API\",\n \"meta_keywords\": \"Qui Repellat Molestias Laravel E-Commerce API\"\n },\n {\n \"id\": 9,\n \"name\": \"Nisi Soluta Nihil\",\n \"slug\": \"nisi-soluta-nihil\",\n \"meta_title\": \"Nisi Soluta Nihil Laravel E-Commerce API\",\n \"meta_description\": \"Nisi Soluta Nihil Laravel E-Commerce API\",\n \"meta_keywords\": \"Nisi Soluta Nihil Laravel E-Commerce API\"\n },\n {\n \"id\": 10,\n \"name\": \"Esse Placeat Corrupti\",\n \"slug\": \"esse-placeat-corrupti\",\n \"meta_title\": \"Esse Placeat Corrupti Laravel E-Commerce API\",\n \"meta_description\": \"Esse Placeat Corrupti Laravel E-Commerce API\",\n \"meta_keywords\": \"Esse Placeat Corrupti Laravel E-Commerce API\"\n },\n {\n \"id\": 11,\n \"name\": \"Est Quas Libero\",\n \"slug\": \"est-quas-libero\",\n \"meta_title\": \"Est Quas Libero Laravel E-Commerce API\",\n \"meta_description\": \"Est Quas Libero Laravel E-Commerce API\",\n \"meta_keywords\": \"Est Quas Libero Laravel E-Commerce API\"\n },\n {\n \"id\": 12,\n \"name\": \"Dolorem Beatae Ipsa\",\n \"slug\": \"dolorem-beatae-ipsa\",\n \"meta_title\": \"Dolorem Beatae Ipsa Laravel E-Commerce API\",\n \"meta_description\": \"Dolorem Beatae Ipsa Laravel E-Commerce API\",\n \"meta_keywords\": \"Dolorem Beatae Ipsa Laravel E-Commerce API\"\n },\n {\n \"id\": 13,\n \"name\": \"Voluptatem Dolorem Doloremque\",\n \"slug\": \"voluptatem-dolorem-doloremque\",\n \"meta_title\": \"Voluptatem Dolorem Doloremque Laravel E-Commerce API\",\n \"meta_description\": \"Voluptatem Dolorem Doloremque Laravel E-Commerce API\",\n \"meta_keywords\": \"Voluptatem Dolorem Doloremque Laravel E-Commerce API\"\n },\n {\n \"id\": 14,\n \"name\": \"Necessitatibus Doloribus Beatae\",\n \"slug\": \"necessitatibus-doloribus-beatae\",\n \"meta_title\": \"Necessitatibus Doloribus Beatae Laravel E-Commerce API\",\n \"meta_description\": \"Necessitatibus Doloribus Beatae Laravel E-Commerce API\",\n \"meta_keywords\": \"Necessitatibus Doloribus Beatae Laravel E-Commerce API\"\n },\n {\n \"id\": 15,\n \"name\": \"Corrupti Eveniet Dolor\",\n \"slug\": \"corrupti-eveniet-dolor\",\n \"meta_title\": \"Corrupti Eveniet Dolor Laravel E-Commerce API\",\n \"meta_description\": \"Corrupti Eveniet Dolor Laravel E-Commerce API\",\n \"meta_keywords\": \"Corrupti Eveniet Dolor Laravel E-Commerce API\"\n },\n {\n \"id\": 16,\n \"name\": \"Dolorum Commodi Qui\",\n \"slug\": \"dolorum-commodi-qui\",\n \"meta_title\": \"Dolorum Commodi Qui Laravel E-Commerce API\",\n \"meta_description\": \"Dolorum Commodi Qui Laravel E-Commerce API\",\n \"meta_keywords\": \"Dolorum Commodi Qui Laravel E-Commerce API\"\n }\n ],\n \"first_page_url\": \"http:\/\/localhost:8000\/api\/v1\/admin\/categories?page=1\",\n \"from\": 1,\n \"last_page\": 4,\n \"last_page_url\": \"http:\/\/localhost:8000\/api\/v1\/admin\/categories?page=4\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000\/api\/v1\/admin\/categories?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"http:\/\/localhost:8000\/api\/v1\/admin\/categories?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000\/api\/v1\/admin\/categories?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000\/api\/v1\/admin\/categories?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000\/api\/v1\/admin\/categories?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": \"http:\/\/localhost:8000\/api\/v1\/admin\/categories?page=2\",\n \"path\": \"http:\/\/localhost:8000\/api\/v1\/admin\/categories\",\n \"per_page\": 16,\n \"prev_page_url\": null,\n \"to\": 16,\n \"total\": 50\n }\n}\n", "name": "" } ] }, { "name": "Add new category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/categories", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/categories" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"T-shirt for Women\",\"description\":\"T-shirt for Women made of the best quality materials sold all over the world.\",\"meta_title\":\"T-shirt for Women made of the best quality materials.\",\"meta_description\":\"T-shirt for Women made of the best quality materials sold all over the world.\",\"meta_keywords\":\"T-shirt, t-shirt for women, best quality tshirt for women\"}" }, "description": "Create a new category and store it's details." }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"success\",\n \"message\": \"Category added successfully.\",\n \"data\": {\n \"name\": \"Category 1\",\n \"description\": \"Qui aut quia soluta ut et repellendus aut.\",\n \"meta_title\": \"jqfpfenwpledzbrovcmnsylb\",\n \"meta_description\": \"sdovbzcbfmbwnxpgvrqzdi\",\n \"meta_keywords\": \"dvrisbpzc\",\n \"slug\": \"qblbi\",\n \"updated_at\": \"2023-05-18T00:00:00.000000Z\",\n \"created_at\": \"2023-05-18T00:00:00.000000Z\",\n \"id\": 1\n }\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The name field is required. (and 3 more errors)\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ],\n \"description\": [\n \"The description field is required.\"\n ],\n \"meta_title\": [\n \"The meta title field is required.\"\n ],\n \"meta_description\": [\n \"The meta description field is required.\"\n ]\n }\n}\n", "name": "" } ] }, { "name": "Get single category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/categories\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/categories\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the category." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch the details about the given category id." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"\",\n \"data\": {\n \"name\": \"Category 1\",\n \"description\": \"Qui aut quia soluta ut et repellendus aut.\",\n \"meta_title\": \"jqfpfenwpledzbrovcmnsylb\",\n \"meta_description\": \"sdovbzcbfmbwnxpgvrqzdi\",\n \"meta_keywords\": \"dvrisbpzc\",\n \"id\": 1\n }\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Category not found.\",\n \"data\": []\n}\n", "name": "" } ] }, { "name": "Update category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/categories\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/categories\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the category." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"T-shirt for Women\",\"description\":\"T-shirt for Women made of the best quality materials sold all over the world.\",\"meta_title\":\"T-shirt for Women made of the best quality materials.\",\"meta_description\":\"T-shirt for Women made of the best quality materials sold all over the world.\",\"meta_keywords\":\"T-shirt, t-shirt for women, best quality tshirt for women\"}" }, "description": "Update the category details of the given id." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Category updated successfully.\",\n \"data\": {\n \"name\": \"Category 1\",\n \"description\": \"Qui aut quia soluta ut et repellendus aut.\",\n \"meta_title\": \"jqfpfenwpledzbrovcmnsylb\",\n \"meta_description\": \"sdovbzcbfmbwnxpgvrqzdi\",\n \"meta_keywords\": \"dvrisbpzc\",\n \"slug\": \"qblbi\",\n \"updated_at\": \"2023-05-18T00:00:00.000000Z\",\n \"created_at\": \"2023-05-18T00:00:00.000000Z\",\n \"id\": 1\n }\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Category not found.\",\n \"data\": []\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The name field is required. (and 3 more errors)\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ],\n \"description\": [\n \"The description field is required.\"\n ],\n \"meta_title\": [\n \"The meta title field is required.\"\n ],\n \"meta_description\": [\n \"The meta description field is required.\"\n ]\n }\n}\n", "name": "" } ] }, { "name": "Delete a category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/categories\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/categories\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the category." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete the category details of the given id.\nThis will soft delete the category.\nMeaning the record will be present in the database, however,\nit won't be available to access." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Category deleted successfully.\",\n \"data\": [],\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Category not found.\",\n \"data\": []\n}\n", "name": "" } ] } ] }, { "name": "Tags", "description": "", "item": [ { "name": "List All tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/tags", "query": [ { "key": "page", "value": "1", "description": "The page number. Defaults to 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/admin\/tags?page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display all the tags with pagination.\nAt a time, there are total of 16 records that will be displayed." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Laborum Tempora Maxime\",\n \"slug\": \"laborum-tempora-maxime\",\n \"description\": \"Eos qui esse magnam molestiae dolorem perspiciatis.\",\n \"meta_title\": \"Laborum Tempora Maxime Laravel E-Commerce API\",\n \"meta_description\": \"Laborum Tempora Maxime Laravel E-Commerce API\",\n \"meta_keywords\": \"Laborum Tempora Maxime Laravel E-Commerce API\"\n },\n {\n \"id\": 2,\n \"name\": \"Officiis Sit Cum\",\n \"slug\": \"officiis-sit-cum\",\n \"description\": \"Dolores optio sapiente voluptatem.\",\n \"meta_title\": \"Officiis Sit Cum Laravel E-Commerce API\",\n \"meta_description\": \"Officiis Sit Cum Laravel E-Commerce API\",\n \"meta_keywords\": \"Officiis Sit Cum Laravel E-Commerce API\"\n },\n {\n \"id\": 3,\n \"name\": \"Sed Eaque Sapiente\",\n \"slug\": \"sed-eaque-sapiente\",\n \"description\": \"Nostrum est autem ut consectetur.\",\n \"meta_title\": \"Sed Eaque Sapiente Laravel E-Commerce API\",\n \"meta_description\": \"Sed Eaque Sapiente Laravel E-Commerce API\",\n \"meta_keywords\": \"Sed Eaque Sapiente Laravel E-Commerce API\"\n },\n {\n \"id\": 4,\n \"name\": \"Porro Sunt Et\",\n \"slug\": \"porro-sunt-et\",\n \"description\": \"Consequatur enim eos sed voluptatum eos.\",\n \"meta_title\": \"Porro Sunt Et Laravel E-Commerce API\",\n \"meta_description\": \"Porro Sunt Et Laravel E-Commerce API\",\n \"meta_keywords\": \"Porro Sunt Et Laravel E-Commerce API\"\n },\n {\n \"id\": 5,\n \"name\": \"Voluptatem Esse Commodi\",\n \"slug\": \"voluptatem-esse-commodi\",\n \"description\": \"Ipsum ullam voluptatem debitis dolorem.\",\n \"meta_title\": \"Voluptatem Esse Commodi Laravel E-Commerce API\",\n \"meta_description\": \"Voluptatem Esse Commodi Laravel E-Commerce API\",\n \"meta_keywords\": \"Voluptatem Esse Commodi Laravel E-Commerce API\"\n },\n {\n \"id\": 6,\n \"name\": \"Fugit Maiores Voluptas\",\n \"slug\": \"fugit-maiores-voluptas\",\n \"description\": \"Culpa aut sit voluptatem ut et.\",\n \"meta_title\": \"Fugit Maiores Voluptas Laravel E-Commerce API\",\n \"meta_description\": \"Fugit Maiores Voluptas Laravel E-Commerce API\",\n \"meta_keywords\": \"Fugit Maiores Voluptas Laravel E-Commerce API\"\n },\n {\n \"id\": 7,\n \"name\": \"Et Ex Molestiae\",\n \"slug\": \"et-ex-molestiae\",\n \"description\": \"Asperiores sit et natus.\",\n \"meta_title\": \"Et Ex Molestiae Laravel E-Commerce API\",\n \"meta_description\": \"Et Ex Molestiae Laravel E-Commerce API\",\n \"meta_keywords\": \"Et Ex Molestiae Laravel E-Commerce API\"\n },\n {\n \"id\": 8,\n \"name\": \"Dicta Est Sunt\",\n \"slug\": \"dicta-est-sunt\",\n \"description\": \"Tenetur eum aperiam non error.\",\n \"meta_title\": \"Dicta Est Sunt Laravel E-Commerce API\",\n \"meta_description\": \"Dicta Est Sunt Laravel E-Commerce API\",\n \"meta_keywords\": \"Dicta Est Sunt Laravel E-Commerce API\"\n },\n {\n \"id\": 9,\n \"name\": \"Perferendis Earum Facilis\",\n \"slug\": \"perferendis-earum-facilis\",\n \"description\": \"Aut aut molestiae similique commodi nam iure.\",\n \"meta_title\": \"Perferendis Earum Facilis Laravel E-Commerce API\",\n \"meta_description\": \"Perferendis Earum Facilis Laravel E-Commerce API\",\n \"meta_keywords\": \"Perferendis Earum Facilis Laravel E-Commerce API\"\n },\n {\n \"id\": 10,\n \"name\": \"Vero Aut Architecto\",\n \"slug\": \"vero-aut-architecto\",\n \"description\": \"Delectus dolorem mollitia eius.\",\n \"meta_title\": \"Vero Aut Architecto Laravel E-Commerce API\",\n \"meta_description\": \"Vero Aut Architecto Laravel E-Commerce API\",\n \"meta_keywords\": \"Vero Aut Architecto Laravel E-Commerce API\"\n },\n {\n \"id\": 11,\n \"name\": \"Nihil Eum Aut\",\n \"slug\": \"nihil-eum-aut\",\n \"description\": \"Voluptatem laboriosam eum error nulla quo facilis.\",\n \"meta_title\": \"Nihil Eum Aut Laravel E-Commerce API\",\n \"meta_description\": \"Nihil Eum Aut Laravel E-Commerce API\",\n \"meta_keywords\": \"Nihil Eum Aut Laravel E-Commerce API\"\n },\n {\n \"id\": 12,\n \"name\": \"Omnis Optio Ipsam\",\n \"slug\": \"omnis-optio-ipsam\",\n \"description\": \"Rerum eveniet et qui non minima aperiam id.\",\n \"meta_title\": \"Omnis Optio Ipsam Laravel E-Commerce API\",\n \"meta_description\": \"Omnis Optio Ipsam Laravel E-Commerce API\",\n \"meta_keywords\": \"Omnis Optio Ipsam Laravel E-Commerce API\"\n },\n {\n \"id\": 13,\n \"name\": \"Incidunt Nesciunt Hic\",\n \"slug\": \"incidunt-nesciunt-hic\",\n \"description\": \"Eum nulla laborum eius ut sit hic.\",\n \"meta_title\": \"Incidunt Nesciunt Hic Laravel E-Commerce API\",\n \"meta_description\": \"Incidunt Nesciunt Hic Laravel E-Commerce API\",\n \"meta_keywords\": \"Incidunt Nesciunt Hic Laravel E-Commerce API\"\n },\n {\n \"id\": 14,\n \"name\": \"Velit Quia Sit\",\n \"slug\": \"velit-quia-sit\",\n \"description\": \"Deleniti voluptatem rerum et necessitatibus voluptas.\",\n \"meta_title\": \"Velit Quia Sit Laravel E-Commerce API\",\n \"meta_description\": \"Velit Quia Sit Laravel E-Commerce API\",\n \"meta_keywords\": \"Velit Quia Sit Laravel E-Commerce API\"\n },\n {\n \"id\": 15,\n \"name\": \"Omnis Sint Est\",\n \"slug\": \"omnis-sint-est\",\n \"description\": \"Totam quasi velit occaecati non ducimus.\",\n \"meta_title\": \"Omnis Sint Est Laravel E-Commerce API\",\n \"meta_description\": \"Omnis Sint Est Laravel E-Commerce API\",\n \"meta_keywords\": \"Omnis Sint Est Laravel E-Commerce API\"\n },\n {\n \"id\": 16,\n \"name\": \"Inventore Earum Aliquam\",\n \"slug\": \"inventore-earum-aliquam\",\n \"description\": \"Libero commodi laboriosam ipsam accusantium laborum voluptas.\",\n \"meta_title\": \"Inventore Earum Aliquam Laravel E-Commerce API\",\n \"meta_description\": \"Inventore Earum Aliquam Laravel E-Commerce API\",\n \"meta_keywords\": \"Inventore Earum Aliquam Laravel E-Commerce API\"\n }\n ],\n \"first_page_url\": \"http:\/\/localhost:8000?page=1\",\n \"from\": 1,\n \"last_page\": 4,\n \"last_page_url\": \"http:\/\/localhost:8000?page=4\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"&laquo; Previous\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=2\",\n \"label\": \"Next &raquo;\",\n \"active\": false\n }\n ],\n \"next_page_url\": \"http:\/\/localhost:8000?page=2\",\n \"path\": \"http:\/\/localhost:8000\",\n \"per_page\": 16,\n \"prev_page_url\": null,\n \"to\": 16,\n \"total\": 50\n }\n}\n", "name": "" } ] }, { "name": "Add new tag", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/tags", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/tags" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"T-shirt for Women\",\"description\":\"T-shirt for Women made of the best quality materials sold all over the world.\",\"meta_title\":\"T-shirt for Women made of the best quality materials.\",\"meta_description\":\"T-shirt for Women made of the best quality materials sold all over the world.\",\"meta_keywords\":\"T-shirt, t-shirt for women, best quality tshirt for women\"}" }, "description": "Create a new tag and store it's details." }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"success\",\n \"message\": \"Tag added successfully.\",\n \"data\": {\n \"name\": \"Tag 1\",\n \"description\": \"Qui aut quia soluta ut et repellendus aut.\",\n \"meta_title\": \"jqfpfenwpledzbrovcmnsylb\",\n \"meta_description\": \"sdovbzcbfmbwnxpgvrqzdi\",\n \"meta_keywords\": \"dvrisbpzc\",\n \"slug\": \"qblbi\",\n \"updated_at\": \"2023-05-18T00:00:00.000000Z\",\n \"created_at\": \"2023-05-18T00:00:00.000000Z\",\n \"id\": 1\n }\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The name field is required. (and 3 more errors)\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ],\n \"description\": [\n \"The description field is required.\"\n ],\n \"meta_title\": [\n \"The meta title field is required.\"\n ],\n \"meta_description\": [\n \"The meta description field is required.\"\n ]\n }\n}\n", "name": "" } ] }, { "name": "Get single tag", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/tags\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/tags\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the tag." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch the details about the given tag id." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"\",\n \"data\": {\n \"name\": \"Tag 1\",\n \"description\": \"Qui aut quia soluta ut et repellendus aut.\",\n \"meta_title\": \"jqfpfenwpledzbrovcmnsylb\",\n \"meta_description\": \"sdovbzcbfmbwnxpgvrqzdi\",\n \"meta_keywords\": \"dvrisbpzc\",\n \"id\": 1\n }\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Tag not found.\",\n \"data\": []\n}\n", "name": "" } ] }, { "name": "Update tag", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/tags\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/tags\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the tag." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"T-shirt for Women\",\"description\":\"T-shirt for Women made of the best quality materials sold all over the world.\",\"meta_title\":\"T-shirt for Women made of the best quality materials.\",\"meta_description\":\"T-shirt for Women made of the best quality materials sold all over the world.\",\"meta_keywords\":\"T-shirt, t-shirt for women, best quality tshirt for women\"}" }, "description": "Update the tag details of the given id." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Tag updated successfully.\",\n \"data\": {\n \"name\": \"Tag 1\",\n \"description\": \"Qui aut quia soluta ut et repellendus aut.\",\n \"meta_title\": \"jqfpfenwpledzbrovcmnsylb\",\n \"meta_description\": \"sdovbzcbfmbwnxpgvrqzdi\",\n \"meta_keywords\": \"dvrisbpzc\",\n \"slug\": \"qblbi\",\n \"updated_at\": \"2023-05-18T00:00:00.000000Z\",\n \"created_at\": \"2023-05-18T00:00:00.000000Z\",\n \"id\": 1\n }\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Tag not found.\",\n \"data\": []\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The name field is required. (and 3 more errors)\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ],\n \"description\": [\n \"The description field is required.\"\n ],\n \"meta_title\": [\n \"The meta title field is required.\"\n ],\n \"meta_description\": [\n \"The meta description field is required.\"\n ]\n }\n}\n", "name": "" } ] }, { "name": "Delete a tag", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/tags\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/tags\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the tag." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete the tag details of the given id.\nThis will soft delete the tag.\nMeaning the record will be present in the database, however,\nit won't be available to access." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Tag deleted successfully.\",\n \"data\": []\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Tag not found.\",\n \"data\": []\n}\n", "name": "" } ] } ] }, { "name": "Brands", "description": "", "item": [ { "name": "List All brands", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/brands", "query": [ { "key": "page", "value": "1", "description": "The page number. Defaults to 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/admin\/brands?page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display all the brands with pagination.\nAt a time, there are total of 16 records that will be displayed." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Sint Rerum Officiis\",\n \"slug\": \"sint-rerum-officiis\",\n \"meta_title\": \"Sint Rerum Officiis Laravel E-Commerce API\",\n \"meta_description\": \"Sint Rerum Officiis Laravel E-Commerce API\",\n \"meta_keywords\": \"Sint Rerum Officiis Laravel E-Commerce API\"\n },\n {\n \"id\": 2,\n \"name\": \"Corporis Earum Quas\",\n \"slug\": \"corporis-earum-quas\",\n \"meta_title\": \"Corporis Earum Quas Laravel E-Commerce API\",\n \"meta_description\": \"Corporis Earum Quas Laravel E-Commerce API\",\n \"meta_keywords\": \"Corporis Earum Quas Laravel E-Commerce API\"\n },\n {\n \"id\": 3,\n \"name\": \"Adipisci Incidunt Et\",\n \"slug\": \"adipisci-incidunt-et\",\n \"meta_title\": \"Adipisci Incidunt Et Laravel E-Commerce API\",\n \"meta_description\": \"Adipisci Incidunt Et Laravel E-Commerce API\",\n \"meta_keywords\": \"Adipisci Incidunt Et Laravel E-Commerce API\"\n },\n {\n \"id\": 4,\n \"name\": \"Voluptatem Maiores Et\",\n \"slug\": \"voluptatem-maiores-et\",\n \"meta_title\": \"Voluptatem Maiores Et Laravel E-Commerce API\",\n \"meta_description\": \"Voluptatem Maiores Et Laravel E-Commerce API\",\n \"meta_keywords\": \"Voluptatem Maiores Et Laravel E-Commerce API\"\n },\n {\n \"id\": 5,\n \"name\": \"Doloremque Sequi Aut\",\n \"slug\": \"doloremque-sequi-aut\",\n \"meta_title\": \"Doloremque Sequi Aut Laravel E-Commerce API\",\n \"meta_description\": \"Doloremque Sequi Aut Laravel E-Commerce API\",\n \"meta_keywords\": \"Doloremque Sequi Aut Laravel E-Commerce API\"\n },\n {\n \"id\": 6,\n \"name\": \"Beatae Quidem Ipsam\",\n \"slug\": \"beatae-quidem-ipsam\",\n \"meta_title\": \"Beatae Quidem Ipsam Laravel E-Commerce API\",\n \"meta_description\": \"Beatae Quidem Ipsam Laravel E-Commerce API\",\n \"meta_keywords\": \"Beatae Quidem Ipsam Laravel E-Commerce API\"\n },\n {\n \"id\": 7,\n \"name\": \"Quia Atque Consequatur\",\n \"slug\": \"quia-atque-consequatur\",\n \"meta_title\": \"Quia Atque Consequatur Laravel E-Commerce API\",\n \"meta_description\": \"Quia Atque Consequatur Laravel E-Commerce API\",\n \"meta_keywords\": \"Quia Atque Consequatur Laravel E-Commerce API\"\n },\n {\n \"id\": 8,\n \"name\": \"Eaque Commodi Fugit\",\n \"slug\": \"eaque-commodi-fugit\",\n \"meta_title\": \"Eaque Commodi Fugit Laravel E-Commerce API\",\n \"meta_description\": \"Eaque Commodi Fugit Laravel E-Commerce API\",\n \"meta_keywords\": \"Eaque Commodi Fugit Laravel E-Commerce API\"\n },\n {\n \"id\": 9,\n \"name\": \"Molestiae Pariatur Error\",\n \"slug\": \"molestiae-pariatur-error\",\n \"meta_title\": \"Molestiae Pariatur Error Laravel E-Commerce API\",\n \"meta_description\": \"Molestiae Pariatur Error Laravel E-Commerce API\",\n \"meta_keywords\": \"Molestiae Pariatur Error Laravel E-Commerce API\"\n },\n {\n \"id\": 10,\n \"name\": \"Odio Omnis Et\",\n \"slug\": \"odio-omnis-et\",\n \"meta_title\": \"Odio Omnis Et Laravel E-Commerce API\",\n \"meta_description\": \"Odio Omnis Et Laravel E-Commerce API\",\n \"meta_keywords\": \"Odio Omnis Et Laravel E-Commerce API\"\n },\n {\n \"id\": 11,\n \"name\": \"Totam Perferendis Provident\",\n \"slug\": \"totam-perferendis-provident\",\n \"meta_title\": \"Totam Perferendis Provident Laravel E-Commerce API\",\n \"meta_description\": \"Totam Perferendis Provident Laravel E-Commerce API\",\n \"meta_keywords\": \"Totam Perferendis Provident Laravel E-Commerce API\"\n },\n {\n \"id\": 12,\n \"name\": \"Vitae Non Voluptas\",\n \"slug\": \"vitae-non-voluptas\",\n \"meta_title\": \"Vitae Non Voluptas Laravel E-Commerce API\",\n \"meta_description\": \"Vitae Non Voluptas Laravel E-Commerce API\",\n \"meta_keywords\": \"Vitae Non Voluptas Laravel E-Commerce API\"\n },\n {\n \"id\": 13,\n \"name\": \"Tempora Et Aut\",\n \"slug\": \"tempora-et-aut\",\n \"meta_title\": \"Tempora Et Aut Laravel E-Commerce API\",\n \"meta_description\": \"Tempora Et Aut Laravel E-Commerce API\",\n \"meta_keywords\": \"Tempora Et Aut Laravel E-Commerce API\"\n },\n {\n \"id\": 14,\n \"name\": \"Unde Quis Itaque\",\n \"slug\": \"unde-quis-itaque\",\n \"meta_title\": \"Unde Quis Itaque Laravel E-Commerce API\",\n \"meta_description\": \"Unde Quis Itaque Laravel E-Commerce API\",\n \"meta_keywords\": \"Unde Quis Itaque Laravel E-Commerce API\"\n },\n {\n \"id\": 15,\n \"name\": \"Harum Nisi Sed\",\n \"slug\": \"harum-nisi-sed\",\n \"meta_title\": \"Harum Nisi Sed Laravel E-Commerce API\",\n \"meta_description\": \"Harum Nisi Sed Laravel E-Commerce API\",\n \"meta_keywords\": \"Harum Nisi Sed Laravel E-Commerce API\"\n },\n {\n \"id\": 16,\n \"name\": \"Dolore Et Aperiam\",\n \"slug\": \"dolore-et-aperiam\",\n \"meta_title\": \"Dolore Et Aperiam Laravel E-Commerce API\",\n \"meta_description\": \"Dolore Et Aperiam Laravel E-Commerce API\",\n \"meta_keywords\": \"Dolore Et Aperiam Laravel E-Commerce API\"\n }\n ],\n \"first_page_url\": \"http:\/\/localhost:8000?page=1\",\n \"from\": 1,\n \"last_page\": 4,\n \"last_page_url\": \"http:\/\/localhost:8000?page=4\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": \"http:\/\/localhost:8000?page=2\",\n \"path\": \"http:\/\/localhost:8000\",\n \"per_page\": 16,\n \"prev_page_url\": null,\n \"to\": 16,\n \"total\": 50\n }\n}\n", "name": "" } ] }, { "name": "Add new Brand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/brands", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/brands" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Gucci\",\"description\":\"Gucci clothes made of the best quality materials sold all over the world.\",\"meta_title\":\"Gucci clothes made of the best quality materials.\",\"meta_description\":\"Gucci clothes made of the best quality materials sold all over the world.\",\"meta_keywords\":\"T-shirt, Gucci clothes, best quality tshirt for women\"}" }, "description": "Create a new Brand and store it's details." }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"success\",\n \"message\": \"Brand added successfully.\",\n \"data\": {\n \"name\": \"Brand 1\",\n \"description\": \"Qui aut quia soluta ut et repellendus aut.\",\n \"meta_title\": \"jqfpfenwpledzbrovcmnsylb\",\n \"meta_description\": \"sdovbzcbfmbwnxpgvrqzdi\",\n \"meta_keywords\": \"dvrisbpzc\",\n \"slug\": \"qblbi\",\n \"updated_at\": \"2023-05-18T00:00:00.000000Z\",\n \"created_at\": \"2023-05-18T00:00:00.000000Z\",\n \"id\": 1\n }\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The name field is required. (and 3 more errors)\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ],\n \"description\": [\n \"The description field is required.\"\n ],\n \"meta_title\": [\n \"The meta title field is required.\"\n ],\n \"meta_description\": [\n \"The meta description field is required.\"\n ]\n }\n}\n", "name": "" } ] }, { "name": "Get single Brand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/brands\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/brands\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the Brand." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch the details about the given Brand id." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"\",\n \"data\": {\n \"name\": \"Brand 1\",\n \"description\": \"Qui aut quia soluta ut et repellendus aut.\",\n \"meta_title\": \"jqfpfenwpledzbrovcmnsylb\",\n \"meta_description\": \"sdovbzcbfmbwnxpgvrqzdi\",\n \"meta_keywords\": \"dvrisbpzc\",\n \"id\": 1\n }\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Brand not found.\",\n \"data\": []\n}\n", "name": "" } ] }, { "name": "Update Brand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/brands\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/brands\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the Brand." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Gucci\",\"description\":\"Gucci clothes made of the best quality materials sold all over the world.\",\"meta_title\":\"Gucci clothes made of the best quality materials.\",\"meta_description\":\"Gucci clothes made of the best quality materials sold all over the world.\",\"meta_keywords\":\"T-shirt, Gucci clothes, best quality tshirt for women\"}" }, "description": "Update the Brand details of the given id." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Brand updated successfully.\",\n \"data\": {\n \"name\": \"Brand 1\",\n \"description\": \"Qui aut quia soluta ut et repellendus aut.\",\n \"meta_title\": \"jqfpfenwpledzbrovcmnsylb\",\n \"meta_description\": \"sdovbzcbfmbwnxpgvrqzdi\",\n \"meta_keywords\": \"dvrisbpzc\",\n \"slug\": \"qblbi\",\n \"updated_at\": \"2023-05-18T00:00:00.000000Z\",\n \"created_at\": \"2023-05-18T00:00:00.000000Z\",\n \"id\": 1\n }\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Brand not found.\",\n \"data\": []\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The name field is required. (and 3 more errors)\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ],\n \"description\": [\n \"The description field is required.\"\n ],\n \"meta_title\": [\n \"The meta title field is required.\"\n ],\n \"meta_description\": [\n \"The meta description field is required.\"\n ]\n }\n}\n", "name": "" } ] }, { "name": "Delete a Brand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/brands\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/brands\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the Brand." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete the Brand details of the given id.\nThis will soft delete the Brand.\nMeaning the record will be present in the database, however,\nit won't be available to access." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Brand deleted successfully.\",\n \"data\": []\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Brand not found.\",\n \"data\": []\n}\n", "name": "" } ] } ] }, { "name": "Products", "description": "", "item": [ { "name": "List All products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/products", "query": [ { "key": "page", "value": "1", "description": "The page number. Defaults to 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/admin\/products?page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Display all the products with pagination.\nAt a time, there are total of 16 records that will be displayed." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"\",\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"category_id\": 52,\n \"brand_id\": 51,\n \"name\": \"Iusto Occaecati Necessitatibus Non Asperiores\",\n \"slug\": \"iusto-occaecati-necessitatibus-non-asperiores\",\n \"rate\": 64.46,\n \"quantity\": 5,\n \"description\": \"Inventore nihil repellat similique exercitationem. Optio veritatis commodi amet ipsum tempore mollitia. Dolor enim sunt repudiandae nemo eaque suscipit quis. Cum animi quia error vero natus ratione eveniet odio. Est consectetur doloremque qui fugiat recusandae facilis aut reprehenderit.\",\n \"meta_title\": \"Iusto Occaecati Necessitatibus Non Asperiores Laravel E-Commerce API\",\n \"meta_description\": \"Iusto Occaecati Necessitatibus Non Asperiores Laravel E-Commerce API\",\n \"meta_keywords\": \"Iusto Occaecati Necessitatibus Non Asperiores Laravel E-Commerce API\",\n \"category\": {\n \"id\": 52,\n \"name\": \"Natus Beatae Dolorem\",\n \"slug\": \"natus-beatae-dolorem\"\n },\n \"brand\": {\n \"id\": 51,\n \"name\": \"Quidem Natus Laboriosam\",\n \"slug\": \"quidem-natus-laboriosam\"\n }\n },\n {\n \"id\": 2,\n \"category_id\": 53,\n \"brand_id\": 52,\n \"name\": \"Cum Sit Consequatur Sit Eum\",\n \"slug\": \"cum-sit-consequatur-sit-eum\",\n \"rate\": 469.78,\n \"quantity\": 7,\n \"description\": \"Tempore voluptatem quia aut asperiores. Sit eos doloribus esse. Deleniti ea quod repellat aut officiis doloremque voluptatem aut. Eos quam omnis culpa ut laudantium sit dolores. Qui reiciendis qui sunt et repudiandae.\",\n \"meta_title\": \"Cum Sit Consequatur Sit Eum Laravel E-Commerce API\",\n \"meta_description\": \"Cum Sit Consequatur Sit Eum Laravel E-Commerce API\",\n \"meta_keywords\": \"Cum Sit Consequatur Sit Eum Laravel E-Commerce API\",\n \"category\": {\n \"id\": 53,\n \"name\": \"Sit Numquam Ducimus\",\n \"slug\": \"sit-numquam-ducimus\"\n },\n \"brand\": {\n \"id\": 52,\n \"name\": \"Provident Totam Quaerat\",\n \"slug\": \"provident-totam-quaerat\"\n }\n },\n {\n \"id\": 3,\n \"category_id\": 54,\n \"brand_id\": 53,\n \"name\": \"Veniam Odio Ipsam Enim Quia\",\n \"slug\": \"veniam-odio-ipsam-enim-quia\",\n \"rate\": 787.46,\n \"quantity\": 0,\n \"description\": \"Rerum itaque qui sint quo dolorem. Quis vel necessitatibus cum aliquid ullam fugit. In consequatur et cumque est et voluptas architecto. Dicta impedit velit quia vel neque culpa voluptatem. Adipisci nesciunt maiores cupiditate enim nihil id tenetur.\",\n \"meta_title\": \"Veniam Odio Ipsam Enim Quia Laravel E-Commerce API\",\n \"meta_description\": \"Veniam Odio Ipsam Enim Quia Laravel E-Commerce API\",\n \"meta_keywords\": \"Veniam Odio Ipsam Enim Quia Laravel E-Commerce API\",\n \"category\": {\n \"id\": 54,\n \"name\": \"Animi Fuga Quisquam\",\n \"slug\": \"animi-fuga-quisquam\"\n },\n \"brand\": {\n \"id\": 53,\n \"name\": \"Quia Ut Error\",\n \"slug\": \"quia-ut-error\"\n }\n },\n {\n \"id\": 4,\n \"category_id\": 55,\n \"brand_id\": 54,\n \"name\": \"Maxime Repellat Perferendis Corrupti Quae\",\n \"slug\": \"maxime-repellat-perferendis-corrupti-quae\",\n \"rate\": 144.82,\n \"quantity\": 8,\n \"description\": \"Rem ratione qui consectetur non. Velit dolor quia ad omnis consequatur. Velit soluta esse sunt aspernatur. Sed labore aut soluta est iure dicta est. Molestias aut earum quo.\",\n \"meta_title\": \"Maxime Repellat Perferendis Corrupti Quae Laravel E-Commerce API\",\n \"meta_description\": \"Maxime Repellat Perferendis Corrupti Quae Laravel E-Commerce API\",\n \"meta_keywords\": \"Maxime Repellat Perferendis Corrupti Quae Laravel E-Commerce API\",\n \"category\": {\n \"id\": 55,\n \"name\": \"Velit Animi Labore\",\n \"slug\": \"velit-animi-labore\"\n },\n \"brand\": {\n \"id\": 54,\n \"name\": \"Ipsum Libero Tenetur\",\n \"slug\": \"ipsum-libero-tenetur\"\n }\n },\n {\n \"id\": 5,\n \"category_id\": 56,\n \"brand_id\": 55,\n \"name\": \"Non Perspiciatis Dignissimos Nesciunt Libero\",\n \"slug\": \"non-perspiciatis-dignissimos-nesciunt-libero\",\n \"rate\": 896.54,\n \"quantity\": 6,\n \"description\": \"Fugit et sed aperiam sit quas libero harum. Quam quae eos quis nobis. Est dignissimos esse in unde ipsum. Sed asperiores rerum reiciendis architecto enim fugiat omnis et. Nihil facilis qui aut culpa.\",\n \"meta_title\": \"Non Perspiciatis Dignissimos Nesciunt Libero Laravel E-Commerce API\",\n \"meta_description\": \"Non Perspiciatis Dignissimos Nesciunt Libero Laravel E-Commerce API\",\n \"meta_keywords\": \"Non Perspiciatis Dignissimos Nesciunt Libero Laravel E-Commerce API\",\n \"category\": {\n \"id\": 56,\n \"name\": \"Consequatur Sapiente Dolores\",\n \"slug\": \"consequatur-sapiente-dolores\"\n },\n \"brand\": {\n \"id\": 55,\n \"name\": \"Voluptatem Ad Dicta\",\n \"slug\": \"voluptatem-ad-dicta\"\n }\n },\n {\n \"id\": 6,\n \"category_id\": 57,\n \"brand_id\": 56,\n \"name\": \"Explicabo Impedit Officiis Voluptas Cum\",\n \"slug\": \"explicabo-impedit-officiis-voluptas-cum\",\n \"rate\": 832.42,\n \"quantity\": 8,\n \"description\": \"Nulla ut ab ipsum molestiae dolor sit. Nam esse ab temporibus nam ad. Illo a beatae sequi. Enim similique sit aliquid eum quae omnis adipisci. Cum accusantium vel quam illum voluptates.\",\n \"meta_title\": \"Explicabo Impedit Officiis Voluptas Cum Laravel E-Commerce API\",\n \"meta_description\": \"Explicabo Impedit Officiis Voluptas Cum Laravel E-Commerce API\",\n \"meta_keywords\": \"Explicabo Impedit Officiis Voluptas Cum Laravel E-Commerce API\",\n \"category\": {\n \"id\": 57,\n \"name\": \"Suscipit Exercitationem Accusantium\",\n \"slug\": \"suscipit-exercitationem-accusantium\"\n },\n \"brand\": {\n \"id\": 56,\n \"name\": \"Totam Harum Voluptatem\",\n \"slug\": \"totam-harum-voluptatem\"\n }\n },\n {\n \"id\": 7,\n \"category_id\": 58,\n \"brand_id\": 57,\n \"name\": \"Iure Quis Est Repellendus Quia\",\n \"slug\": \"iure-quis-est-repellendus-quia\",\n \"rate\": 345.94,\n \"quantity\": 2,\n \"description\": \"Voluptas omnis incidunt quia nisi dolor quia magnam. Ea qui libero corporis eos. Qui architecto minus dolore quas atque. Adipisci consequuntur et a dolorem alias consequatur quas. Fuga voluptatibus maiores et minima.\",\n \"meta_title\": \"Iure Quis Est Repellendus Quia Laravel E-Commerce API\",\n \"meta_description\": \"Iure Quis Est Repellendus Quia Laravel E-Commerce API\",\n \"meta_keywords\": \"Iure Quis Est Repellendus Quia Laravel E-Commerce API\",\n \"category\": {\n \"id\": 58,\n \"name\": \"Aspernatur Quis Accusantium\",\n \"slug\": \"aspernatur-quis-accusantium\"\n },\n \"brand\": {\n \"id\": 57,\n \"name\": \"Expedita Aut Et\",\n \"slug\": \"expedita-aut-et\"\n }\n },\n {\n \"id\": 8,\n \"category_id\": 59,\n \"brand_id\": 58,\n \"name\": \"Omnis Est Quisquam Et Occaecati\",\n \"slug\": \"omnis-est-quisquam-et-occaecati\",\n \"rate\": 568.97,\n \"quantity\": 8,\n \"description\": \"Vero eaque non sint repudiandae ipsum. Vitae culpa quo porro placeat. Amet similique aliquid exercitationem eum. Vero nostrum doloremque occaecati. At ut laudantium quaerat qui exercitationem explicabo dolores.\",\n \"meta_title\": \"Omnis Est Quisquam Et Occaecati Laravel E-Commerce API\",\n \"meta_description\": \"Omnis Est Quisquam Et Occaecati Laravel E-Commerce API\",\n \"meta_keywords\": \"Omnis Est Quisquam Et Occaecati Laravel E-Commerce API\",\n \"category\": {\n \"id\": 59,\n \"name\": \"Nihil Unde Mollitia\",\n \"slug\": \"nihil-unde-mollitia\"\n },\n \"brand\": {\n \"id\": 58,\n \"name\": \"Nihil Praesentium Dicta\",\n \"slug\": \"nihil-praesentium-dicta\"\n }\n },\n {\n \"id\": 9,\n \"category_id\": 60,\n \"brand_id\": 59,\n \"name\": \"A Assumenda Eaque Aperiam Omnis\",\n \"slug\": \"a-assumenda-eaque-aperiam-omnis\",\n \"rate\": 204.36,\n \"quantity\": 4,\n \"description\": \"Possimus non ullam fugiat. Error culpa eveniet aut ipsum harum quia voluptate. Perspiciatis consequuntur asperiores magni aspernatur libero. A ut fuga quas iure ab. Recusandae ut ad dolores voluptas cupiditate odio voluptatem.\",\n \"meta_title\": \"A Assumenda Eaque Aperiam Omnis Laravel E-Commerce API\",\n \"meta_description\": \"A Assumenda Eaque Aperiam Omnis Laravel E-Commerce API\",\n \"meta_keywords\": \"A Assumenda Eaque Aperiam Omnis Laravel E-Commerce API\",\n \"category\": {\n \"id\": 60,\n \"name\": \"Error Consectetur Minus\",\n \"slug\": \"error-consectetur-minus\"\n },\n \"brand\": {\n \"id\": 59,\n \"name\": \"Mollitia Nam Quas\",\n \"slug\": \"mollitia-nam-quas\"\n }\n },\n {\n \"id\": 10,\n \"category_id\": 61,\n \"brand_id\": 60,\n \"name\": \"Ratione Consequatur At Et Est\",\n \"slug\": \"ratione-consequatur-at-et-est\",\n \"rate\": 862.41,\n \"quantity\": 4,\n \"description\": \"Et laborum repellat ipsam voluptatibus repellendus. Libero deleniti ut impedit ut iusto assumenda aut. Corporis et quia quis officiis. Illo eveniet velit necessitatibus fuga modi velit quo et. Dolores doloremque aut deserunt maiores.\",\n \"meta_title\": \"Ratione Consequatur At Et Est Laravel E-Commerce API\",\n \"meta_description\": \"Ratione Consequatur At Et Est Laravel E-Commerce API\",\n \"meta_keywords\": \"Ratione Consequatur At Et Est Laravel E-Commerce API\",\n \"category\": {\n \"id\": 61,\n \"name\": \"Fugit Facere Dolore\",\n \"slug\": \"fugit-facere-dolore\"\n },\n \"brand\": {\n \"id\": 60,\n \"name\": \"Qui Vel Ipsam\",\n \"slug\": \"qui-vel-ipsam\"\n }\n },\n {\n \"id\": 11,\n \"category_id\": 62,\n \"brand_id\": 61,\n \"name\": \"Qui Doloremque Nulla Voluptatem Sequi\",\n \"slug\": \"qui-doloremque-nulla-voluptatem-sequi\",\n \"rate\": 177.09,\n \"quantity\": 7,\n \"description\": \"Amet consequatur vel dolor quas quibusdam. Officiis repudiandae reprehenderit et voluptatem perspiciatis impedit. Quasi omnis ipsam eos. Eum sit earum incidunt. Est quod nisi quidem magnam aut quia.\",\n \"meta_title\": \"Qui Doloremque Nulla Voluptatem Sequi Laravel E-Commerce API\",\n \"meta_description\": \"Qui Doloremque Nulla Voluptatem Sequi Laravel E-Commerce API\",\n \"meta_keywords\": \"Qui Doloremque Nulla Voluptatem Sequi Laravel E-Commerce API\",\n \"category\": {\n \"id\": 62,\n \"name\": \"Sint Qui Est\",\n \"slug\": \"sint-qui-est\"\n },\n \"brand\": {\n \"id\": 61,\n \"name\": \"Ut Ut Tempore\",\n \"slug\": \"ut-ut-tempore\"\n }\n },\n {\n \"id\": 12,\n \"category_id\": 63,\n \"brand_id\": 62,\n \"name\": \"Earum Impedit Illo Illum Beatae\",\n \"slug\": \"earum-impedit-illo-illum-beatae\",\n \"rate\": 742.87,\n \"quantity\": 7,\n \"description\": \"Tempore quos consequatur nam unde sed ex quisquam. Asperiores cumque quo explicabo id mollitia ut accusamus. Aut ut aspernatur veritatis excepturi ex veniam. Fugit dolore quod est necessitatibus in tempora quo. Autem et tempora culpa sunt.\",\n \"meta_title\": \"Earum Impedit Illo Illum Beatae Laravel E-Commerce API\",\n \"meta_description\": \"Earum Impedit Illo Illum Beatae Laravel E-Commerce API\",\n \"meta_keywords\": \"Earum Impedit Illo Illum Beatae Laravel E-Commerce API\",\n \"category\": {\n \"id\": 63,\n \"name\": \"Error Pariatur Ut\",\n \"slug\": \"error-pariatur-ut\"\n },\n \"brand\": {\n \"id\": 62,\n \"name\": \"Qui Fuga Iste\",\n \"slug\": \"qui-fuga-iste\"\n }\n },\n {\n \"id\": 13,\n \"category_id\": 64,\n \"brand_id\": 63,\n \"name\": \"Eum Culpa Ab Sunt Quo\",\n \"slug\": \"eum-culpa-ab-sunt-quo\",\n \"rate\": 964.1,\n \"quantity\": 6,\n \"description\": \"Sit reprehenderit quasi aperiam aliquid est. Provident aut consequatur dolore quia eum et aut. Sit incidunt reprehenderit dolorum quisquam voluptatem. Officiis soluta aliquam quos deleniti. Qui labore doloribus dolores culpa.\",\n \"meta_title\": \"Eum Culpa Ab Sunt Quo Laravel E-Commerce API\",\n \"meta_description\": \"Eum Culpa Ab Sunt Quo Laravel E-Commerce API\",\n \"meta_keywords\": \"Eum Culpa Ab Sunt Quo Laravel E-Commerce API\",\n \"category\": {\n \"id\": 64,\n \"name\": \"Velit Eos Esse\",\n \"slug\": \"velit-eos-esse\"\n },\n \"brand\": {\n \"id\": 63,\n \"name\": \"Dolorem Cum Culpa\",\n \"slug\": \"dolorem-cum-culpa\"\n }\n },\n {\n \"id\": 14,\n \"category_id\": 65,\n \"brand_id\": 64,\n \"name\": \"Non Sed Consectetur Molestiae Qui\",\n \"slug\": \"non-sed-consectetur-molestiae-qui\",\n \"rate\": 756.76,\n \"quantity\": 5,\n \"description\": \"Impedit laboriosam dignissimos tenetur qui. Ut at sunt cum consequatur. Nisi quo quibusdam quo quo. Ut harum qui accusamus vel unde quia. Laboriosam cum repellat est magnam numquam voluptatem consequatur labore.\",\n \"meta_title\": \"Non Sed Consectetur Molestiae Qui Laravel E-Commerce API\",\n \"meta_description\": \"Non Sed Consectetur Molestiae Qui Laravel E-Commerce API\",\n \"meta_keywords\": \"Non Sed Consectetur Molestiae Qui Laravel E-Commerce API\",\n \"category\": {\n \"id\": 65,\n \"name\": \"Est Voluptatibus Nobis\",\n \"slug\": \"est-voluptatibus-nobis\"\n },\n \"brand\": {\n \"id\": 64,\n \"name\": \"Et Voluptatibus Molestiae\",\n \"slug\": \"et-voluptatibus-molestiae\"\n }\n },\n {\n \"id\": 15,\n \"category_id\": 66,\n \"brand_id\": 65,\n \"name\": \"Tempora Voluptas Asperiores Ut Quis\",\n \"slug\": \"tempora-voluptas-asperiores-ut-quis\",\n \"rate\": 212.04,\n \"quantity\": 1,\n \"description\": \"Debitis harum ullam suscipit ullam ut eum sint neque. Omnis aliquid natus voluptatem explicabo. Nam velit id eos fugiat. Fuga debitis voluptate necessitatibus vel repudiandae. Asperiores debitis quia dolor molestiae.\",\n \"meta_title\": \"Tempora Voluptas Asperiores Ut Quis Laravel E-Commerce API\",\n \"meta_description\": \"Tempora Voluptas Asperiores Ut Quis Laravel E-Commerce API\",\n \"meta_keywords\": \"Tempora Voluptas Asperiores Ut Quis Laravel E-Commerce API\",\n \"category\": {\n \"id\": 66,\n \"name\": \"Officia Eligendi Officia\",\n \"slug\": \"officia-eligendi-officia\"\n },\n \"brand\": {\n \"id\": 65,\n \"name\": \"Enim Ad Et\",\n \"slug\": \"enim-ad-et\"\n }\n },\n {\n \"id\": 16,\n \"category_id\": 67,\n \"brand_id\": 66,\n \"name\": \"Ea Repellendus Autem Culpa Quasi\",\n \"slug\": \"ea-repellendus-autem-culpa-quasi\",\n \"rate\": 417.03,\n \"quantity\": 1,\n \"description\": \"Illo ea voluptate est. Soluta et mollitia repellendus ut. Sapiente tempore quo quia tempora. Aperiam consectetur aut aut sint veritatis atque. Aliquid et qui quas repellendus.\",\n \"meta_title\": \"Ea Repellendus Autem Culpa Quasi Laravel E-Commerce API\",\n \"meta_description\": \"Ea Repellendus Autem Culpa Quasi Laravel E-Commerce API\",\n \"meta_keywords\": \"Ea Repellendus Autem Culpa Quasi Laravel E-Commerce API\",\n \"category\": {\n \"id\": 67,\n \"name\": \"Exercitationem Voluptatem Rerum\",\n \"slug\": \"exercitationem-voluptatem-rerum\"\n },\n \"brand\": {\n \"id\": 66,\n \"name\": \"Iste Molestias Earum\",\n \"slug\": \"iste-molestias-earum\"\n }\n }\n ],\n \"first_page_url\": \"http:\/\/localhost:8000?page=1\",\n \"from\": 1,\n \"last_page\": 4,\n \"last_page_url\": \"http:\/\/localhost:8000?page=4\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=4\",\n \"label\": \"4\",\n \"active\": false\n },\n {\n \"url\": \"http:\/\/localhost:8000?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": \"http:\/\/localhost:8000?page=2\",\n \"path\": \"http:\/\/localhost:8000\",\n \"per_page\": 16,\n \"prev_page_url\": null,\n \"to\": 16,\n \"total\": 50\n }\n}\n", "name": "" } ] }, { "name": "Add new Product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/products", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/products" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Gucci", "type": "text", "description": "Required. The name of the product. Must not be greater than 100 characters." }, { "key": "description", "value": "Gucci clothes made of the best quality materials sold all over the world.", "type": "text", "description": "Required. The description of the product." }, { "key": "category_id", "value": "1", "type": "text", "description": "Required. The id of category that this product is being added in. Should be positive integer, and should exist in categories table. The id<\/code> of an existing record in the categories table." }, { "key": "brand_id", "value": "1", "type": "text", "description": "Required. The id of brand that this product is being added in. Should be positive integer, and should exist in brands table. The id<\/code> of an existing record in the brands table." }, { "key": "rate", "value": "119", "type": "text", "description": "Required. The amount of the product that it will be sold to the customers. Should be positive integer, greater than 0. Must be at least 0.0." }, { "key": "quantity", "value": "10", "type": "text", "description": "Required. The quantity of the product. Should be positive integer, greater than 0. Must be at least 0." }, { "key": "meta_title", "value": "Gucci clothes made of the best quality materials.", "type": "text", "description": "Required. The title of the page. Refers to the text that is displayed on search engine result pages and browser tabs to indicate the topic of a webpage. Must not be greater than 80 characters." }, { "key": "meta_description", "value": "Gucci clothes made of the best quality materials sold all over the world.", "type": "text", "description": "Required. This informs and interests users with a short, relevant summary of what a particular page is about. Must not be greater than 180 characters." }, { "key": "meta_keywords", "value": "T-shirt, Gucci clothes, best quality tshirt for women", "type": "text", "description": "A comma separated words or phrases related to the product. Must not be greater than 255 characters." }, { "key": "image", "src": [], "type": "file" } ] }, "description": "Create a new Product and store it's details." }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"success\",\n \"message\": \"Product added successfully.\",\n \"data\": {\n \"name\": \"Product 1\",\n \"rate\": 10,\n \"quantity\": 10,\n \"category_id\": 1,\n \"brand_id\": 1,\n \"description\": \"Qui aut quia soluta ut et repellendus aut.\",\n \"meta_title\": \"jqfpfenwpledzbrovcmnsylb\",\n \"meta_description\": \"sdovbzcbfmbwnxpgvrqzdi\",\n \"meta_keywords\": \"dvrisbpzc\",\n \"slug\": \"product-1\",\n \"updated_at\": \"2023-05-18T00:00:00.000000Z\",\n \"created_at\": \"2023-05-18T00:00:00.000000Z\",\n \"id\": 1\n }\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The name field is required. (and 3 more errors)\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ],\n \"category_id\": [\n \"The category field is required.\"\n ],\n \"description\": [\n \"The description field is required.\"\n ],\n \"meta_title\": [\n \"The meta title field is required.\"\n ],\n \"meta_description\": [\n \"The meta description field is required.\"\n ]\n }\n}\n", "name": "" } ] }, { "name": "Get single Product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/products\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/products\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the Product." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch the details about the given Product id." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"\",\n \"data\": {\n \"name\": \"Product 1\",\n \"rate\": 10,\n \"quantity\": 10,\n \"category_id\": 1,\n \"brand_id\": 1,\n \"description\": \"Qui aut quia soluta ut et repellendus aut.\",\n \"meta_title\": \"jqfpfenwpledzbrovcmnsylb\",\n \"meta_description\": \"sdovbzcbfmbwnxpgvrqzdi\",\n \"meta_keywords\": \"dvrisbpzc\",\n \"slug\": \"product-1\",\n \"updated_at\": \"2023-05-18T00:00:00.000000Z\",\n \"created_at\": \"2023-05-18T00:00:00.000000Z\",\n \"id\": 1\n }\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Product not found.\",\n \"data\": []\n}\n", "name": "" } ] }, { "name": "Update Product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/products\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/products\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the Product." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Gucci", "type": "text", "description": "Required. The name of the product. Must not be greater than 100 characters." }, { "key": "description", "value": "Gucci clothes made of the best quality materials sold all over the world.", "type": "text", "description": "Required. The description of the product." }, { "key": "category_id", "value": "1", "type": "text", "description": "Required. The id of category that this product is being added in. Should be positive integer, and should exist in categories table. The id<\/code> of an existing record in the categories table." }, { "key": "brand_id", "value": "1", "type": "text", "description": "Required. The id of brand that this product is being added in. Should be positive integer, and should exist in brands table. The id<\/code> of an existing record in the brands table." }, { "key": "rate", "value": "119", "type": "text", "description": "Required. The amount of the product that it will be sold to the customers. Should be positive integer, greater than 0. Must be at least 0.0." }, { "key": "quantity", "value": "10", "type": "text", "description": "Required. The quantity of the product. Should be positive integer, greater than 0. Must be at least 0." }, { "key": "meta_title", "value": "Gucci clothes made of the best quality materials.", "type": "text", "description": "Required. The title of the page. Refers to the text that is displayed on search engine result pages and browser tabs to indicate the topic of a webpage. Must not be greater than 80 characters." }, { "key": "meta_description", "value": "Gucci clothes made of the best quality materials sold all over the world.", "type": "text", "description": "Required. This informs and interests users with a short, relevant summary of what a particular page is about. Must not be greater than 180 characters." }, { "key": "meta_keywords", "value": "T-shirt, Gucci clothes, best quality tshirt for women", "type": "text", "description": "A comma separated words or phrases related to the product. Must not be greater than 255 characters." }, { "key": "image", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "Update the Product details of the given id." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Product updated successfully.\",\n \"data\": {\n \"name\": \"Product 1\",\n \"description\": \"Qui aut quia soluta ut et repellendus aut.\",\n \"meta_title\": \"jqfpfenwpledzbrovcmnsylb\",\n \"meta_description\": \"sdovbzcbfmbwnxpgvrqzdi\",\n \"meta_keywords\": \"dvrisbpzc\",\n \"slug\": \"product-1\",\n \"updated_at\": \"2023-05-18T00:00:00.000000Z\",\n \"created_at\": \"2023-05-18T00:00:00.000000Z\",\n \"id\": 1\n }\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Product not found.\",\n \"data\": []\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The name field is required. (and 3 more errors)\",\n \"errors\": {\n \"name\": [\n \"The name field is required.\"\n ],\n \"category_id\": [\n \"The category field is required.\"\n ],\n \"description\": [\n \"The description field is required.\"\n ],\n \"meta_title\": [\n \"The meta title field is required.\"\n ],\n \"meta_description\": [\n \"The meta description field is required.\"\n ]\n }\n}\n", "name": "" } ] }, { "name": "Delete a Product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/admin\/products\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/admin\/products\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the Product." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete the Product details of the given id.\nThis will soft delete the Product.\nMeaning the record will be present in the database, however,\nit won't be available to access." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Product deleted successfully.\",\n \"data\": []\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Product not found.\",\n \"data\": []\n}\n", "name": "" } ] } ] } ] }, { "name": "User Endpoints", "description": "", "item": [ { "name": "Billing Address", "description": "The billing addresses of the user.", "item": [ { "name": "List all billing addresses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/billing-address", "query": [], "raw": "{{baseUrl}}\/api\/user\/billing-address" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Displays all the billing addresses that are added by the user." }, "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": "Add new billing address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/billing-address\/store", "query": [], "raw": "{{baseUrl}}\/api\/user\/billing-address\/store" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"johndoe@example.com\",\"contact\":\"9876543210\",\"address_line_1\":\"24, Building Name\",\"address_line_2\":\"Some street name\",\"area\":\"St. Peters Stn\",\"landmark\":\"Chill StarBucks Cafe\",\"city\":\"Mumbai\",\"postal_code\":\"123456\",\"state_province\":\"Mahrashtra\",\"country\":\"India\"}" }, "description": "Store the new billing address with the provided details." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Billing address created successfully.\",\n \"data\": {\n \"id\": 1,\n \"user_id\": 2,\n \"type\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"contact\": \"9876543210\",\n \"address_line_1\": \"24, Building Name\",\n \"address_line_2\": \"Some street name\",\n \"area\": \"St. Peters Stn\",\n \"landmark\": \"Chill StarBucks Cafe\",\n \"city\": \"Mumbai\",\n \"postal_code\": \"400001\",\n \"state_province\": \"Maharashtra\",\n \"country\": \"India\",\n \"created_at\": \"2023-06-20T16:11:57.000000Z\",\n \"updated_at\": \"2023-06-20T16:11:57.000000Z\"\n }\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The first name field is required. (and 9 more errors)\",\n \"errors\": {\n \"first_name\": [\"The first name field is required.\"],\n \"last_name\": [\"The last name field is required.\"],\n \"email\": [\"The email field is required.\"],\n \"contact\": [\"The contact field is required.\"],\n \"address_line_1\": [\"The address line 1 field is required.\"],\n \"area\": [\"The area field is required.\"],\n \"city\": [\"The city field is required.\"],\n \"postal_code\": [\"The postal code field is required.\"],\n \"state_province\": [\"The state province field is required.\"],\n \"country\": [\"The country field is required.\"]\n }\n}\n", "name": "" } ] }, { "name": "Update billing address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/billing-address\/:id", "query": [], "raw": "{{baseUrl}}\/api\/user\/billing-address\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the billing address." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"johndoe@example.com\",\"contact\":\"9876543210\",\"address_line_1\":\"24, Building Name\",\"address_line_2\":\"Some street name\",\"area\":\"St. Peters Stn\",\"landmark\":\"Chill StarBucks Cafe\",\"city\":\"Mumbai\",\"postal_code\":\"123456\",\"state_province\":\"Mahrashtra\",\"country\":\"India\"}" }, "description": "Updates the existing billing address of the provided id with the provided details." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Billing address updated successfully.\",\n \"data\": {\n \"id\": 1,\n \"user_id\": 2,\n \"type\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"contact\": \"9876543210\",\n \"address_line_1\": \"24, Building Name\",\n \"address_line_2\": \"Some street name\",\n \"area\": \"St. Peters Stn\",\n \"landmark\": \"Chill StarBucks Cafe\",\n \"city\": \"Mumbai\",\n \"postal_code\": \"400001\",\n \"state_province\": \"Maharashtra\",\n \"country\": \"India\",\n \"created_at\": \"2023-06-20T16:11:57.000000Z\",\n \"updated_at\": \"2023-06-20T16:11:57.000000Z\"\n }\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The first name field is required. (and 9 more errors)\",\n \"errors\": {\n \"first_name\": [\"The first name field is required.\"],\n \"last_name\": [\"The last name field is required.\"],\n \"email\": [\"The email field is required.\"],\n \"contact\": [\"The contact field is required.\"],\n \"address_line_1\": [\"The address line 1 field is required.\"],\n \"area\": [\"The area field is required.\"],\n \"city\": [\"The city field is required.\"],\n \"postal_code\": [\"The postal code field is required.\"],\n \"state_province\": [\"The state province field is required.\"],\n \"country\": [\"The country field is required.\"]\n }\n}\n", "name": "" } ] }, { "name": "Delete billing address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/billing-address\/:id", "query": [], "raw": "{{baseUrl}}\/api\/user\/billing-address\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the billing address." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the existing billing address of the provided id." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Billing address deleted successfully.\",\n \"data\": []\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Billing address not found.\",\n \"data\": []\n}\n", "name": "" } ] } ] }, { "name": "Shipping Address", "description": "The shipping addresses of the user.", "item": [ { "name": "List all shipping addresses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/shipping-address", "query": [], "raw": "{{baseUrl}}\/api\/user\/shipping-address" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Displays all the shipping addresses that are added by the user." }, "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": "Add new shipping address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/shipping-address\/store", "query": [], "raw": "{{baseUrl}}\/api\/user\/shipping-address\/store" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"johndoe@example.com\",\"contact\":\"9876543210\",\"address_line_1\":\"24, Building Name\",\"address_line_2\":\"Some street name\",\"area\":\"St. Peters Stn\",\"landmark\":\"Chill StarBucks Cafe\",\"city\":\"Mumbai\",\"postal_code\":\"123456\",\"state_province\":\"Mahrashtra\",\"country\":\"India\"}" }, "description": "Store the new shipping address with the provided details." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Shipping address created successfully.\",\n \"data\": {\n \"id\": 1,\n \"user_id\": 2,\n \"type\": 2,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"contact\": \"9876543210\",\n \"address_line_1\": \"24, Building Name\",\n \"address_line_2\": \"Some street name\",\n \"area\": \"St. Peters Stn\",\n \"landmark\": \"Chill StarBucks Cafe\",\n \"city\": \"Mumbai\",\n \"postal_code\": \"400001\",\n \"state_province\": \"Maharashtra\",\n \"country\": \"India\",\n \"created_at\": \"2023-06-20T16:11:57.000000Z\",\n \"updated_at\": \"2023-06-20T16:11:57.000000Z\"\n }\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The first name field is required. (and 9 more errors)\",\n \"errors\": {\n \"first_name\": [\"The first name field is required.\"],\n \"last_name\": [\"The last name field is required.\"],\n \"email\": [\"The email field is required.\"],\n \"contact\": [\"The contact field is required.\"],\n \"address_line_1\": [\"The address line 1 field is required.\"],\n \"area\": [\"The area field is required.\"],\n \"city\": [\"The city field is required.\"],\n \"postal_code\": [\"The postal code field is required.\"],\n \"state_province\": [\"The state province field is required.\"],\n \"country\": [\"The country field is required.\"]\n }\n}\n", "name": "" } ] }, { "name": "Update shipping address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/shipping-address\/:id", "query": [], "raw": "{{baseUrl}}\/api\/user\/shipping-address\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the shipping address." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"johndoe@example.com\",\"contact\":\"9876543210\",\"address_line_1\":\"24, Building Name\",\"address_line_2\":\"Some street name\",\"area\":\"St. Peters Stn\",\"landmark\":\"Chill StarBucks Cafe\",\"city\":\"Mumbai\",\"postal_code\":\"123456\",\"state_province\":\"Mahrashtra\",\"country\":\"India\"}" }, "description": "Updates the existing shipping address of the provided id with the provided details." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Shipping address updated successfully.\",\n \"data\": {\n \"id\": 1,\n \"user_id\": 2,\n \"type\": 2,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"contact\": \"9876543210\",\n \"address_line_1\": \"24, Building Name\",\n \"address_line_2\": \"Some street name\",\n \"area\": \"St. Peters Stn\",\n \"landmark\": \"Chill StarBucks Cafe\",\n \"city\": \"Mumbai\",\n \"postal_code\": \"400001\",\n \"state_province\": \"Maharashtra\",\n \"country\": \"India\",\n \"created_at\": \"2023-06-20T16:11:57.000000Z\",\n \"updated_at\": \"2023-06-20T16:11:57.000000Z\"\n }\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The first name field is required. (and 9 more errors)\",\n \"errors\": {\n \"first_name\": [\"The first name field is required.\"],\n \"last_name\": [\"The last name field is required.\"],\n \"email\": [\"The email field is required.\"],\n \"contact\": [\"The contact field is required.\"],\n \"address_line_1\": [\"The address line 1 field is required.\"],\n \"area\": [\"The area field is required.\"],\n \"city\": [\"The city field is required.\"],\n \"postal_code\": [\"The postal code field is required.\"],\n \"state_province\": [\"The state province field is required.\"],\n \"country\": [\"The country field is required.\"]\n }\n}\n", "name": "" } ] }, { "name": "Delete shipping address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/shipping-address\/:id", "query": [], "raw": "{{baseUrl}}\/api\/user\/shipping-address\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The id of the shipping address." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the existing shipping address of the provided id." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Shipping address deleted successfully.\",\n \"data\": []\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Shipping address not found.\",\n \"data\": []\n}\n", "name": "" } ] } ] }, { "name": "Wishlist", "description": "The wishlist of the user. They can add or remove the product to and from wishlist.", "item": [ { "name": "List all products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/wishlist", "query": [], "raw": "{{baseUrl}}\/api\/user\/wishlist" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Displays all the products that are added by the user in their wishlist." }, "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": "Add product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/wishlist", "query": [], "raw": "{{baseUrl}}\/api\/user\/wishlist" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":1}" }, "description": "Store an existing product in their wishlist." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Product has been successfully added.\",\n \"data\": {\n \"id\": 1,\n \"user_id\": 2,\n \"product_id\": 1,\n \"created_at\": \"2023-06-20T16:11:57.000000Z\",\n \"updated_at\": \"2023-06-20T16:11:57.000000Z\"\n }\n}\n", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The product is required.\",\n \"errors\": {\n \"product_id\": [\"The product is required.\"]\n }\n}\n", "name": "" } ] }, { "name": "Remove a product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/wishlist\/:productId", "query": [], "raw": "{{baseUrl}}\/api\/user\/wishlist\/:productId", "variable": [ { "id": "productId", "key": "productId", "value": "1", "description": "The id of the product." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the product of the provided id from the user's wishlist." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Product has been successfully removed.\",\n \"data\": []\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"failed\",\n \"message\": \"Product not found with the provided id.\",\n \"data\": []\n}\n", "name": "" } ] } ] }, { "name": "Cart", "description": "The endpoints related to Cart", "item": [ { "name": "All products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/cart", "query": [], "raw": "{{baseUrl}}\/api\/user\/cart" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists all the products that are added in the cart.\nAlso, it will calculate the total amount of the cart." }, "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": "Add a product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/cart\/add", "query": [], "raw": "{{baseUrl}}\/api\/user\/cart\/add" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Adds the product of the given id in to the cart.\nThe product is then stored in the database.\nIf the product is not found, 404 error will be returned." }, "response": [ { "header": [], "code": 201, "body": "{\n \"status\": \"success\",\n \"message\": \"Product successfully added.\",\n \"data\": {\n \"id\": 1,\n \"user_id\": 2,\n \"product_id\": 6,\n \"product_name\": \"Harum Recusandae Qui Voluptas Incidunt\",\n \"product_slug\": \"harum-recusandae-qui-voluptas-incidunt\",\n \"rate\": 100,\n \"quantity\": 3,\n \"amount\": 300,\n \"created_at\": \"2023-11-29T12:47:57.000000Z\",\n \"updated_at\": \"2023-11-29T12:47:57.000000Z\"\n }\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"success\",\n \"message\": \"Product with the provided id not found.\",\n \"data\": null\n}\n", "name": "" } ] }, { "name": "Update product quantity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/cart\/update\/:cartProductId", "query": [], "raw": "{{baseUrl}}\/api\/user\/cart\/update\/:cartProductId", "variable": [ { "id": "cartProductId", "key": "cartProductId", "value": "1", "description": "The id of the cartProduct that you want to update the quantity of." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update the product's quantity of the given cartProduct id.\nIf the record is not found, 404 error will be returned." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Product successfully updated.\",\n \"data\": {\n \"id\": 1,\n \"user_id\": 2,\n \"product_id\": 6,\n \"product_name\": \"Harum Recusandae Qui Voluptas Incidunt\",\n \"product_slug\": \"harum-recusandae-qui-voluptas-incidunt\",\n \"rate\": 100,\n \"quantity\": 2,\n \"amount\": 200,\n \"created_at\": \"2023-11-29T12:47:57.000000Z\",\n \"updated_at\": \"2023-11-29T12:50:13.000000Z\"\n }\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"success\",\n \"message\": \"Product with the provided id not found.\",\n \"data\": null\n}\n", "name": "" } ] }, { "name": "Remove product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/cart\/delete\/:cartProductId", "query": [], "raw": "{{baseUrl}}\/api\/user\/cart\/delete\/:cartProductId", "variable": [ { "id": "cartProductId", "key": "cartProductId", "value": "1", "description": "The id of the product that you want to update the quantity of." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes the product of the given id from the cart.\nIf the product is not found, 404 error will be returned." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Product successfully removed.\",\n \"data\": null\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\n \"status\": \"success\",\n \"message\": \"Product with the provided id not found.\",\n \"data\": null\n}\n", "name": "" } ] }, { "name": "Empty cart", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/cart\/empty", "query": [], "raw": "{{baseUrl}}\/api\/user\/cart\/empty" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Empties the cart entirely." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Cart emptied successfully.\",\n \"data\": null\n}\n", "name": "" } ] } ] }, { "name": "Checkout", "description": "The checkout order process. The values are stored in the session.", "item": [ { "name": "Both addresses", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/checkout\/addresses", "query": [], "raw": "{{baseUrl}}\/api\/user\/checkout\/addresses" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch all the billing and shipping addresses." }, "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": "Billing Address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/checkout\/billing-address", "query": [], "raw": "{{baseUrl}}\/api\/user\/checkout\/billing-address" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"billing_address_id\":1}" }, "description": "Store the billing address in the session." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Billing address successfully selected.\",\n \"data\": []\n}\n", "name": "" } ] }, { "name": "Shipping Address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/checkout\/shipping-address", "query": [], "raw": "{{baseUrl}}\/api\/user\/checkout\/shipping-address" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"shipping_address_id\":1}" }, "description": "Store the shipping address in the session." }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Shipping address successfully selected.\",\n \"data\": []\n}\n", "name": "" } ] }, { "name": "Place Order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/checkout\/place-order", "query": [], "raw": "{{baseUrl}}\/api\/user\/checkout\/place-order" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Create a new order" }, "response": [ { "header": [], "code": 200, "body": "{\n \"status\": \"success\",\n \"message\": \"Order successfully placed.\",\n \"data\": {\n \"id\": 1,\n \"code\": \"ORD-BWUmJ\",\n \"stripe_customer_id\": null,\n \"user_id\": 2,\n \"user_details\": {\n \"full_name\": \"Letitia Glover\",\n \"email\": \"userone@example.com\"\n },\n \"billing_address\": {\n \"id\": 3,\n \"user_id\": 2,\n \"type\": 1,\n \"first_name\": null,\n \"last_name\": null,\n \"email\": null,\n \"contact\": null,\n \"address_line_1\": null,\n \"address_line_2\": null,\n \"area\": null,\n \"landmark\": null,\n \"city\": null,\n \"postal_code\": null,\n \"state_province\": null,\n \"country\": null,\n \"created_at\": \"2023-11-29T10:36:27.000000Z\",\n \"updated_at\": \"2023-11-29T10:36:27.000000Z\"\n },\n \"shipping_address\": {\n \"id\": 4,\n \"user_id\": 2,\n \"type\": 2,\n \"first_name\": null,\n \"last_name\": null,\n \"email\": null,\n \"contact\": null,\n \"address_line_1\": null,\n \"address_line_2\": null,\n \"area\": null,\n \"landmark\": null,\n \"city\": null,\n \"postal_code\": null,\n \"state_province\": null,\n \"country\": null,\n \"created_at\": \"2023-11-29T10:36:27.000000Z\",\n \"updated_at\": \"2023-11-29T10:36:27.000000Z\"\n },\n \"total_amount\": 333.75,\n \"updated_at\": \"2023-11-29T10:36:27.000000Z\",\n \"created_at\": \"2023-11-29T10:36:27.000000Z\"\n }\n}\n", "name": "" } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }