{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/dokio.shop" } ], "info": { "name": "Dokio API Documentation", "_postman_id": "d414c509-33c1-470a-8b15-7501eaef596e", "description": "REST API for the Dokio multi-vendor marketplace platform.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Authentication", "description": "Register, log in, verify email, and manage your session.", "item": [ { "name": "Current user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/me", "query": [], "raw": "{{baseUrl}}\/api\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return the authenticated user, including their store when available." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"User fetched successfully\",\"data\":{\"type\":\"user\",\"id\":\"1\",\"attributes\":{\"name\":\"Jane Doe\",\"email\":\"jane@example.com\"},\"relationships\":{\"store\":{\"data\":{\"id\":\"1\",\"type\":\"store\"}},\"links\":{\"self\":\"https:\\\/\\\/api.dokio.local\\\/api\\\/v1\\\/stores\\\/1\"}}}}", "name": "" } ] }, { "name": "Log in", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/login", "query": [], "raw": "{{baseUrl}}\/api\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"jane@example.com\",\"password\":\"password123\"}" }, "description": "Authenticate with email and password. Returns a Sanctum token valid for one month. The account must be email-verified.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Logged in successfully\",\"data\":{\"token\":\"1|abcXYZ...\",\"verified\":true}}", "name": "Successful login" }, { "header": [], "code": 400, "body": "{\"errors\":[{\"status\":\"400\",\"code\":\"email.not_verified\",\"detail\":\"Email not verified\"}]}", "name": "Email not verified" }, { "header": [], "code": 401, "body": "{\"errors\":[{\"status\":\"401\",\"code\":\"credentials.invalid\",\"detail\":\"Invalid credentials\"}]}", "name": "Invalid credentials" } ] }, { "name": "Register", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/register", "query": [], "raw": "{{baseUrl}}\/api\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Jane Doe\",\"email\":\"jane@example.com\",\"password\":\"password123\"}" }, "description": "Create a new user account and receive a Sanctum token. A verification email is sent automatically.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\"status\":201,\"message\":\"User registered successfully\",\"data\":{\"token\":\"1|abcXYZ...\",\"verified\":false}}", "name": "" } ] }, { "name": "Register or log in with Google", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/google", "query": [], "raw": "{{baseUrl}}\/api\/auth\/google" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id_token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...\"}" }, "description": "Authenticate with a Google ID token from the client. Creates an account if needed, or links Google to an existing email account. Returns a Sanctum token valid for one month.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Logged in successfully\",\"data\":{\"token\":\"1|abcXYZ...\",\"verified\":true}}", "name": "Successful Google authentication" }, { "header": [], "code": 400, "body": "{\"errors\":[{\"status\":\"400\",\"code\":\"google.email_not_verified\",\"detail\":\"Google email not verified\"}]}", "name": "Google account email is not verified" }, { "header": [], "code": 401, "body": "{\"errors\":[{\"status\":\"401\",\"code\":\"google.invalid_id_token\",\"detail\":\"Invalid Google token\"}]}", "name": "Invalid or expired ID token" } ] }, { "name": "Register or log in with a Google authorization code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/google\/code", "query": [], "raw": "{{baseUrl}}\/api\/auth\/google\/code" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"synthetic-google-authorization-code\"}" }, "description": "Exchange a one-time Google popup code for an ID token, then authenticate the user. The request Origin must match FRONTEND_URL and X-Requested-With must be XMLHttpRequest. Returns a Sanctum token valid for one month.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Logged in successfully\",\"data\":{\"token\":\"1|abcXYZ...\",\"verified\":true}}", "name": "Successful Google authentication" }, { "header": [], "code": 401, "body": "{\"errors\":[{\"status\":\"401\",\"code\":\"google.invalid_code\",\"detail\":\"Invalid Google authorization code\"}]}", "name": "Invalid or expired authorization code" }, { "header": [], "code": 403, "body": "{\"errors\":[{\"status\":\"403\",\"code\":\"google.invalid_origin\",\"detail\":\"Invalid Google sign-in origin\"}]}", "name": "Request origin is not the configured dashboard origin" } ] }, { "name": "Forgot password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/forgot-password", "query": [], "raw": "{{baseUrl}}\/api\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"jane@example.com\"}" }, "description": "Send a password reset email if the account exists.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Password reset email sent\",\"data\":[]}", "name": "" }, { "header": [], "code": 404, "body": "{\"errors\":[{\"status\":\"404\",\"code\":\"user.not_found\",\"detail\":\"User not found\"}]}", "name": "" } ] }, { "name": "Reset password", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reset-password", "query": [], "raw": "{{baseUrl}}\/api\/reset-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"abc123resetToken\",\"email\":\"jane@example.com\",\"password\":\"newpassword123\"}" }, "description": "Set a new password using the token from the reset email. All existing tokens are revoked.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Password reset successfully\",\"data\":[]}", "name": "" }, { "header": [], "code": 400, "body": "{\"errors\":[{\"status\":\"400\",\"code\":\"passwords.reset_failed\",\"detail\":\"Failed to reset password\"}]}", "name": "" } ] }, { "name": "Log out", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/logout", "query": [], "raw": "{{baseUrl}}\/api\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoke the current access token." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Logged out successfully\",\"data\":[]}", "name": "" } ] }, { "name": "Verify email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/email\/verify\/:id\/:hash", "query": [], "raw": "{{baseUrl}}\/api\/email\/verify\/:id\/:hash", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The user ID." }, { "id": "hash", "key": "hash", "value": "a1b2c3d4e5f6", "description": "SHA1 hash of the user email (from the verification link)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Confirm the user email address using the link from the verification email.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\"status\":201,\"message\":\"Email verified successfully\",\"data\":{\"token\":\"1|abcXYZ...\",\"verified\":true}}", "name": "" }, { "header": [], "code": 400, "body": "{\"errors\":[{\"status\":\"400\",\"code\":\"verification.invalid_link\",\"detail\":\"Invalid verification link\"}]}", "name": "" }, { "header": [], "code": 400, "body": "{\"errors\":[{\"status\":\"400\",\"code\":\"verification.email_already_verified\",\"detail\":\"Email already verified\"}]}", "name": "" } ] } ] }, { "name": "Users", "description": "Retrieve user accounts and related store data.", "item": [ { "name": "List users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/users?page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return a paginated list of users with their stores eager-loaded." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"type\":\"user\",\"id\":\"51\",\"attributes\":{\"name\":\"Morgan Hirthe\",\"email\":\"dare.emelie@example.com\"},\"relationships\":{\"store\":{\"data\":{\"id\":\"47\",\"type\":\"store\"},\"links\":{\"self\":\"https:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users?51\"}}},\"included\":{\"type\":\"store\",\"id\":47,\"attributes\":{\"name\":\"Prof. Mina Bauch\",\"slug\":\"prof-mina-bauch\",\"industry\":\"fashion\",\"logo\":\"https:\\\/\\\/dokio.shop\\\/storage\\\/https:\\\/\\\/via.placeholder.com\\\/640x480.png\\\/002222?text=nostrum\",\"color\":\"#007bff\",\"createdAt\":\"2026-09-21T17:28:48.000000Z\",\"updatedAt\":\"2026-09-21T17:28:48.000000Z\"},\"relationships\":{\"user\":{\"data\":{\"id\":51,\"type\":\"user\"},\"links\":{\"self\":\"https:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/47\"}}},\"links\":{\"self\":\"https:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/47\"}},\"links\":{\"self\":\"https:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/51\"}},{\"type\":\"user\",\"id\":\"52\",\"attributes\":{\"name\":\"Carey Smitham\",\"email\":\"sleffler@example.org\"},\"relationships\":{\"store\":{\"data\":{\"id\":\"48\",\"type\":\"store\"},\"links\":{\"self\":\"https:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users?52\"}}},\"included\":{\"type\":\"store\",\"id\":48,\"attributes\":{\"name\":\"Matilda Feeney\",\"slug\":\"matilda-feeney\",\"industry\":\"food\",\"logo\":\"https:\\\/\\\/dokio.shop\\\/storage\\\/https:\\\/\\\/via.placeholder.com\\\/640x480.png\\\/0088cc?text=laboriosam\",\"color\":\"#007bff\",\"createdAt\":\"2026-09-21T17:28:48.000000Z\",\"updatedAt\":\"2026-09-21T17:28:48.000000Z\"},\"relationships\":{\"user\":{\"data\":{\"id\":52,\"type\":\"user\"},\"links\":{\"self\":\"https:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/48\"}}},\"links\":{\"self\":\"https:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/48\"}},\"links\":{\"self\":\"https:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/52\"}}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":15,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Get user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user." }, { "id": "user", "key": "user", "value": "1", "description": "The user ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return a single user by ID, including their store." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"type\":\"user\",\"id\":\"53\",\"attributes\":{\"name\":\"Morgan Hirthe\",\"email\":\"imclaughlin@example.org\",\"createdAt\":\"2026-09-21T17:28:48.000000Z\",\"updatedAt\":\"2026-09-21T17:28:48.000000Z\",\"emailVerifiedAt\":\"2026-09-21T17:28:48.000000Z\"},\"relationships\":{\"store\":{\"data\":{\"id\":\"49\",\"type\":\"store\"},\"links\":{\"self\":\"http:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users?53\"}}},\"included\":{\"type\":\"store\",\"id\":49,\"attributes\":{\"name\":\"Mr. Oswald Koch\",\"slug\":\"mr-oswald-koch\",\"industry\":\"home\",\"logo\":\"http:\\\/\\\/dokio.shop\\\/storage\\\/https:\\\/\\\/via.placeholder.com\\\/640x480.png\\\/00ee77?text=consequatur\",\"color\":\"#007bff\",\"createdAt\":\"2026-09-21T17:28:48.000000Z\",\"updatedAt\":\"2026-09-21T17:28:48.000000Z\"},\"relationships\":{\"user\":{\"data\":{\"id\":53,\"type\":\"user\"},\"links\":{\"self\":\"http:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/49\"}}},\"links\":{\"self\":\"http:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/49\"}},\"links\":{\"self\":\"http:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/53\"}}}", "name": "" } ] } ] }, { "name": "Stores", "description": "Create and manage vendor stores.", "item": [ { "name": "Create store", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stores", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stores" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Acme Fashion", "type": "text", "description": "The store display name. Must not be greater than 255 characters." }, { "key": "industry", "value": "fashion", "type": "text", "description": "Store industry. Allowed: fashion, electronics, food, beauty, home, other." }, { "key": "color", "value": "b", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "logo", "src": [], "type": "file" } ] }, "description": "Create a store for the authenticated user. Accepts `multipart\/form-data` when uploading a logo." }, "response": [ { "header": [], "code": 201, "body": "{\"status\":201,\"message\":\"Store created successfully\",\"data\":{\"type\":\"store\",\"id\":1,\"attributes\":{\"name\":\"Acme Fashion\",\"slug\":\"acme-fashion\",\"industry\":\"fashion\",\"logo\":null,\"color\":\"#007bff\"}}}", "name": "" } ] }, { "name": "Update store", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stores\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stores\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "backs", "description": "The slug of the store." }, { "id": "store", "key": "store", "value": "1", "description": "The store ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Acme Fashion", "type": "text", "description": "The store display name. Must not be greater than 255 characters." }, { "key": "industry", "value": "fashion", "type": "text", "description": "Store industry. Allowed: fashion, electronics, food, beauty, home, other." }, { "key": "color", "value": "b", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "logo", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "Update an existing store. Accepts `multipart\/form-data` when uploading a new logo." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Store updated successfully\",\"data\":{\"type\":\"store\",\"id\":1,\"attributes\":{\"name\":\"Acme Fashion\",\"slug\":\"acme-fashion\",\"industry\":\"fashion\",\"color\":\"#007bff\"}}}", "name": "" } ] }, { "name": "Delete store", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stores\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stores\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "backs", "description": "The slug of the store." }, { "id": "store", "key": "store", "value": "1", "description": "The store ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a store when it has no related catalog data or orders." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Store deleted successfully\",\"data\":{\"type\":\"store\",\"id\":1,\"attributes\":{\"name\":\"Acme Fashion\",\"slug\":\"acme-fashion\"}}}", "name": "" }, { "header": [], "code": 403, "body": "{\"errors\":[{\"status\":\"403\",\"code\":\"store.forbidden\",\"detail\":\"You are not authorized to delete this store\"}]}", "name": "" }, { "header": [], "code": 422, "body": "{\"errors\":[{\"status\":\"422\",\"code\":\"store.has_related_records\",\"detail\":\"Cannot delete store because it has related products, categories, options, or orders\"}]}", "name": "" } ] }, { "name": "Get store", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stores\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stores\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "backs", "description": "The slug of the store." }, { "id": "store", "key": "store", "value": "1", "description": "The store ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return a single store by ID. This endpoint is public.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"type\":\"store\",\"id\":50,\"attributes\":{\"name\":\"Morgan Hirthe\",\"slug\":\"morgan-hirthe\",\"industry\":\"fashion\",\"logo\":\"http:\\\/\\\/dokio.shop\\\/storage\\\/https:\\\/\\\/via.placeholder.com\\\/640x480.png\\\/0077ff?text=qui\",\"color\":\"#007bff\",\"createdAt\":\"2026-09-21T17:28:48.000000Z\",\"updatedAt\":\"2026-09-21T17:28:48.000000Z\"},\"relationships\":{\"user\":{\"data\":{\"id\":54,\"type\":\"user\"},\"links\":{\"self\":\"http:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/50\"}}},\"links\":{\"self\":\"http:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/50\"}}}", "name": "" } ] }, { "name": "Get user's store", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:id\/store", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:id\/store", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user." }, { "id": "user", "key": "user", "value": "1", "description": "The user ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return the store associated with a user. This endpoint is public.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"type\":\"store\",\"id\":51,\"attributes\":{\"name\":\"Rowan Gulgowski\",\"slug\":\"rowan-gulgowski\",\"industry\":\"beauty\",\"logo\":\"http:\\\/\\\/dokio.shop\\\/storage\\\/https:\\\/\\\/via.placeholder.com\\\/640x480.png\\\/00bb11?text=sunt\",\"color\":\"#007bff\",\"createdAt\":\"2026-09-21T17:28:49.000000Z\",\"updatedAt\":\"2026-09-21T17:28:49.000000Z\"},\"relationships\":{\"user\":{\"data\":{\"id\":55,\"type\":\"user\"},\"links\":{\"self\":\"http:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/51\"}}},\"links\":{\"self\":\"http:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/51\"}},{\"type\":\"store\",\"id\":52,\"attributes\":{\"name\":\"Mr. Gilbert Swift V\",\"slug\":\"mr-gilbert-swift-v\",\"industry\":\"fashion\",\"logo\":\"http:\\\/\\\/dokio.shop\\\/storage\\\/https:\\\/\\\/via.placeholder.com\\\/640x480.png\\\/005500?text=quidem\",\"color\":\"#007bff\",\"createdAt\":\"2026-09-21T17:28:49.000000Z\",\"updatedAt\":\"2026-09-21T17:28:49.000000Z\"},\"relationships\":{\"user\":{\"data\":{\"id\":56,\"type\":\"user\"},\"links\":{\"self\":\"http:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/52\"}}},\"links\":{\"self\":\"http:\\\/\\\/dokio.shop\\\/api\\\/v1\\\/users\\\/52\"}}]}", "name": "" } ] } ] }, { "name": "Products", "description": "Browse and manage marketplace products.", "item": [ { "name": "List store products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stores\/:store_slug\/products", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stores\/:store_slug\/products", "variable": [ { "id": "store_slug", "key": "store_slug", "value": "backs", "description": "The slug of the store." }, { "id": "store", "key": "store", "value": "1", "description": "The store ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return all products belonging to a store. This endpoint is public.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Products retrieved successfully\",\"data\":[{\"type\":\"product\",\"id\":1,\"attributes\":{\"name\":\"Classic Tee\",\"price\":\"29.99\",\"image\":\"https:\\\/\\\/api.dokio.local\\\/storage\\\/product\\\/tee.jpg\",\"status\":\"in stock\"},\"relationships\":{\"product_variants\":{\"data\":{\"id\":1,\"type\":\"product_variant\"}}},\"links\":{\"self\":\"https:\\\/\\\/api.example.com\\\/products\\\/1\"}}]}", "name": "" } ] }, { "name": "Get a store product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stores\/:store_slug\/products\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stores\/:store_slug\/products\/:slug", "variable": [ { "id": "store_slug", "key": "store_slug", "value": "backs", "description": "The slug of the store." }, { "id": "slug", "key": "slug", "value": "sds", "description": "The slug of the product." }, { "id": "store", "key": "store", "value": "acme-fashion", "description": "The store slug." }, { "id": "product", "key": "product", "value": "classic-tee", "description": "The product slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return a single product belonging to a store. This endpoint is public.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Product retrieved successfully\",\"data\":{\"type\":\"product\",\"id\":1,\"attributes\":{\"name\":\"Classic Tee\",\"slug\":\"classic-tee\",\"description_html\":\"

Soft cotton t-shirt in classic fit.<\\\/p>\"},\"relationships\":{\"product_variants\":{\"data\":{\"id\":1,\"type\":\"product_variant\"}}},\"includes\":{\"product_variants\":{\"data\":{\"id\":1,\"type\":\"product_variant\",\"attributes\":{\"price\":\"29.99\",\"stock\":100,\"sku\":\"TSHIRT-BLUE-M\",\"image\":\"https:\\\/\\\/api.dokio.local\\\/storage\\\/product\\\/tee.jpg\",\"status\":\"in stock\"}}}},\"links\":{\"self\":\"https:\\\/\\\/api.example.com\\\/products\\\/1\"}}}", "name": "" } ] }, { "name": "List products", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/products", "query": [ { "key": "status", "value": "active", "description": "Filter by status. Comma-separated for multiple values.", "disabled": false }, { "key": "search", "value": "%2Ashirt%2A", "description": "Search product name. Use `*` as a wildcard (e.g. `*shirt*`).", "disabled": false }, { "key": "createdAt", "value": "2024-01-01", "description": "Filter by created date (`Y-m-d`) or range (`start,end`).", "disabled": false }, { "key": "updatedAt", "value": "2024-01-01%2C2024-12-31", "description": "Filter by updated date (`Y-m-d`) or range (`start,end`).", "disabled": false }, { "key": "include", "value": "product_variants", "description": "Eager-load relations (e.g. `product_variants`).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/products?status=active&search=%2Ashirt%2A&createdAt=2024-01-01&updatedAt=2024-01-01%2C2024-12-31&include=product_variants&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return a paginated list of products. Supports filtering by status, search, dates, and includes." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Products retrieved successfully\",\"data\":[{\"type\":\"product\",\"id\":1,\"attributes\":{\"name\":\"Classic Tee\",\"slug\":\"classic-tee\",\"createdAt\":\"2024-01-15T10:00:00.000000Z\",\"updatedAt\":\"2024-01-15T10:00:00.000000Z\",\"status\":\"in stock\"},\"relationships\":{\"user\":{\"data\":{\"id\":1,\"type\":\"user\"}}},\"links\":{\"self\":\"https:\\\/\\\/api.dokio.local\\\/api\\\/v1\\\/products\\\/1\"}}]}", "name": "Paginated products" } ] }, { "name": "Create product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/products", "query": [], "raw": "{{baseUrl}}\/api\/v1\/products" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Classic Tee\",\"description_html\":\"

\u062a\u0641\u0627\u0635\u064a\u0644 \u0627\u0644\u0645\u0646\u062a\u062c<\\\/h2>

\u0642\u0637\u0646 \u0646\u0627\u0639\u0645 \u2014 Soft cotton<\\\/strong>.<\\\/p>\",\"category_id\":1}" }, "description": "Create a product for the authenticated user's store. Send required `description_html` (max 100,000 UTF-8 bytes). HTML is sanitized. Mutation responses omit it; fetch a detail route to read it." }, "response": [ { "header": [], "code": 201, "body": "{\"status\":201,\"message\":\"Product created successfully\",\"data\":{\"type\":\"product\",\"id\":1,\"attributes\":{\"name\":\"Classic Tee\",\"slug\":\"classic-tee\",\"createdAt\":\"2024-01-15T10:00:00.000000Z\",\"updatedAt\":\"2024-01-15T10:00:00.000000Z\",\"status\":null}}}", "name": "" }, { "header": [], "code": 422, "body": "{\"errors\":[{\"status\":\"422\",\"code\":\"validation.max_utf8_bytes\",\"detail\":\"This field exceeds the maximum allowed value.\",\"source\":{\"pointer\":\"\\\/description_html\"},\"meta\":{\"field\":\"description_html\"}}]}", "name": "" } ] }, { "name": "Get product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/products\/:slug", "query": [ { "key": "include", "value": "author", "description": "Optional related resources to include. Use `author` for the product owner.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/products\/:slug?include=author", "variable": [ { "id": "slug", "key": "slug", "value": "sds", "description": "The slug of the product." }, { "id": "product", "key": "product", "value": "classic-tee", "description": "The product slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return a single product. Pass `include=author` to embed the owning user." }, "response": [ { "header": [], "code": 200, "body": "{\"type\":\"product\",\"id\":1,\"attributes\":{\"name\":\"Classic Tee\",\"slug\":\"classic-tee\",\"description_html\":\"

Soft cotton t-shirt in classic fit.<\\\/p>\",\"createdAt\":\"2024-01-15T10:00:00.000000Z\",\"updatedAt\":\"2024-01-15T10:00:00.000000Z\"},\"relationships\":{\"user\":{\"data\":{\"id\":1,\"type\":\"user\"}},\"category\":{\"data\":{\"id\":1,\"type\":\"category\"}},\"variants\":{\"data\":[{\"id\":1,\"type\":\"variant\"},{\"id\":2,\"type\":\"variant\"}]}},\"links\":{\"self\":\"https:\\\/\\\/api.dokio.local\\\/api\\\/v1\\\/products\\\/1\"}}", "name": "" } ] }, { "name": "Update product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/products\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/products\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "sds", "description": "The slug of the product." }, { "id": "product", "key": "product", "value": "classic-tee", "description": "The product slug." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Classic Tee\",\"description_html\":\"

\u062a\u0641\u0627\u0635\u064a\u0644 \u0627\u0644\u0645\u0646\u062a\u062c<\\\/h2>

\u0642\u0637\u0646 \u0646\u0627\u0639\u0645 \u2014 Soft cotton<\\\/strong>.<\\\/p>\",\"category_id\":1}" }, "description": "Replace name, HTML description, and category of an owned product identified by slug. Send required `description_html` (max 100,000 UTF-8 bytes). HTML is sanitized. Mutation responses omit it; fetch a detail route to read it. Dashboard clients may POST multipart with `_method=PUT`." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Product updated successfully\",\"data\":{\"type\":\"product\",\"id\":1,\"attributes\":{\"name\":\"Classic Tee\",\"slug\":\"classic-tee\",\"createdAt\":\"2024-01-15T10:00:00.000000Z\",\"updatedAt\":\"2024-01-15T10:00:00.000000Z\",\"status\":null}}}", "name": "" }, { "header": [], "code": 422, "body": "{\"errors\":[{\"status\":\"422\",\"code\":\"validation.max_utf8_bytes\",\"detail\":\"This field exceeds the maximum allowed value.\",\"source\":{\"pointer\":\"\\\/description_html\"},\"meta\":{\"field\":\"description_html\"}}]}", "name": "" } ] }, { "name": "Delete product", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/products\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/products\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "sds", "description": "The slug of the product." }, { "id": "product", "key": "product", "value": "classic-tee", "description": "The product slug." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a product when it has no related variants." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Product deleted successfully\",\"data\":{\"type\":\"product\",\"id\":1,\"attributes\":{\"name\":\"Classic Tee\",\"slug\":\"classic-tee\"}}}", "name": "" }, { "header": [], "code": 422, "body": "{\"errors\":[{\"status\":\"422\",\"code\":\"product.has_variants\",\"detail\":\"Cannot delete product because it has related variants\"}]}", "name": "" } ] } ] }, { "name": "Categories", "description": "Manage product categories.", "item": [ { "name": "List store categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stores\/:store_slug\/categories", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stores\/:store_slug\/categories", "variable": [ { "id": "store_slug", "key": "store_slug", "value": "backs", "description": "The slug of the store." }, { "id": "store", "key": "store", "value": "acme-fashion", "description": "The store slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return all categories belonging to a store. This endpoint is public.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Categories retrieved successfully\",\"data\":[{\"type\":\"category\",\"id\":1,\"attributes\":{\"name\":\"Apparel\",\"slug\":\"apparel\",\"image\":\"https:\\\/\\\/api.dokio.local\\\/storage\\\/category\\\/apparel.jpg\",\"status\":\"active\"}}],\"relationships\":{\"store\":{\"data\":{\"id\":1,\"type\":\"store\"},\"links\":{\"self\":\"https:\\\/\\\/api.dokio.local\\\/api\\\/v1\\\/stores\\\/1\"}}}}", "name": "" } ] }, { "name": "Get a store category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stores\/:store_slug\/categories\/:slug", "query": [ { "key": "include", "value": "products", "description": "Optional related resources to include. Use `products` for the category products to be included.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/stores\/:store_slug\/categories\/:slug?include=products", "variable": [ { "id": "store_slug", "key": "store_slug", "value": "backs", "description": "The slug of the store." }, { "id": "slug", "key": "slug", "value": "backpacks", "description": "The slug of the category." }, { "id": "The store slug.", "key": "The store slug.", "value": "acme-fashion", "description": "" }, { "id": "The category slug.", "key": "The category slug.", "value": "apparel", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return a single category belonging to a store. This endpoint is public.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Category retrieved successfully\",\"data\":{\"type\":\"category\",\"id\":1,\"attributes\":{\"name\":\"Apparel\",\"slug\":\"apparel\",\"image\":\"https:\\\/\\\/api.dokio.local\\\/storage\\\/category\\\/apparel.jpg\",\"status\":\"active\"}},\"relationships\":{\"store\":{\"data\":{\"id\":1,\"type\":\"store\"}},\"links\":{\"self\":\"https:\\\/\\\/api.dokio.local\\\/api\\\/v1\\\/stores\\\/1\\\/categories\\\/1\"}}}", "name": "" } ] }, { "name": "List categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/categories", "query": [], "raw": "{{baseUrl}}\/api\/v1\/categories" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return all categories." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Categories retrieved successfully\",\"data\":[{\"type\":\"category\",\"id\":1,\"attributes\":{\"name\":\"Apparel\",\"slug\":\"apparel\",\"image\":\"https:\\\/\\\/api.dokio.local\\\/storage\\\/category\\\/apparel.jpg\",\"status\":\"active\"}}]}", "name": "" } ] }, { "name": "Create category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/categories", "query": [], "raw": "{{baseUrl}}\/api\/v1\/categories" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Apparel", "type": "text", "description": "The category name. Must not be greater than 255 characters." }, { "key": "image", "src": [], "type": "file" } ] }, "description": "Create a new category. Accepts `multipart\/form-data` when uploading an image." }, "response": [ { "header": [], "code": 201, "body": "{\"status\":201,\"message\":\"Category created successfully\",\"data\":{\"type\":\"category\",\"id\":1,\"attributes\":{\"name\":\"Apparel\",\"slug\":\"apparel\",\"status\":\"active\"}}}", "name": "" }, { "header": [], "code": 403, "body": "{\"errors\":[{\"status\":\"403\",\"code\":\"store.required\",\"detail\":\"User must have a store to create a category.\"}]}", "name": "" } ] }, { "name": "Get category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/categories\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/categories\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "backpacks", "description": "The slug of the category." }, { "id": "category", "key": "category", "value": "1", "description": "The category ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return a single category by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Category retrieved successfully\",\"data\":{\"type\":\"category\",\"id\":1,\"attributes\":{\"name\":\"Apparel\",\"slug\":\"apparel\",\"status\":\"active\"}}}", "name": "" } ] }, { "name": "Update category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/categories\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/categories\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "backpacks", "description": "The slug of the category." }, { "id": "category", "key": "category", "value": "1", "description": "The category ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Apparel", "type": "text", "description": "The category name. Must not be greater than 255 characters." }, { "key": "status", "value": "active", "type": "text", "description": "Category status." }, { "key": "image", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "Update an existing category. Accepts `multipart\/form-data` when uploading a new image." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Category updated successfully\",\"data\":{\"type\":\"category\",\"id\":1,\"attributes\":{\"name\":\"Apparel\",\"slug\":\"apparel\",\"status\":\"active\"}}}", "name": "" } ] }, { "name": "Delete category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/categories\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/v1\/categories\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "backpacks", "description": "The slug of the category." }, { "id": "category", "key": "category", "value": "1", "description": "The category ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a category when it has no related products." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Category deleted successfully\",\"data\":{\"type\":\"category\",\"id\":1,\"attributes\":{\"name\":\"Apparel\",\"slug\":\"apparel\",\"status\":\"active\"}}}", "name": "" }, { "header": [], "code": 422, "body": "{\"errors\":[{\"status\":\"422\",\"code\":\"category.has_products\",\"detail\":\"Cannot delete category because it has related products\"}]}", "name": "" } ] } ] }, { "name": "Enums", "description": "Lookup values used by other endpoints (e.g. store industries).", "item": [ { "name": "List industries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/enums\/industries", "query": [], "raw": "{{baseUrl}}\/api\/v1\/enums\/industries" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return the allowed industry values for store creation and updates. This endpoint is public.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[\"fashion\",\"electronics\",\"food\",\"beauty\",\"home\",\"other\"]}", "name": "" } ] } ] }, { "name": "Checkout", "description": "Guest COD checkout.", "item": [ { "name": "Place COD order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stores\/:store_slug\/checkout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stores\/:store_slug\/checkout", "variable": [ { "id": "store_slug", "key": "store_slug", "value": "backs", "description": "The slug of the store." }, { "id": "store", "key": "store", "value": "my-store", "description": "Store slug or id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Jane Doe\",\"email\":\"jane@example.com\",\"phone\":\"01001234567\",\"line1\":\"12 Nile Street\",\"city\":\"Cairo\",\"governorate\":\"Cairo\",\"postal_code\":\"11511\",\"country\":\"EG\",\"items\":[{\"product_variant_id\":1,\"quantity\":2}]}" }, "description": "Create a cash-on-delivery order from line items. No cart is stored on the server.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\"status\":201,\"message\":\"Order placed successfully\",\"data\":{\"type\":\"order\",\"id\":1,\"attributes\":{\"number\":\"01HXYZ\",\"guest_name\":\"Jane Doe\",\"guest_email\":\"jane@example.com\",\"guest_phone\":\"01001234567\",\"status\":\"pending\",\"subtotal\":200,\"shipping_amount\":0,\"total\":200}}}", "name": "" }, { "header": [], "code": 422, "body": "{\"errors\":[{\"status\":\"422\",\"code\":\"validation.insufficient_stock\",\"detail\":\"The submitted value is invalid.\",\"meta\":{\"field\":\"items\"}}]}", "name": "Validation failed (empty items, inactive variant, insufficient stock, or foreign-store variant)." } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "List product option values", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-options\/:productOption_id\/product-option-values", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-options\/:productOption_id\/product-option-values", "variable": [ { "id": "productOption_id", "key": "productOption_id", "value": "1", "description": "The ID of the productOption." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return all product option values." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Product option values retrieved successfully\",\"data\":[{\"type\":\"product_option_value\",\"id\":1,\"attributes\":{\"value\":\"Small\",\"product_option_id\":1},\"relationships\":{\"product_option\":{\"data\":{\"id\":1,\"type\":\"product_option\"}}},\"links\":{\"self\":\"https:\\\/\\\/api.example.com\\\/product-option-values\\\/1\"}}]}", "name": "" } ] }, { "name": "Create product option values", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-option-values", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-option-values" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"product_option_id\":\"architecto\",\"values\":[\"n\"]}" }, "description": "Create multiple product option values for the same option." }, "response": [ { "header": [], "code": 201, "body": "{\"status\":201,\"message\":\"Product option values created successfully\",\"data\":[{\"type\":\"product_option_value\",\"id\":1,\"attributes\":{\"value\":\"Small\",\"product_option_id\":1},\"relationships\":{\"product_option\":{\"type\":\"product_option\",\"id\":1}},\"links\":{\"self\":\"https:\\\/\\\/api.dokio.local\\\/api\\\/v1\\\/product-option-values\\\/1\"}}]}", "name": "" } ] }, { "name": "Display the specified resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-option-values\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-option-values\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the product option value." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update the specified resource in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-option-values\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-option-values\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the product option value." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Delete product option value", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-option-values\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-option-values\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the product option value." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a product option value when it has no related variants." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Product option value deleted successfully\",\"data\":{\"type\":\"product_option_value\",\"id\":1,\"attributes\":{\"value\":\"Small\",\"product_option_id\":1}}}", "name": "" }, { "header": [], "code": 403, "body": "{\"errors\":[{\"status\":\"403\",\"code\":\"product_option_value.forbidden\",\"detail\":\"You are not authorized to delete this product option value\"}]}", "name": "" }, { "header": [], "code": 422, "body": "{\"errors\":[{\"status\":\"422\",\"code\":\"product_option_value.has_variants\",\"detail\":\"Cannot delete product option value because it has related variants\"}]}", "name": "" } ] } ] }, { "name": "Orders", "description": "Vendor order management.", "item": [ { "name": "List orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orders", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orders" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return orders for the authenticated vendor store." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Orders retrieved successfully\",\"data\":[{\"type\":\"order\",\"id\":1,\"attributes\":{\"number\":\"01HXYZ\",\"status\":\"pending\",\"total\":200}}]}", "name": "" } ] }, { "name": "Show order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orders\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orders\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the order." }, { "id": "order", "key": "order", "value": "1", "description": "Order id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return a single store order." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Order retrieved successfully\",\"data\":{\"type\":\"order\",\"id\":1,\"attributes\":{\"number\":\"01HXYZ\",\"status\":\"pending\",\"total\":200}}}", "name": "" } ] }, { "name": "Update order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orders\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orders\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the order." }, { "id": "order", "key": "order", "value": "1", "description": "Order id." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"confirmed\",\"payment_status\":\"paid\",\"shipment_status\":\"shipped\"}" }, "description": "Update order, payment, and\/or shipment status." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Order updated successfully\",\"data\":{\"type\":\"order\",\"id\":1,\"attributes\":{\"number\":\"01HXYZ\",\"status\":\"confirmed\",\"total\":200}}}", "name": "" } ] }, { "name": "Track guest order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orders\/:number", "query": [ { "key": "email", "value": "jane%40example.com", "description": "Guest email used when placing the order.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/orders\/:number?email=jane%40example.com", "variable": [ { "id": "number", "key": "number", "value": "01HXYZ", "description": "Public order number returned at checkout." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\"}" }, "description": "Look up an order by public number and guest email.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Order retrieved successfully\",\"data\":{\"type\":\"order\",\"id\":1,\"attributes\":{\"number\":\"01HXYZ\",\"status\":\"pending\",\"total\":200}}}", "name": "" }, { "header": [], "code": 404, "body": "{\"status\":404,\"message\":\"Order not found\"}", "name": "" } ] } ] }, { "name": "Product Options", "description": "Manage product options.", "item": [ { "name": "List product options", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-options", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-options" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return all product options." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Product options retrieved successfully\",\"data\":[{\"type\":\"product_option\",\"id\":1,\"attributes\":{\"name\":\"Apparel\"}}]}", "name": "" } ] }, { "name": "Create product option", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-options", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-options" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\"}" }, "description": "Create a new product option." }, "response": [ { "header": [], "code": 201, "body": "{\"status\":201,\"message\":\"Product option created successfully\",\"data\":{\"type\":\"product_option\",\"id\":1,\"attributes\":{\"name\":\"Size\"}}}", "name": "" } ] }, { "name": "Display the specified resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-options\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-options\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the product option." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update product option", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-options\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-options\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the product option." }, { "id": "productOption", "key": "productOption", "value": "1", "description": "The product option ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Size\"}" }, "description": "Rename an owned product option. JSON PUT\/PATCH and multipart POST with `_method=PUT` are supported. Identity, store, and related values stay unchanged." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Product option updated successfully\",\"data\":{\"type\":\"product_option\",\"id\":1,\"attributes\":{\"name\":\"Size\"}}}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"This action is unauthorized.\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"errors\":[{\"status\":\"422\",\"code\":\"validation.required\",\"detail\":\"This field is required.\",\"meta\":{\"field\":\"request\"}}]}", "name": "" } ] }, { "name": "Delete product option", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-options\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-options\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the product option." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a product option when it has no related values." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Product option deleted successfully\",\"data\":{\"type\":\"product_option\",\"id\":1,\"attributes\":{\"name\":\"Size\"}}}", "name": "" }, { "header": [], "code": 422, "body": "{\"errors\":[{\"status\":\"422\",\"code\":\"product_option.has_values\",\"detail\":\"Cannot delete product option because it has related values\"}]}", "name": "" } ] } ] }, { "name": "Product Variants", "description": "Manage product variants.", "item": [ { "name": "List product variants", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-variants", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-variants" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return all product variants." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Product variants retrieved successfully\",\"data\":[{\"type\":\"product_variant\",\"id\":1,\"attributes\":{\"name\":\"Small\",\"price\":100,\"stock\":100,\"product_id\":1,\"product_option_id\":1},\"relationships\":{\"product\":{\"data\":{\"id\":1,\"type\":\"product\"}},\"product_option_value\":{\"data\":{\"id\":1,\"type\":\"product_option_value\"}}},\"links\":{\"self\":\"https:\\\/\\\/api.example.com\\\/product-variants\\\/1\"}}]}", "name": "" } ] }, { "name": "Create product variant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-variants", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-variants" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "price", "value": "100", "type": "text", "description": "The price of the product variant. Must be at least 0." }, { "key": "stock", "value": "100", "type": "text", "description": "The stock of the product variant. Must be at least 0." }, { "key": "product_id", "value": "1", "type": "text", "description": "The product ID of the product variant. The id<\/code> of an existing record in the products table." }, { "key": "product_option_value_id", "value": "1", "type": "text", "description": "The product option value ID of the product variant. The id<\/code> of an existing record in the product_option_values table." }, { "key": "sku", "value": "1234567890", "type": "text", "description": "The SKU of the product variant. Must not be greater than 255 characters." }, { "key": "status", "value": "active", "type": "text", "description": "The status of the product variant." }, { "key": "image", "src": [], "type": "file" } ] }, "description": "Create a new product variant." }, "response": [ { "header": [], "code": 201, "body": "{\"status\":201,\"message\":\"Product variant created successfully\",\"data\":{\"type\":\"product_variant\",\"id\":1,\"attributes\":{\"name\":\"Small\",\"price\":100,\"stock\":100,\"product_id\":1,\"product_option_id\":1}}}", "name": "" } ] }, { "name": "Display the specified resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-variants\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-variants\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the product variant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update product variant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-variants\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-variants\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the product variant." }, { "id": "productVariant", "key": "productVariant", "value": "1", "description": "The product variant ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"price\":12500,\"stock\":8,\"sku\":\"TEE-M\",\"status\":\"active\",\"product_option_value_id\":1,\"product_id\":1}" }, "description": "Update supplied fields on an owned product variant. JSON PUT\/PATCH and multipart POST with `_method=PUT` are supported. Omitted fields, including the image, remain unchanged." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Product variant updated successfully\",\"data\":{\"type\":\"product_variant\",\"id\":1,\"attributes\":{\"price\":12500,\"stock\":8,\"sku\":\"TEE-M\",\"status\":\"active\",\"product_id\":1,\"product_option_value_id\":1}}}", "name": "" }, { "header": [], "code": 401, "body": "{\"errors\":[{\"status\":\"401\",\"code\":\"unauthenticated\",\"detail\":\"Unauthenticated.\"}]}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"This action is unauthorized.\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"errors\":[{\"status\":\"422\",\"code\":\"validation.required\",\"detail\":\"This field is required.\",\"meta\":{\"field\":\"request\"}}]}", "name": "" } ] }, { "name": "Delete product variant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/product-variants\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/product-variants\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the product variant." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a product variant when it is not used in any orders." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Product variant deleted successfully\",\"data\":{\"type\":\"product_variant\",\"id\":1,\"attributes\":{\"stock\":100,\"price\":100}}}", "name": "" }, { "header": [], "code": 403, "body": "{\"errors\":[{\"status\":\"403\",\"code\":\"product_variant.forbidden\",\"detail\":\"You are not authorized to delete this product variant\"}]}", "name": "" }, { "header": [], "code": 422, "body": "{\"errors\":[{\"status\":\"422\",\"code\":\"product_variant.used_in_orders\",\"detail\":\"Cannot delete product variant because it is used in orders\"}]}", "name": "" } ] } ] }, { "name": "Storefront rows", "description": "Public homepage sections for a store.", "item": [ { "name": "List public store rows", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/stores\/:store_slug\/rows", "query": [], "raw": "{{baseUrl}}\/api\/v1\/stores\/:store_slug\/rows", "variable": [ { "id": "store_slug", "key": "store_slug", "value": "backs", "description": "The slug of the store." }, { "id": "store", "key": "store", "value": "acme-fashion", "description": "The store slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return visible homepage sections for a store slug, with slides. Hidden and unknown types are omitted.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Rows retrieved successfully\",\"data\":[{\"type\":\"store_row\",\"id\":12,\"attributes\":{\"type\":\"hero_slider\",\"position\":1,\"isVisible\":true,\"settings\":{\"autoplay\":true,\"interval\":5000,\"height\":\"large\",\"overlay\":\"dark\"}},\"includes\":{\"slides\":[]}}]}", "name": "" } ] }, { "name": "List store rows", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/store\/rows", "query": [], "raw": "{{baseUrl}}\/api\/v1\/store\/rows" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return every homepage section for the authenticated merchant store, including hidden rows and slides." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Rows retrieved successfully\",\"data\":[{\"type\":\"store_row\",\"id\":12,\"attributes\":{\"type\":\"hero_slider\",\"position\":1,\"isVisible\":true,\"settings\":{\"autoplay\":true,\"interval\":5000,\"height\":\"large\",\"overlay\":\"dark\"},\"createdAt\":\"2026-09-10T00:00:00.000000Z\",\"updatedAt\":\"2026-09-10T00:00:00.000000Z\"},\"relationships\":{\"store\":{\"data\":{\"type\":\"store\",\"id\":1}},\"slides\":{\"data\":[]}},\"includes\":{\"slides\":[]}}]}", "name": "" } ] }, { "name": "Create store row", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/store\/rows", "query": [], "raw": "{{baseUrl}}\/api\/v1\/store\/rows" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"banner\",\"settings\":{\"heading\":\"Summer\",\"autoplay\":false,\"interval\":1,\"height\":\"medium\",\"overlay\":\"dark\",\"limit\":4,\"message\":\"g\",\"alt\":\"z\",\"link\":\"m\",\"productIds\":[16],\"categoryIds\":[16]}}" }, "description": "Append a supported homepage section to the authenticated merchant store." }, "response": [ { "header": [], "code": 201, "body": "{\"status\":201,\"message\":\"Row created successfully\",\"data\":{\"type\":\"store_row\",\"id\":19,\"attributes\":{\"type\":\"banner\",\"position\":5,\"isVisible\":false,\"settings\":{\"heading\":\"Summer\",\"alt\":\"\",\"link\":\"\\\/products\",\"image\":null}}}}", "name": "" } ] }, { "name": "Reorder store rows", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/store\/rows\/reorder", "query": [], "raw": "{{baseUrl}}\/api\/v1\/store\/rows\/reorder" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"rows\":[{\"id\":12,\"position\":1},{\"id\":8,\"position\":2}]}" }, "description": "Rewrite every homepage section position for the authenticated store. The body must list every current row exactly once." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Rows reordered successfully\",\"data\":[]}", "name": "" } ] }, { "name": "Update store row", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/store\/rows\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/store\/rows\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the row." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"is_visible\":true,\"settings\":{\"heading\":\"Our picks\",\"limit\":8,\"productIds\":[14,9],\"autoplay\":true,\"interval\":1,\"height\":\"large\",\"overlay\":\"dark\",\"message\":\"n\",\"alt\":\"g\",\"link\":\"z\",\"categoryIds\":[16]}}" }, "description": "Update visibility or settings for one homepage section. Type cannot change. Banner images are uploaded as `image`, not as `settings.image`." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Row updated successfully\",\"data\":{\"type\":\"store_row\",\"id\":12,\"attributes\":{\"type\":\"featured_products\",\"isVisible\":true,\"settings\":{\"limit\":8,\"heading\":\"Our picks\",\"productIds\":[14,9]}}}}", "name": "" } ] }, { "name": "Delete store row", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/store\/rows\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/store\/rows\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the row." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a homepage section, its slides, and unused uploaded images." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Row deleted successfully\",\"data\":[]}", "name": "" } ] } ] }, { "name": "Storefront slides", "description": "Manage slides for homepage slider sections.", "item": [ { "name": "List slides", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/store\/rows\/:row_id\/slides", "query": [], "raw": "{{baseUrl}}\/api\/v1\/store\/rows\/:row_id\/slides", "variable": [ { "id": "row_id", "key": "row_id", "value": "1", "description": "The ID of the row." }, { "id": "row", "key": "row", "value": "12", "description": "The homepage section id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return slides for one homepage section, ordered by position then id." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Slides retrieved successfully\",\"data\":[{\"type\":\"store_slide\",\"id\":3,\"attributes\":{\"position\":1,\"title\":\"Summer\",\"subtitle\":\"Sale\",\"image\":\"https:\\\/\\\/api.example.com\\\/storage\\\/store_row\\\/slide.jpg\",\"link\":\"\\\/products\",\"settings\":{\"cta_text\":\"Shop\"}}}]}", "name": "" } ] }, { "name": "Create slide", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/store\/rows\/:row_id\/slides", "query": [], "raw": "{{baseUrl}}\/api\/v1\/store\/rows\/:row_id\/slides", "variable": [ { "id": "row_id", "key": "row_id", "value": "1", "description": "The ID of the row." }, { "id": "row", "key": "row", "value": "12", "description": "The homepage section id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "Summer", "type": "text", "description": "Optional slide title, max 80 characters. Must not be greater than 80 characters." }, { "key": "subtitle", "value": "Sale", "type": "text", "description": "Optional slide subtitle, max 160 characters. Must not be greater than 160 characters." }, { "key": "link", "value": "\/products", "type": "text", "description": "http(s) URL or a single-leading-slash in-store path. Must not be greater than 2048 characters." }, { "key": "cta_text", "value": "Shop", "type": "text", "description": "Optional button label, max 40 characters. Must not be greater than 40 characters." }, { "key": "settings[cta_text]", "value": "b", "type": "text", "description": "" }, { "key": "image", "src": [], "type": "file" } ] }, "description": "Add a slide to a slider section. Image is required. Non-slider types return 422." }, "response": [ { "header": [], "code": 201, "body": "{\"status\":201,\"message\":\"Slide created successfully\",\"data\":{\"type\":\"store_slide\",\"id\":3,\"attributes\":{\"position\":1,\"title\":\"Summer\",\"image\":\"https:\\\/\\\/api.example.com\\\/storage\\\/store_row\\\/slide.jpg\",\"link\":\"\\\/products\",\"settings\":{\"cta_text\":\"Shop\"}}}}", "name": "" } ] }, { "name": "Reorder slides", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/store\/rows\/:row_id\/slides\/reorder", "query": [], "raw": "{{baseUrl}}\/api\/v1\/store\/rows\/:row_id\/slides\/reorder", "variable": [ { "id": "row_id", "key": "row_id", "value": "1", "description": "The ID of the row." }, { "id": "row", "key": "row", "value": "12", "description": "The homepage section id." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slides\":[{\"id\":3,\"position\":1},{\"id\":4,\"position\":2}]}" }, "description": "Rewrite every slide position for one section. The body must list every current slide of that row exactly once." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Slides reordered successfully\",\"data\":[]}", "name": "" } ] }, { "name": "Update slide", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/store\/slides\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/store\/slides\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the slide." }, { "id": "slide", "key": "slide", "value": "3", "description": "The slide id." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Updated\",\"subtitle\":\"Sale\",\"link\":\"\\\/products\",\"cta_text\":\"Shop\",\"settings\":{\"cta_text\":\"b\"}}" }, "description": "Update slide copy or replace its image. Omitted image is kept. Null may clear title, subtitle, link, and cta_text." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Slide updated successfully\",\"data\":{\"type\":\"store_slide\",\"id\":3,\"attributes\":{\"title\":\"Updated\",\"image\":\"https:\\\/\\\/api.example.com\\\/storage\\\/store_row\\\/slide.jpg\"}}}", "name": "" } ] }, { "name": "Delete slide", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/store\/slides\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/store\/slides\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the slide." }, { "id": "slide", "key": "slide", "value": "3", "description": "The slide id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a slide and its unused image after the record is removed." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":200,\"message\":\"Slide deleted successfully\",\"data\":[]}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }