{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/demo.larashop.su" } ], "info": { "name": "LaraShop CMS API Documentation", "_postman_id": "9d0a7009-184e-4b07-871b-5ba12e464868", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Address", "description": "", "item": [ { "name": "Get list of address by customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/addresses", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/addresses" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create new address for customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/addresses", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/addresses" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"John Doe\",\"email\":\"john.doe@example.com\",\"phone\":\"0123456789\",\"country\":\"United States or US\",\"state\":\"California\",\"city\":\"Los Angeles\",\"address\":\"123 Main St\",\"is_default\":true,\"zip_code\":\"90001\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"phone\": \"0123456789\",\n \"email\": \"john.doe@example.com\",\n \"country\": \"United States\",\n \"state\": \"California\",\n \"city\": \"Los Angeles\",\n \"address\": \"123 Main St\",\n \"zip_code\": \"90001\",\n \"is_default\": true\n },\n \"message\": null\n}", "name": "" } ] }, { "name": "Update an address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/addresses\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/addresses\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the address." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"John Doe\",\"email\":\"john.doe@example.com\",\"phone\":\"0123456789\",\"country\":\"United States or US\",\"state\":\"California\",\"city\":\"Los Angeles\",\"address\":\"123 Main St\",\"is_default\":true,\"zip_code\":\"90001\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"phone\": \"0123456789\",\n \"email\": \"john.doe@example.com\",\n \"country\": \"United States\",\n \"state\": \"California\",\n \"city\": \"Los Angeles\",\n \"address\": \"123 Main St\",\n \"zip_code\": \"90001\",\n \"is_default\": true\n },\n \"message\": null\n}", "name": "" } ] }, { "name": "Delete an address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/addresses\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/addresses\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the address." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": null,\n \"message\": \"Address deleted successfully\"\n}", "name": "" } ] }, { "name": "Get list of available countries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/countries", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/countries" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": [\n {\n \"name\": \"Vietnam\",\n \"code\": \"VN\"\n }\n ],\n \"message\": null\n}", "name": "" } ] } ] }, { "name": "Ads", "description": "", "item": [ { "name": "Get ads", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ads", "query": [ { "key": "keys[0]", "value": "homepage-banner", "description": "Array of ad keys to filter by.", "disabled": false }, { "key": "keys[1]", "value": "sidebar-banner", "description": "Array of ad keys to filter by.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ads?keys[0]=homepage-banner&keys[1]=sidebar-banner" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"keys\":[\"homepage-banner\",\"sidebar-banner\"]}" }, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] } ] }, { "name": "Authentication", "description": "", "item": [ { "name": "Register", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/register", "query": [], "raw": "{{baseUrl}}\/api\/v1\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Smith\",\"name\":\"architecto\",\"email\":\"gbailey@example.net\",\"password\":\"|]|{+-\",\"phone\":\"architecto\",\"password_confirmation\":\"architecto\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"data\": null,\n\"message\": \"Registered successfully! We emailed you to verify your account!\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"name\": [\n \"The name field is required.\"\n ],\n \"email\": [\n \"The email field is required.\"\n ],\n \"password\": [\n \"The password field is required.\"\n ]\n }\n}", "name": "" } ] }, { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/login", "query": [], "raw": "{{baseUrl}}\/api\/v1\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\",\"password\":\"|]|{+-\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"data\": {\n \"token\": \"1|aF5s7p3xxx1lVL8hkSrPN72m4wPVpTvTs...\"\n},\n\"message\": null\n}", "name": "" } ] }, { "name": "Check email existing or not", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/email\/check", "query": [], "raw": "{{baseUrl}}\/api\/v1\/email\/check" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": {\n \"exists\": true\n },\n \"message\": null\n }", "name": "" } ] }, { "name": "Forgot password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/password\/forgot", "query": [], "raw": "{{baseUrl}}\/api\/v1\/password\/forgot" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\"}" }, "description": "Send a reset link to the given user.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Resend email verification", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/resend-verify-account-email", "query": [], "raw": "{{baseUrl}}\/api\/v1\/resend-verify-account-email" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\"}" }, "description": "Resend the email verification notification.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Resend email verification", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/resend-email-verification", "query": [], "raw": "{{baseUrl}}\/api\/v1\/resend-email-verification" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\"}" }, "description": "Resend the email verification notification.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/logout" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Blog", "description": "", "item": [ { "name": "Search post", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/search", "query": [], "raw": "{{baseUrl}}\/api\/v1\/search" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"q\":\"architecto\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": {\n \"items\": [\n {\n \"id\": 1,\n \"title\": \"Sample Post\",\n \"slug\": \"sample-post\",\n \"excerpt\": \"This is a sample post excerpt\"\n }\n ],\n \"query\": \"sample\",\n \"count\": 1\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"error\": true,\n \"message\": \"No search result\"\n}", "name": "" } ] }, { "name": "List posts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/posts", "query": [ { "key": "per_page", "value": "16", "description": "The number of items to return per page (default: 10).", "disabled": false }, { "key": "page", "value": "16", "description": "The page number to retrieve (default: 1).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/posts?per_page=16&page=16" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"Sample Post\",\n \"slug\": \"sample-post\",\n \"excerpt\": \"This is a sample post excerpt\",\n \"content\": \"Full post content here...\",\n \"published_at\": \"2023-01-01T00:00:00.000000Z\",\n \"author\": {\n \"id\": 1,\n \"name\": \"John Doe\"\n },\n \"categories\": [],\n \"tags\": []\n }\n ],\n \"message\": null\n}", "name": "" } ] }, { "name": "List categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/categories", "query": [ { "key": "per_page", "value": "16", "description": "The number of items to return per page (default: 10).", "disabled": false }, { "key": "page", "value": "16", "description": "The page number to retrieve (default: 1).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/categories?per_page=16&page=16" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Technology\",\n \"slug\": \"technology\",\n \"description\": \"Latest tech news and updates\",\n \"created_at\": \"2023-01-01T00:00:00.000000Z\"\n }\n ],\n \"message\": null\n}", "name": "" } ] }, { "name": "List tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tags", "query": [ { "key": "per_page", "value": "16", "description": "The number of items to return per page (default: 10).", "disabled": false }, { "key": "page", "value": "16", "description": "The page number to retrieve (default: 1).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/tags?per_page=16&page=16" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Laravel\",\n \"slug\": \"laravel\",\n \"description\": \"PHP Framework for web development\",\n \"created_at\": \"2023-01-01T00:00:00.000000Z\"\n }\n ],\n \"message\": null\n}", "name": "" } ] }, { "name": "Filters posts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/posts\/filters", "query": [ { "key": "page", "value": "16", "description": "Current page of the collection. Default: 1", "disabled": false }, { "key": "per_page", "value": "16", "description": "Maximum number of items to be returned in result set.Default: 10", "disabled": false }, { "key": "search", "value": "architecto", "description": "Limit results to those matching a string.", "disabled": false }, { "key": "after", "value": "architecto", "description": "Limit response to posts published after a given ISO8601 compliant date.", "disabled": false }, { "key": "author", "value": "architecto", "description": "Limit result set to posts assigned to specific authors.", "disabled": false }, { "key": "author_exclude", "value": "architecto", "description": "Ensure result set excludes posts assigned to specific authors.", "disabled": false }, { "key": "before", "value": "architecto", "description": "Limit response to posts published before a given ISO8601 compliant date.", "disabled": false }, { "key": "exclude", "value": "architecto", "description": "Ensure result set excludes specific IDs.", "disabled": false }, { "key": "include", "value": "architecto", "description": "Limit result set to specific IDs.", "disabled": false }, { "key": "order", "value": "architecto", "description": "Order sort attribute ascending or descending. Default: desc .One of: asc, desc", "disabled": false }, { "key": "order_by", "value": "architecto", "description": "Sort collection by object attribute. Default: updated_at. One of: author, created_at, updated_at, id, slug, title", "disabled": false }, { "key": "categories", "value": "architecto", "description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.", "disabled": false }, { "key": "categories_exclude", "value": "architecto", "description": "Limit result set to all items except those that have the specified term assigned in the categories taxonomy.", "disabled": false }, { "key": "tags", "value": "architecto", "description": "Limit result set to all items that have the specified term assigned in the tags taxonomy.", "disabled": false }, { "key": "tags_exclude", "value": "architecto", "description": "Limit result set to all items except those that have the specified term assigned in the tags taxonomy.", "disabled": false }, { "key": "featured", "value": "architecto", "description": "Limit result set to items that are sticky.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/posts\/filters?page=16&per_page=16&search=architecto&after=architecto&author=architecto&author_exclude=architecto&before=architecto&exclude=architecto&include=architecto&order=architecto&order_by=architecto&categories=architecto&categories_exclude=architecto&tags=architecto&tags_exclude=architecto&featured=architecto" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Get post by slug", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/posts\/:slug", "query": [ { "key": "slug", "value": "architecto", "description": "Find by slug of post.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/posts\/:slug?slug=architecto", "variable": [ { "id": "slug", "key": "slug", "value": "architecto", "description": "The slug of the post." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Filters categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/categories\/filters", "query": [ { "key": "page", "value": "16", "description": "Current page of the collection (default: 1).", "disabled": false }, { "key": "per_page", "value": "16", "description": "Maximum number of items to be returned (default: 10).", "disabled": false }, { "key": "search", "value": "architecto", "description": "Limit results to those matching a string.", "disabled": false }, { "key": "order", "value": "architecto", "description": "Order sort attribute ascending or descending (default: desc). One of: asc, desc.", "disabled": false }, { "key": "order_by", "value": "architecto", "description": "Sort collection by object attribute (default: created_at). One of: created_at, updated_at, id, name.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/categories\/filters?page=16&per_page=16&search=architecto&order=architecto&order_by=architecto" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Technology\",\n \"slug\": \"technology\",\n \"description\": \"Latest tech news and updates\"\n }\n ],\n \"message\": null\n}", "name": "" } ] }, { "name": "Get category by slug", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/categories\/:slug", "query": [ { "key": "slug", "value": "architecto", "description": "Find by slug of category.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/categories\/:slug?slug=architecto", "variable": [ { "id": "slug", "key": "slug", "value": "architecto", "description": "The slug of the category." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] } ] }, { "name": "Brands", "description": "", "item": [ { "name": "Get list of brands", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/brands", "query": [ { "key": "brands[]", "value": "", "description": "List of brand IDs if you need filter by brands.", "disabled": true }, { "key": "page", "value": "", "description": "Page number. Default: 1.", "disabled": true }, { "key": "per_page", "value": "", "description": "Number of items per page. Default: 16.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/brands?brands[]=&page=&per_page=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"is_featured\":true}" }, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Get brand details by slug", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/brands\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/brands\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "architecto", "description": "The slug of the brand." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Get products by brand", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/brands\/:id\/products", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/brands\/:id\/products", "variable": [ { "id": "id", "key": "id", "value": "6", "description": "The ID of the brand." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] } ] }, { "name": "Cart", "description": "", "item": [ { "name": "Add product to cart", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/cart", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/cart" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":1,\"qty\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Add product to cart", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/cart\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/cart\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the cart." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":1,\"qty\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Update quantity of a product in cart", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/cart\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/cart\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the cart." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":1,\"qty\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Remove a cart item by its ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/cart\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/cart\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the cart." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get a cart item by id.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/cart\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/cart\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the cart." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"customer_id\":1,\"id\":\"e70c6c88dae8344b03e39bb147eba66a\"}" }, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Refresh cart items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/cart\/refresh", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/cart\/refresh" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"products\":[\"architecto\"]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Calculate tax for products in cart", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/checkout\/taxes\/calculate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/checkout\/taxes\/calculate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"products\":[\"architecto\"],\"country\":\"US\",\"state\":\"CA\",\"city\":\"Los Angeles\",\"zip_code\":\"90001\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"items\": [\n {\n \"product_id\": 1,\n \"price\": 100,\n \"price_formatted\": \"$100.00\",\n \"quantity\": 2,\n \"tax_rate\": 10,\n \"tax_amount\": 20,\n \"tax_amount_formatted\": \"$20.00\",\n \"subtotal\": 200,\n \"subtotal_formatted\": \"$200.00\",\n \"total\": 220,\n \"total_formatted\": \"$220.00\"\n }\n ],\n \"totals\": {\n \"sub_total\": 200,\n \"sub_total_formatted\": \"$200.00\",\n \"tax_amount\": 20,\n \"tax_amount_formatted\": \"$20.00\",\n \"total\": 220,\n \"total_formatted\": \"$220.00\"\n }\n}", "name": "" } ] } ] }, { "name": "Checkout", "description": "", "item": [ { "name": "Process Checkout\n\nProcess the checkout for a specific cart ID. This endpoint restores the cart, generates an order token,\nand redirects the user to the checkout page.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/checkout\/cart\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/checkout\/cart\/:id", "variable": [ { "id": "id", "key": "id", "value": "12345", "description": "The ID of the cart to process." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 302, "body": "{}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "set-cookie", "value": "botble_session=eyJpdiI6IlZjMlkxMy81NVphR3hPU25jMWdnTHc9PSIsInZhbHVlIjoiNjFPQmxXdVdZL25vNkVjSExFb0VSMUxaclF0S1pEV1I5L24xYjlIbmtVWU9OekdCM0FvQUxpYms1WFVqOXdmQXduVHVpbTZaRUFreHExN2hXNlVPcmxMcVFodkhFempadGdFb0dUNFp4bnF2ZFk0RGRjTHgxUzcwZkEyV1RQM3UiLCJtYWMiOiI3MGY1MDZiM2YwNmQ5NmVhM2RiZTAxN2QzZTc1NmY0ODgxZTc4OWZjMGU3M2EyZjA0MmViMGUxNDZiYWQ2NWQ5IiwidGFnIjoiIn0%3D; expires=Wed, 25 Feb 2026 16:11:49 GMT; Max-Age=7200; path=\/; httponly; samesite=lax" } ], "code": 401, "body": "{\"message\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Cart not found.\"\n}", "name": "" } ] } ] }, { "name": "Compare", "description": "", "item": [ { "name": "Add product to compare", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/compare", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/compare" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Add product to compare", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/compare\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/compare\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the compare." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Remove a product from compare list", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/compare\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/compare\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the compare." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get compare items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/compare\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/compare\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the compare." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"e70c6c88dae8344b03e39bb147eba66a\"}" }, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] } ] }, { "name": "Coupons", "description": "", "item": [ { "name": "Get all available coupons", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/coupons", "query": [ { "key": "coupon_ids", "value": "1%2C2%2C3", "description": "Optional comma-separated list of coupon IDs to filter by.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/coupons?coupon_ids=1%2C2%2C3" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Apply coupon code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/coupon\/apply", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/coupon\/apply" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"coupon_code\":\"DISCOUNT20\",\"cart_id\":\"e70c6c88dae8344b03e39bb147eba66a\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Remove coupon code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/coupon\/remove", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/coupon\/remove" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"cart_id\":\"e70c6c88dae8344b03e39bb147eba66a\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Currencies", "description": "", "item": [ { "name": "Get list of available currencies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/currencies", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/currencies" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"USD\",\n \"symbol\": \"$\",\n \"is_prefix_symbol\": true,\n \"decimals\": 2,\n \"order\": 0,\n \"is_default\": true,\n \"exchange_rate\": 1\n },\n {\n \"id\": 2,\n \"title\": \"EUR\",\n \"symbol\": \"\u20ac\",\n \"is_prefix_symbol\": false,\n \"decimals\": 2,\n \"order\": 1,\n \"is_default\": false,\n \"exchange_rate\": 0.91\n }\n ],\n \"message\": null\n}", "name": "" } ] }, { "name": "Get current currency", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/currencies\/current", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/currencies\/current" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": {\n \"id\": 1,\n \"title\": \"USD\",\n \"symbol\": \"$\",\n \"is_prefix_symbol\": true,\n \"decimals\": 2,\n \"order\": 0,\n \"is_default\": true,\n \"exchange_rate\": 1\n },\n \"message\": null\n}", "name": "" } ] } ] }, { "name": "Device Tokens", "description": "", "item": [ { "name": "Register or update device token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/device-tokens", "query": [], "raw": "{{baseUrl}}\/api\/v1\/device-tokens" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"architecto\",\"platform\":\"architecto\",\"app_version\":\"architecto\",\"device_id\":\"architecto\",\"user_type\":\"architecto\",\"user_id\":16}" }, "description": "Register a new device token or update an existing one for push notifications.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get user's device tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/device-tokens", "query": [], "raw": "{{baseUrl}}\/api\/v1\/device-tokens" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve all device tokens for the authenticated user.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update device token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/device-tokens\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/device-tokens\/:id", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the device token." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"platform\":\"architecto\",\"app_version\":\"architecto\",\"device_id\":\"architecto\"}" }, "description": "Update an existing device token.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete device token by token value", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/device-tokens\/by-token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/device-tokens\/by-token" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"architecto\"}" }, "description": "Delete a device token using the token value.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete device token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/device-tokens\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/device-tokens\/:id", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the device token." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a device token to stop receiving push notifications.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Deactivate device token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/device-tokens\/:id\/deactivate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/device-tokens\/:id\/deactivate", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the device token." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deactivate a device token without deleting it.", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Downloads", "description": "", "item": [ { "name": "Get list of digital products available for download", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/downloads", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/downloads" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Download a digital product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/downloads\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/downloads\/:id", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the download." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "Download a file using a token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/download\/:token\/:order_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/download\/:token\/:order_id", "variable": [ { "id": "token", "key": "token", "value": "architecto", "description": "" }, { "id": "order_id", "key": "order_id", "value": "architecto", "description": "The ID of the order." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Download a proof file using a token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/orders\/download-proof\/:token\/:order_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/orders\/download-proof\/:token\/:order_id", "variable": [ { "id": "token", "key": "token", "value": "architecto", "description": "" }, { "id": "order_id", "key": "order_id", "value": "architecto", "description": "The ID of the order." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] } ] }, { "name": "Filters", "description": "", "item": [ { "name": "Get filter data for products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/filters", "query": [ { "key": "category", "value": "", "description": "Category ID to get filter data for a specific category.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/filters?category=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] } ] }, { "name": "Flash Sale", "description": "", "item": [ { "name": "Get flash sales", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/flash-sales", "query": [ { "key": "keys[]", "value": "", "description": "Array of flash sale keys to filter by.", "disabled": true }, { "key": "thumbnail_size", "value": "architecto", "description": "Size of product thumbnail images. Value: thumb, small, medium, large. Default: thumb", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/flash-sales?keys[]=&thumbnail_size=architecto" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"keys\":null}" }, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] } ] }, { "name": "Notifications", "description": "", "item": [ { "name": "Get user notifications", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of notifications per page (max 50).", "disabled": false }, { "key": "unread_only", "value": "", "description": "Filter to show only unread notifications.", "disabled": true }, { "key": "type", "value": "general", "description": "Filter by notification type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/notifications?page=1&per_page=20&unread_only=&type=general" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve notifications for the authenticated user.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get notification statistics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/stats", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notifications\/stats" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get notification statistics for the authenticated user.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Mark all notifications as read", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/mark-all-read", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notifications\/mark-all-read" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mark all notifications as read for the authenticated user.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Mark notification as read", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/:id\/read", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notifications\/:id\/read", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the notification." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mark a specific notification as read for the authenticated user.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Mark notification as clicked", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/:id\/clicked", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notifications\/:id\/clicked", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the notification." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mark a notification as clicked when user taps on it.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete notification", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/notifications\/:id", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the notification." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a notification from user's list.", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Order Returns", "description": "", "item": [ { "name": "Get list of order return requests for the current user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/order-returns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/order-returns" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get detail of an order return request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/order-returns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/order-returns\/:id", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the order return." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Submit a new order return request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/order-returns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/order-returns" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"order_id\":1,\"return_items\":[\"architecto\"],\"reason\":\"DAMAGED_PRODUCT\"}" }, "description": "" }, "response": [] }, { "name": "Get order information for return request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/orders\/:order_id\/returns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/orders\/:order_id\/returns", "variable": [ { "id": "order_id", "key": "order_id", "value": "564", "description": "The ID of the order." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Orders", "description": "\nAPIs for order tracking", "item": [ { "name": "Get list of orders by customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/orders", "query": [ { "key": "status", "value": "completed", "description": "Filter orders by status (pending, processing, completed, canceled).", "disabled": false }, { "key": "shipping_status", "value": "delivered", "description": "Filter orders by shipping status (not_shipped, delivering, delivered, canceled).", "disabled": false }, { "key": "payment_status", "value": "completed", "description": "Filter orders by payment status (pending, completed, refunding, refunded, canceled).", "disabled": false }, { "key": "per_page", "value": "10", "description": "Number of orders per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/orders?status=completed&shipping_status=delivered&payment_status=completed&per_page=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get order detail", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/orders\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/orders\/:id", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the order." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Cancel an order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/orders\/:id\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/orders\/:id\/cancel", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the order." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"cancellation_reason\":\"OTHER\",\"cancellation_reason_description\":\"I found a better deal elsewhere\"}" }, "description": "" }, "response": [] }, { "name": "Print an order invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/orders\/:id\/invoice", "query": [ { "key": "type", "value": "download", "description": "Type of response (print or download).", "disabled": false }, { "key": "format", "value": "architecto", "description": "Response format (url or pdf). Use 'pdf' for direct PDF content, 'url' for URL response. Default: url", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/orders\/:id\/invoice?type=download&format=architecto", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the order." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Upload payment proof for an order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/orders\/:id\/upload-proof", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/orders\/:id\/upload-proof", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the order." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "src": [], "type": "file" } ] }, "description": "" }, "response": [] }, { "name": "Download payment proof for an order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/orders\/:id\/download-proof", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/orders\/:id\/download-proof", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the order." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Confirm delivery of an order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/orders\/:id\/confirm-delivery", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/orders\/:id\/confirm-delivery", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the order." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Track an order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/orders\/tracking", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/orders\/tracking" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"ORD-12345\",\"email\":\"customer@example.com\",\"phone\":\"+1234567890\"}" }, "description": "Track an order by order code and email\/phone", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Order found successfully\",\n \"data\": {\n \"order\": {\n \"id\": 1,\n \"code\": \"ORD-12345\",\n \"status\": \"completed\",\n \"amount\": 100.00,\n \"shipping_amount\": 10.00,\n \"payment_fee\": 5.00,\n \"tax_amount\": 5.00,\n \"sub_total\": 90.00,\n \"discount_amount\": 0.00,\n \"payment_id\": 1,\n \"user_id\": 1,\n \"created_at\": \"2023-08-10T12:34:56.000000Z\",\n \"updated_at\": \"2023-08-10T12:34:56.000000Z\",\n \"address\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"customer@example.com\",\n \"phone\": \"+1234567890\",\n \"address\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip_code\": \"10001\"\n },\n \"products\": [\n {\n \"id\": 1,\n \"name\": \"Product 1\",\n \"price\": 90.00,\n \"qty\": 1\n }\n ],\n \"histories\": [\n {\n \"id\": 1,\n \"action\": \"create_order\",\n \"description\": \"Order was created\",\n \"created_at\": \"2023-08-10T12:34:56.000000Z\"\n }\n ],\n \"shipment\": {\n \"id\": 1,\n \"status\": \"delivered\",\n \"tracking_id\": \"SHIP-12345\",\n \"tracking_link\": \"https:\/\/example.com\/tracking\/SHIP-12345\"\n },\n \"payment\": {\n \"id\": 1,\n \"status\": \"completed\",\n \"payment_channel\": \"stripe\",\n \"amount\": 100.00\n }\n }\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Order not found\",\n \"code\": 404\n}", "name": "" } ] } ] }, { "name": "Page", "description": "", "item": [ { "name": "List pages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pages", "query": [ { "key": "per_page", "value": "16", "description": "The number of items to return per page (default: 10).", "disabled": false }, { "key": "page", "value": "16", "description": "The page number to retrieve (default: 1).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pages?per_page=16&page=16" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"About Us\",\n \"slug\": \"about-us\",\n \"content\": \"This is the about us page content...\",\n \"published_at\": \"2023-01-01T00:00:00.000000Z\"\n }\n ],\n \"message\": null\n}", "name": "" } ] }, { "name": "Get page by ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pages\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pages\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the page to retrieve." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": {\n \"id\": 1,\n \"title\": \"About Us\",\n \"slug\": \"about-us\",\n \"content\": \"This is the about us page content...\",\n \"published_at\": \"2023-01-01T00:00:00.000000Z\"\n },\n \"message\": null\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Not found\"\n}", "name": "" } ] } ] }, { "name": "Product Categories", "description": "", "item": [ { "name": "Get list of product categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/product-categories", "query": [ { "key": "categories", "value": "", "description": "nullable array List of category IDs if you need filter by categories, (e.g. [1,2,3]).", "disabled": true }, { "key": "page", "value": "", "description": "Page number. Default: 1.", "disabled": true }, { "key": "per_page", "value": "", "description": "Number of items per page. Default: 16.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/product-categories?categories=&page=&per_page=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"is_featured\":true}" }, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Get product category details by slug", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/product-categories\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/product-categories\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "architecto", "description": "The slug of the product category." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Get products by category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/product-categories\/:id\/products", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/product-categories\/:id\/products", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the product category." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] } ] }, { "name": "Products", "description": "", "item": [ { "name": "Get list of products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/products", "query": [ { "key": "categories[]", "value": "", "description": "Filter by category IDs.", "disabled": true }, { "key": "brands[]", "value": "", "description": "Filter by brand IDs.", "disabled": true }, { "key": "collections[]", "value": "", "description": "Filter by collection IDs.", "disabled": true }, { "key": "q", "value": "", "description": "Search term.", "disabled": true }, { "key": "sort_by", "value": "architecto", "description": "Sort field. Value: default_sorting, date_asc, date_desc, price_asc, price_desc, name_asc, name_desc, rating_asc, rating_desc", "disabled": false }, { "key": "page", "value": "", "description": "The current page.", "disabled": true }, { "key": "per_page", "value": "", "description": "Number of items per page.", "disabled": true }, { "key": "discounted_only", "value": "", "description": "Filter by discounted only.", "disabled": true }, { "key": "min_price", "value": "", "description": "Minimum price.", "disabled": true }, { "key": "max_price", "value": "", "description": "Maximum price.", "disabled": true }, { "key": "price_ranges", "value": "%5B%7B%22from%22%3A10%2C%22to%22%3A20%7D%2C%7B%22from%22%3A30%2C%22to%22%3A40%7D%5D", "description": "Price ranges as JSON string.", "disabled": false }, { "key": "attributes", "value": "%5B%7B%22id%22%3A1%2C%22value%22%3A1%7D%2C%7B%22id%22%3A2%2C%22value%22%3A2%7D%5D", "description": "Attributes as JSON string.", "disabled": false }, { "key": "thumbnail_size", "value": "architecto", "description": "Size of product thumbnail images. Value: thumb, small, medium, large. Default: thumb", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/products?categories[]=&brands[]=&collections[]=&q=&sort_by=architecto&page=&per_page=&discounted_only=&min_price=&max_price=&price_ranges=%5B%7B%22from%22%3A10%2C%22to%22%3A20%7D%2C%7B%22from%22%3A30%2C%22to%22%3A40%7D%5D&attributes=%5B%7B%22id%22%3A1%2C%22value%22%3A1%7D%2C%7B%22id%22%3A2%2C%22value%22%3A2%7D%5D&thumbnail_size=architecto" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Get product details by slug", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/products\/:slug", "query": [ { "key": "thumbnail_size", "value": "architecto", "description": "Size of product thumbnail images. Value: thumb, small, medium, large. Default: thumb", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/products\/:slug?thumbnail_size=architecto", "variable": [ { "id": "slug", "key": "slug", "value": "architecto", "description": "The slug of the product." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Get related products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/products\/:slug\/related", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/products\/:slug\/related", "variable": [ { "id": "slug", "key": "slug", "value": "architecto", "description": "The slug of the product." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Get cross-sale products for a product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/products\/:slug\/cross-sale", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/products\/:slug\/cross-sale", "variable": [ { "id": "slug", "key": "slug", "value": "architecto", "description": "The slug of the product." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Get product's reviews", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/products\/:slug\/reviews", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/products\/:slug\/reviews", "variable": [ { "id": "slug", "key": "slug", "value": "architecto", "description": "The slug of the product." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "Get product variation by attributes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/product-variation\/:id", "query": [ { "key": "attributes[]", "value": "", "description": "Array of attribute IDs.", "disabled": true }, { "key": "reference_product", "value": "", "description": "Reference product slug.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/product-variation\/:id?attributes[]=&reference_product=", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the product variation." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reference_product\":\"architecto\",\"attributes\":[\"architecto\"]}" }, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] } ] }, { "name": "Profile", "description": "", "item": [ { "name": "Get the user profile information.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/me" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"bngz\",\"last_name\":\"miyv\",\"name\":\"architecto\",\"phone\":\"architecto\",\"dob\":\"architecto\",\"gender\":\"architecto\",\"description\":\"Eius et animi quos velit et.\",\"email\":\"gbailey@example.net\"}" }, "description": "" }, "response": [] }, { "name": "Update Avatar", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/update\/avatar", "query": [], "raw": "{{baseUrl}}\/api\/v1\/update\/avatar" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "avatar", "src": [], "type": "file" } ] }, "description": "" }, "response": [] }, { "name": "Update password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/update\/password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/update\/password" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"password\":\"|]|{+-\",\"old_password\":\"architecto\"}" }, "description": "" }, "response": [] }, { "name": "Get user settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/settings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/settings" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update user settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/settings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/settings" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"biometric_enabled\":false,\"notification_enabled\":false,\"language\":\"architecto\",\"currency\":\"architecto\",\"theme\":\"architecto\",\"timezone\":\"Asia\\\/Yekaterinburg\"}" }, "description": "" }, "response": [] } ] }, { "name": "Reviews", "description": "", "item": [ { "name": "Get list of reviews for the current user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/reviews", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/reviews" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"error\":true,\"data\":null,\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new review", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/reviews", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/reviews" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":1,\"star\":5,\"comment\":\"This is a great product! I highly recommend it.\"}" }, "description": "" }, "response": [] }, { "name": "Delete a review", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/reviews\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/reviews\/:id", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the review." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Simple Slider", "description": "", "item": [ { "name": "Get sliders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/simple-sliders", "query": [ { "key": "keys[0]", "value": "home-slider", "description": "Array of slider keys to filter by.", "disabled": false }, { "key": "keys[1]", "value": "product-slider", "description": "Array of slider keys to filter by.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/simple-sliders?keys[0]=home-slider&keys[1]=product-slider" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"keys\":[\"home-slider\",\"product-slider\"]}" }, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] } ] }, { "name": "Social Login", "description": "", "item": [ { "name": "Apple login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/apple", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/apple" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"identityToken\":\"architecto\",\"guard\":\"architecto\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": {\n \"token\": \"1|abc123def456...\",\n \"user\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n }\n },\n \"message\": \"Login successful\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"error\": true,\n \"message\": \"Invalid Apple token\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"error\": true,\n \"message\": \"Cannot login, no email or Apple ID provided!\"\n}", "name": "" } ] }, { "name": "Google login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/google", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/google" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"identityToken\":\"architecto\",\"guard\":\"architecto\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": {\n \"token\": \"1|abc123def456...\",\n \"user\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n }\n },\n \"message\": \"Login successful\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"error\": true,\n \"message\": \"Invalid Google token\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"error\": true,\n \"message\": \"Google authentication is not properly configured\"\n}", "name": "" } ] }, { "name": "Facebook login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/facebook", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/facebook" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"accessToken\":\"architecto\",\"guard\":\"architecto\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": {\n \"token\": \"1|abc123def456...\",\n \"user\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n }\n },\n \"message\": \"Login successful\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"error\": true,\n \"message\": \"Invalid Facebook token\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"error\": true,\n \"message\": \"Facebook authentication is not properly configured\"\n}", "name": "" } ] }, { "name": "X (Twitter) login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/x", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/x" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"accessToken\":\"architecto\",\"guard\":\"architecto\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": {\n \"token\": \"1|abc123def456...\",\n \"user\": {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n }\n },\n \"message\": \"Login successful\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"error\": true,\n \"message\": \"Invalid X (Twitter) token\"\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"error\": true,\n \"message\": \"X (Twitter) authentication is not properly configured\"\n}", "name": "" } ] } ] }, { "name": "Wishlist", "description": "", "item": [ { "name": "Add product to wishlist", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/wishlist", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/wishlist" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Add product to wishlist", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/wishlist\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/wishlist\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the wishlist." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Remove a product from wishlist", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/wishlist\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/wishlist\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the wishlist." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_id\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get wishlist items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/ecommerce\/wishlist\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/ecommerce\/wishlist\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the wishlist." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"e70c6c88dae8344b03e39bb147eba66a\"}" }, "description": "", "auth": { "type": "noauth" } }, "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\":\"Invalid or missing API key. Please provide a valid X-API-KEY header.\",\"error\":\"Unauthorized\"}", "name": "" } ] } ] } ], "auth": { "type": "noauth" } }