{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/bazaarspot-api.test" } ], "info": { "name": "Bazaar Spot Backend API Documentation", "_postman_id": "c4e61e7f-d826-43a0-95e9-39b5c85759b7", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Authentication", "description": "", "item": [ { "name": "Token Authentication", "description": "", "item": [ { "name": "Register", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/register", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/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\",\"device_name\":\"ios-app\",\"profile\":{\"handle\":\"jane_doe\",\"display_name\":\"Jane Doe\",\"bio\":\"architecto\",\"avatar_url\":\"http:\\\/\\\/www.bailey.biz\\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\"},\"referral_code\":\"AbCdEfGhIjKlMnOpQrStUv\"}" }, "description": "Create a new account and issue a Sanctum bearer token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"\",\"type\":\"users\",\"attributes\":{\"name\":\"Mittie Considine\",\"email\":\"lexus42@example.com\",\"email_verified_at\":\"2026-07-06T10:01:48+00:00\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}},\"meta\":{\"token\":\"1|example-token\",\"token_type\":\"Bearer\",\"expires_at\":null}}", "name": "Registration succeeded." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"email\":[\"The email has already been taken.\"]}}", "name": "Validation failed." } ] }, { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/login", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/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\",\"device_name\":\"ios-app\"}" }, "description": "Authenticate a user and issue a Sanctum bearer token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"users\",\"attributes\":{\"name\":\"Viva Marquardt\",\"email\":\"hirthe.theo@example.com\",\"email_verified_at\":\"2026-07-06T10:01:48+00:00\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}},\"meta\":{\"token\":\"1|example-token\",\"token_type\":\"Bearer\",\"expires_at\":null}}", "name": "Login succeeded." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"email\":[\"The provided credentials are incorrect.\"]}}", "name": "Credentials were invalid." } ] }, { "name": "Get Current User", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/me", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return the authenticated user for the current bearer token." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"users\",\"attributes\":{\"name\":\"Morgan Hirthe\",\"email\":\"dare.emelie@example.com\",\"email_verified_at\":\"2026-07-06T10:01:48+00:00\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Authenticated user profile." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoke the current Sanctum token." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Token revoked." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." } ] }, { "name": "List Tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/tokens", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/tokens" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List personal access tokens for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"1\",\"type\":\"personal-access-tokens\",\"attributes\":{\"name\":\"ios-app\",\"abilities\":[\"auth:me\",\"auth:logout\"],\"last_used_at\":null,\"expires_at\":\"2026-02-24T12:00:00+00:00\",\"created_at\":\"2026-02-23T12:00:00+00:00\",\"updated_at\":\"2026-02-23T12:00:00+00:00\",\"is_current\":true}}]}", "name": "Token list payload." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing required ability." } ] }, { "name": "Revoke All Tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/tokens", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/tokens" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoke all personal access tokens for the authenticated user." }, "response": [ { "header": [], "code": 204, "body": null, "name": "All tokens revoked." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing required ability." } ] }, { "name": "Revoke Token", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/tokens\/:token_id", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/tokens\/:token_id", "variable": [ { "id": "token_id", "key": "token_id", "value": "42", "description": "Personal access token id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Revoke one personal access token owned by the authenticated user." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Token revoked." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Token not found.\"}", "name": "Token does not belong to current user or no longer exists." } ] } ] }, { "name": "Registration", "description": "", "item": [ { "name": "Registration Policy", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/registration-policy", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/registration-policy" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return the current referral requirement for registration.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"referral_required\":false}", "name": "Registration policy." } ] } ] }, { "name": "Password Reset", "description": "", "item": [ { "name": "Request Password Reset", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/password\/forgot", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/password\/forgot" }, "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 link to the provided email if an account exists.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"If the account exists, a password reset link has been sent.\"}", "name": "Password reset request accepted." } ] }, { "name": "Reset Password", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/password\/reset", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/password\/reset" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"reset-token-value\",\"email\":\"jane@example.com\",\"password\":\"new-password123\",\"password_confirmation\":\"new-password123\"}" }, "description": "Reset the user password using a valid reset token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Your password has been reset.\"}", "name": "Password reset succeeded." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"email\":[\"This password reset token is invalid.\"]}}", "name": "Reset token or payload was invalid." } ] }, { "name": "Read Reset Token Payload", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/password\/reset\/:token", "query": [ { "key": "email", "value": "jane@example.com", "description": "Account email from the reset link.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/auth\/password\/reset\/:token?email=jane@example.com", "variable": [ { "id": "token", "key": "token", "value": "reset-token-value", "description": "Password reset token from reset link." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return reset token and email payload for API clients handling email reset links.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"token\":\"reset-token-value\",\"email\":\"jane@example.com\"}", "name": "Reset payload data." } ] } ] }, { "name": "Email Verification", "description": "", "item": [ { "name": "Verify Email", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/email\/verify\/:id\/:hash", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/email\/verify\/:id\/:hash", "variable": [ { "id": "id", "key": "id", "value": "01HZX3W3T4J8Q57XNZD5BPHJ92", "description": "User ULID from the signed verification link." }, { "id": "hash", "key": "hash", "value": "8c4f4370e5db9b5be6d0f4c95495f49f998fa32a", "description": "SHA-1 hash of the email from the signed verification link." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Verify a user email using the signed verification link parameters.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Email verified successfully.\"}", "name": "Email was verified." }, { "header": [], "code": 403, "body": "{\"message\":\"Invalid verification link.\"}", "name": "Signed URL was invalid, expired, or mismatched." } ] }, { "name": "Send Verification Email", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/auth\/email\/verification-notification", "query": [], "raw": "{{baseUrl}}\/v1\/auth\/email\/verification-notification" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Send (or resend) an email verification link to the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Verification link sent.\"}", "name": "Verification email queued\/sent." }, { "header": [], "code": 200, "body": "{\"message\":\"Email is already verified.\"}", "name": "User already verified." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." } ] } ] } ] }, { "name": "Categories", "description": "", "item": [ { "name": "List Categories", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/categories", "query": [], "raw": "{{baseUrl}}\/v1\/categories" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List categories ordered for client-side hierarchy rendering.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"categories\",\"attributes\":{\"name\":\"Eius Et\",\"slug\":\"eius-et\",\"parent_id\":null,\"path\":\"eius-et\",\"category_level\":1,\"is_last\":true}},{\"id\":\"\",\"type\":\"categories\",\"attributes\":{\"name\":\"Animi Quos\",\"slug\":\"animi-quos\",\"parent_id\":null,\"path\":\"animi-quos\",\"category_level\":1,\"is_last\":true}}]}", "name": "Category list." } ] } ] }, { "name": "Collections", "description": "", "item": [ { "name": "List Collections", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/collections", "query": [ { "key": "filter[search]", "value": "summer", "description": "Search by name, slug, or description.", "disabled": false }, { "key": "filter[slug]", "value": "summer-picks", "description": "Filter by exact collection slug.", "disabled": false }, { "key": "filter[owner_profile_id]", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "Filter collections owned by this profile ULID.", "disabled": false }, { "key": "filter[shared_with_profile_id]", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "Filter collections shared with this profile ULID.", "disabled": false }, { "key": "filter[item_id]", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "Filter collections containing this item ULID.", "disabled": false }, { "key": "filter[shop_id]", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "Filter collections containing this shop ULID.", "disabled": false }, { "key": "filter[visibility]", "value": "Public", "description": "Filter by collection visibility.", "disabled": false }, { "key": "filter[contents]", "value": "items,shops", "description": "Comma-separated contents to match with OR semantics.", "disabled": false }, { "key": "filter[min_entries]", "value": "1", "description": "Minimum combined item and shop entries.", "disabled": false }, { "key": "filter[max_entries]", "value": "10", "description": "Maximum combined item and shop entries.", "disabled": false }, { "key": "sort", "value": "-created_at", "description": "Sort column. Prefix with `-` for descending.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of collections per page (1-100).", "disabled": false }, { "key": "include", "value": "ownerProfile,sharedWithProfiles,items,shops", "description": "Comma-separated relationships to include: ownerProfile, sharedWithProfiles, items, shops.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/collections?filter[search]=summer&filter[slug]=summer-picks&filter[owner_profile_id]=01ktwg1fhzq1dpagvermfbjzad&filter[shared_with_profile_id]=01ktwg1fhzq1dpagvermfbjzad&filter[item_id]=01ktwg1fhzq1dpagvermfbjzad&filter[shop_id]=01ktwg1fhzq1dpagvermfbjzad&filter[visibility]=Public&filter[contents]=items,shops&filter[min_entries]=1&filter[max_entries]=10&sort=-created_at&per_page=20&include=ownerProfile,sharedWithProfiles,items,shops" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List collections with filtering, sorting, pagination, and optional relationship includes.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"collections\",\"attributes\":{\"name\":\"Dolorem Mollitia Deleniti\",\"slug\":\"dolorem-mollitia-deleniti\",\"description\":\"Odit quia officia est dignissimos neque blanditiis odio.\",\"visibility\":\"Only me\",\"items_count\":0,\"shops_count\":0,\"preview_image_urls\":[],\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}},{\"id\":\"\",\"type\":\"collections\",\"attributes\":{\"name\":\"Modi Rerum Ex\",\"slug\":\"modi-rerum-ex\",\"description\":\"Assumenda et tenetur ab reiciendis quia.\",\"visibility\":\"Only me\",\"items_count\":0,\"shops_count\":0,\"preview_image_urls\":[],\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated collection list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." } ] }, { "name": "Show Collection", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/collections\/:id", "query": [ { "key": "include", "value": "ownerProfile,items,shops", "description": "Comma-separated relationships to include: ownerProfile, sharedWithProfiles, items, shops.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/collections\/:id?include=ownerProfile,items,shops", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the collection." }, { "id": "collection", "key": "collection", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "The ULID of the collection." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch a single collection by ULID.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"collections\",\"attributes\":{\"name\":\"Quos Velit Et\",\"slug\":\"quos-velit-et\",\"description\":\"Sunt nihil accusantium harum mollitia.\",\"visibility\":\"Only me\",\"items_count\":0,\"shops_count\":0,\"preview_image_urls\":[],\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Collection details." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Collection could not be found." } ] }, { "name": "Create Collection", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/collections", "query": [], "raw": "{{baseUrl}}\/v1\/collections" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Summer Picks\",\"slug\":\"summer-picks\",\"description\":\"Curated summer shops and items.\",\"visibility\":\"Only me\",\"owner_profile_id\":\"01ktwg1fhzq1dpagvermfbjzad\",\"shared_with_profile_ids\":[\"01ktwg1fhzq1dpagvermfbjzad\"],\"item_ids\":[\"01ktwg1fhzq1dpagvermfbjzad\"],\"shop_ids\":[\"01ktwg1fhzq1dpagvermfbjzad\"]}" }, "description": "Create a collection and optionally attach items and shops to it." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"\",\"type\":\"collections\",\"attributes\":{\"name\":\"Et Et Modi\",\"slug\":\"et-et-modi\",\"description\":\"Nostrum omnis autem et consequatur aut.\",\"visibility\":\"Only me\",\"items_count\":0,\"shops_count\":0,\"preview_image_urls\":[],\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Collection created." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Update Collection", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/collections\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/collections\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the collection." }, { "id": "collection", "key": "collection", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "The ULID of the collection." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Updated Summer Picks\",\"slug\":\"updated-summer-picks\",\"description\":\"Updated collection description.\",\"visibility\":\"Friends\",\"owner_profile_id\":\"01ktwg1fhzq1dpagvermfbjzad\",\"shared_with_profile_ids\":[\"01ktwg1fhzq1dpagvermfbjzad\"],\"item_ids\":[\"01ktwg1fhzq1dpagvermfbjzad\"],\"shop_ids\":[\"01ktwg1fhzq1dpagvermfbjzad\"]}" }, "description": "Patch a collection by ULID and optionally replace its item and shop assignments." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"collections\",\"attributes\":{\"name\":\"Ipsum Nostrum Omnis\",\"slug\":\"ipsum-nostrum-omnis\",\"description\":\"Et consequatur aut dolores enim.\",\"visibility\":\"Only me\",\"items_count\":0,\"shops_count\":0,\"preview_image_urls\":[],\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Collection updated." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Collection could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Delete Collection", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/collections\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/collections\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the collection." }, { "id": "collection", "key": "collection", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "The ULID of the collection." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a collection by ULID." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Collection deleted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Collection could not be found." } ] } ] }, { "name": "Comments", "description": "", "item": [ { "name": "List Comments", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/comments", "query": [ { "key": "filter[search]", "value": "great update", "description": "Search by comment body.", "disabled": false }, { "key": "filter[status]", "value": "published", "description": "Filter by comment status.", "disabled": false }, { "key": "filter[commentable_type]", "value": "post", "description": "Filter by commentable type alias.", "disabled": false }, { "key": "filter[commentable_id]", "value": "01jabcxyz1234567890abcdefg", "description": "Filter by commentable ULID.", "disabled": false }, { "key": "filter[author_id]", "value": "01jabcxyz1234567890abcdefg", "description": "Filter by author ULID.", "disabled": false }, { "key": "filter[parent_comment_id]", "value": "01jabcxyz1234567890abcdefg", "description": "Filter by parent comment ULID.", "disabled": false }, { "key": "filter[published_from]", "value": "2026-04-01T00:00:00Z", "description": "Include comments published on or after this ISO 8601 timestamp.", "disabled": false }, { "key": "filter[published_until]", "value": "2026-04-30T23:59:59Z", "description": "Include comments published on or before this ISO 8601 timestamp.", "disabled": false }, { "key": "sort", "value": "-published_at", "description": "Sort column. Prefix with `-` for descending.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of comments per page (1-100).", "disabled": false }, { "key": "include", "value": "author,commentable", "description": "Comma-separated relationships to include: author, commentable, parentComment.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/comments?filter[search]=great update&filter[status]=published&filter[commentable_type]=post&filter[commentable_id]=01jabcxyz1234567890abcdefg&filter[author_id]=01jabcxyz1234567890abcdefg&filter[parent_comment_id]=01jabcxyz1234567890abcdefg&filter[published_from]=2026-04-01T00:00:00Z&filter[published_until]=2026-04-30T23:59:59Z&sort=-published_at&per_page=20&include=author,commentable" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List comments with filtering, sorting, pagination, and optional relationship includes." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"comments\",\"attributes\":{\"body\":\"Adipisci quidem nostrum qui commodi incidunt iure.\",\"status\":\"draft\",\"like_count\":0,\"reply_count\":0,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}},{\"id\":\"\",\"type\":\"comments\",\"attributes\":{\"body\":\"Id aspernatur consectetur id a consectetur assumenda.\",\"status\":\"draft\",\"like_count\":0,\"reply_count\":0,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated comment list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." } ] }, { "name": "Show Comment", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/comments\/:id", "query": [ { "key": "include", "value": "author,parentComment", "description": "Comma-separated relationships to include: author, commentable, parentComment.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/comments\/:id?include=author,parentComment", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the comment." }, { "id": "comment", "key": "comment", "value": "01jabcxyz1234567890abcdefg", "description": "The ULID of the comment." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch a single comment by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"comments\",\"attributes\":{\"body\":\"Adipisci quidem nostrum qui commodi incidunt iure.\",\"status\":\"draft\",\"like_count\":0,\"reply_count\":0,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Comment details." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Comment could not be found." } ] }, { "name": "Create Comment", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/comments", "query": [], "raw": "{{baseUrl}}\/v1\/comments" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"commentable_type\":\"post\",\"commentable_id\":\"01jabcxyz1234567890abcdefg\",\"parent_comment_id\":\"01jabcxyz1234567890abcdefg\",\"body\":\"This launch looks solid.\",\"status\":\"draft\",\"like_count\":0,\"reply_count\":0,\"published_at\":\"2026-04-17T18:45:00Z\"}" }, "description": "Create a new comment for the authenticated user." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"\",\"type\":\"comments\",\"attributes\":{\"body\":\"Adipisci quidem nostrum qui commodi incidunt iure.\",\"status\":\"draft\",\"like_count\":0,\"reply_count\":0,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Comment created." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Update Comment", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/comments\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/comments\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the comment." }, { "id": "comment", "key": "comment", "value": "01jabcxyz1234567890abcdefg", "description": "The ULID of the comment." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"commentable_type\":\"post\",\"commentable_id\":\"01jabcxyz1234567890abcdefg\",\"parent_comment_id\":\"01jabcxyz1234567890abcdefg\",\"body\":\"Edited comment text.\",\"status\":\"published\",\"like_count\":2,\"reply_count\":1,\"published_at\":\"2026-04-17T18:45:00Z\"}" }, "description": "Patch a comment by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"comments\",\"attributes\":{\"body\":\"Adipisci quidem nostrum qui commodi incidunt iure.\",\"status\":\"draft\",\"like_count\":0,\"reply_count\":0,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Comment updated." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Comment could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Delete Comment", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/comments\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/comments\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the comment." }, { "id": "comment", "key": "comment", "value": "01jabcxyz1234567890abcdefg", "description": "The ULID of the comment." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a comment by ID." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Comment deleted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Comment could not be found." } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "GET v1\/home-feed", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/home-feed", "query": [], "raw": "{{baseUrl}}\/v1\/home-feed" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/home-feed\/sections\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/home-feed\/sections\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/home-feed\/sections\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the section." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/discover-shops", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/discover-shops", "query": [], "raw": "{{baseUrl}}\/v1\/discover-shops" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/discover-shops\/sections\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/discover-shops\/sections\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/discover-shops\/sections\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the section." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/discover-community-collections", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/discover-community-collections", "query": [], "raw": "{{baseUrl}}\/v1\/discover-community-collections" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/discover-community-collections\/sections\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/discover-community-collections\/sections\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/discover-community-collections\/sections\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the section." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/categories\/{category_id}\/feed", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/categories\/:category_id\/feed", "query": [], "raw": "{{baseUrl}}\/v1\/categories\/:category_id\/feed", "variable": [ { "id": "category_id", "key": "category_id", "value": "architecto", "description": "The ID of the category." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/categories\/{category_id}\/feed\/sections\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/categories\/:category_id\/feed\/sections\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/categories\/:category_id\/feed\/sections\/:id", "variable": [ { "id": "category_id", "key": "category_id", "value": "architecto", "description": "The ID of the category." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the section." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/admin\/feed-sections", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/feed-sections", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/feed-sections" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/admin\/feed-sections", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/feed-sections", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/feed-sections" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/admin\/feed-sections\/reorder", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/feed-sections\/reorder", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/feed-sections\/reorder" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PATCH v1\/admin\/feed-sections\/{section_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/feed-sections\/:section_id", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/feed-sections\/:section_id", "variable": [ { "id": "section_id", "key": "section_id", "value": "architecto", "description": "The ID of the section." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE v1\/admin\/feed-sections\/{section_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/feed-sections\/:section_id", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/feed-sections\/:section_id", "variable": [ { "id": "section_id", "key": "section_id", "value": "architecto", "description": "The ID of the section." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/admin\/curated-feed-lists", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/curated-feed-lists", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/curated-feed-lists" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/admin\/curated-feed-lists", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/curated-feed-lists", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/curated-feed-lists" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PATCH v1\/admin\/curated-feed-lists\/{list_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/curated-feed-lists\/:list_id", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/curated-feed-lists\/:list_id", "variable": [ { "id": "list_id", "key": "list_id", "value": "architecto", "description": "The ID of the list." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE v1\/admin\/curated-feed-lists\/{list_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/curated-feed-lists\/:list_id", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/curated-feed-lists\/:list_id", "variable": [ { "id": "list_id", "key": "list_id", "value": "architecto", "description": "The ID of the list." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/admin\/curated-feed-lists\/{list_id}\/entries", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/curated-feed-lists\/:list_id\/entries", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/curated-feed-lists\/:list_id\/entries", "variable": [ { "id": "list_id", "key": "list_id", "value": "architecto", "description": "The ID of the list." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/admin\/curated-feed-lists\/{list_id}\/entries", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/curated-feed-lists\/:list_id\/entries", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/curated-feed-lists\/:list_id\/entries", "variable": [ { "id": "list_id", "key": "list_id", "value": "architecto", "description": "The ID of the list." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/admin\/curated-feed-lists\/{list_id}\/entries\/reorder", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/curated-feed-lists\/:list_id\/entries\/reorder", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/curated-feed-lists\/:list_id\/entries\/reorder", "variable": [ { "id": "list_id", "key": "list_id", "value": "architecto", "description": "The ID of the list." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE v1\/admin\/curated-feed-lists\/{list_id}\/entries\/{entry_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/curated-feed-lists\/:list_id\/entries\/:entry_id", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/curated-feed-lists\/:list_id\/entries\/:entry_id", "variable": [ { "id": "list_id", "key": "list_id", "value": "architecto", "description": "The ID of the list." }, { "id": "entry_id", "key": "entry_id", "value": "16", "description": "The ID of the entry." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/admin\/feed-curation-workspaces\/{surface}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/feed-curation-workspaces\/:surface", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/feed-curation-workspaces\/:surface", "variable": [ { "id": "surface", "key": "surface", "value": "home", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/admin\/feed-curation-capabilities\/{surface}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/feed-curation-capabilities\/:surface", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/feed-curation-capabilities\/:surface", "variable": [ { "id": "surface", "key": "surface", "value": "home", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PUT v1\/admin\/feed-curation-workspaces\/{surface}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/feed-curation-workspaces\/:surface", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/feed-curation-workspaces\/:surface", "variable": [ { "id": "surface", "key": "surface", "value": "home", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/admin\/feed-curation-workspaces\/{surface}\/preview", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/feed-curation-workspaces\/:surface\/preview", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/feed-curation-workspaces\/:surface\/preview", "variable": [ { "id": "surface", "key": "surface", "value": "home", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/admin\/section-performance", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/section-performance", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/section-performance" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/admin\/outbound-clicks", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/outbound-clicks", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/outbound-clicks" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/admin\/curator-token\/rotate", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/curator-token\/rotate", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/curator-token\/rotate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/admin\/curators", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/curators", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/curators" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE v1\/admin\/curators\/{curator_id}\/tokens\/{tokenId}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/admin\/curators\/:curator_id\/tokens\/:tokenId", "query": [], "raw": "{{baseUrl}}\/v1\/admin\/curators\/:curator_id\/tokens\/:tokenId", "variable": [ { "id": "curator_id", "key": "curator_id", "value": "architecto", "description": "The ID of the curator." }, { "id": "tokenId", "key": "tokenId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/internal\/analytics\/entities", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/analytics\/entities", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/analytics\/entities" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PUT v1\/internal\/analytics\/current-metrics", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/analytics\/current-metrics", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/analytics\/current-metrics" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/internal\/outbound-clicks\/targets\/{targetType}\/{targetId}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/outbound-clicks\/targets\/:targetType\/:targetId", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/outbound-clicks\/targets\/:targetType\/:targetId", "variable": [ { "id": "targetType", "key": "targetType", "value": "architecto", "description": "" }, { "id": "targetId", "key": "targetId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/internal\/recommendations\/catalog", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/recommendations\/catalog", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/recommendations\/catalog" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/internal\/ingestion\/shops:onboard", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/ingestion\/shops:onboard", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/ingestion\/shops:onboard" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/internal\/authority\/shops", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/authority\/shops", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/authority\/shops" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/internal\/authority\/shop-catalog", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/authority\/shop-catalog", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/authority\/shop-catalog" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/internal\/authority\/shop-catalog\/{shop_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/authority\/shop-catalog\/:shop_id", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/authority\/shop-catalog\/:shop_id", "variable": [ { "id": "shop_id", "key": "shop_id", "value": "architecto", "description": "The ID of the shop." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/internal\/authority\/publications", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/authority\/publications", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/authority\/publications" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PUT v1\/internal\/authority\/publications\/{authorityPublication_id}\/scores", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/authority\/publications\/:authorityPublication_id\/scores", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/authority\/publications\/:authorityPublication_id\/scores", "variable": [ { "id": "authorityPublication_id", "key": "authorityPublication_id", "value": "architecto", "description": "The ID of the authorityPublication." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/internal\/authority\/publications\/{authorityPublication_id}\/activate", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/authority\/publications\/:authorityPublication_id\/activate", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/authority\/publications\/:authorityPublication_id\/activate", "variable": [ { "id": "authorityPublication_id", "key": "authorityPublication_id", "value": "architecto", "description": "The ID of the authorityPublication." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/internal\/bot\/identities\/resolve", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/bot\/identities\/resolve", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/bot\/identities\/resolve" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/internal\/bot\/link-challenges\/verify", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/bot\/link-challenges\/verify", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/bot\/link-challenges\/verify" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/internal\/bot\/link-challenges\/complete", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/bot\/link-challenges\/complete", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/bot\/link-challenges\/complete" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/internal\/bot\/shop-favorites", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/bot\/shop-favorites", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/bot\/shop-favorites" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/internal\/bot\/shops\/{shop_id}\/website-discovery-results", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/bot\/shops\/:shop_id\/website-discovery-results", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/bot\/shops\/:shop_id\/website-discovery-results", "variable": [ { "id": "shop_id", "key": "shop_id", "value": "architecto", "description": "The ID of the shop." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/internal\/bot\/shops\/{shop_id}\/website-metadata-results", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/bot\/shops\/:shop_id\/website-metadata-results", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/bot\/shops\/:shop_id\/website-metadata-results", "variable": [ { "id": "shop_id", "key": "shop_id", "value": "architecto", "description": "The ID of the shop." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/internal\/bot\/item-bookmarks", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/bot\/item-bookmarks", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/bot\/item-bookmarks" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/internal\/bot\/resources\/resolve-url", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/bot\/resources\/resolve-url", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/bot\/resources\/resolve-url" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/internal\/bot\/identities\/{identity_id}\/saved-resources", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/bot\/identities\/:identity_id\/saved-resources", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/bot\/identities\/:identity_id\/saved-resources", "variable": [ { "id": "identity_id", "key": "identity_id", "value": "architecto", "description": "The ID of the identity." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/me\/channel-identities", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/channel-identities", "query": [], "raw": "{{baseUrl}}\/v1\/me\/channel-identities" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/me\/channel-link-challenges", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/channel-link-challenges", "query": [], "raw": "{{baseUrl}}\/v1\/me\/channel-link-challenges" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE v1\/me\/channel-identities\/{identity_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/channel-identities\/:identity_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/channel-identities\/:identity_id", "variable": [ { "id": "identity_id", "key": "identity_id", "value": "architecto", "description": "The ID of the identity." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/shop-portal\/auth\/login", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/auth\/login", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/auth\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/shop-portal\/session", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/session", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/session" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/shop-portal\/auth\/logout", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/shop-portal\/sessions", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/sessions", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/sessions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE v1\/shop-portal\/sessions\/{sessionId}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/sessions\/:sessionId", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/sessions\/:sessionId", "variable": [ { "id": "sessionId", "key": "sessionId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/shop-portal\/shop", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/shop", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/shop" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PATCH v1\/shop-portal\/shop", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/shop", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/shop" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/shop-portal\/items", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/items", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/items" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/shop-portal\/items\/{item}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/items\/:item", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/items\/:item", "variable": [ { "id": "item", "key": "item", "value": "architecto", "description": "The item." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PATCH v1\/shop-portal\/items\/{item}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/items\/:item", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/items\/:item", "variable": [ { "id": "item", "key": "item", "value": "architecto", "description": "The item." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/shop-portal\/items\/{item}\/overrides\/{field}\/reset", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/items\/:item\/overrides\/:field\/reset", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/items\/:item\/overrides\/:field\/reset", "variable": [ { "id": "item", "key": "item", "value": "architecto", "description": "The item." }, { "id": "field", "key": "field", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/shop-portal\/reviews", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/reviews", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/reviews" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PUT v1\/shop-portal\/reviews\/{review}\/reply", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/reviews\/:review\/reply", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/reviews\/:review\/reply", "variable": [ { "id": "review", "key": "review", "value": "architecto", "description": "The review." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE v1\/shop-portal\/reviews\/{review}\/reply", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/reviews\/:review\/reply", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/reviews\/:review\/reply", "variable": [ { "id": "review", "key": "review", "value": "architecto", "description": "The review." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/shop-portal\/team", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/team", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/team" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST v1\/shop-portal\/team", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/team", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/team" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "DELETE v1\/shop-portal\/team\/{membership}", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/team\/:membership", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/team\/:membership", "variable": [ { "id": "membership", "key": "membership", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/shop-portal\/analytics\/overview", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/analytics\/overview", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/analytics\/overview" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET v1\/shop-portal\/analytics\/items", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shop-portal\/analytics\/items", "query": [], "raw": "{{baseUrl}}\/v1\/shop-portal\/analytics\/items" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "PUT v1\/internal\/analytics\/metric-buckets", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/analytics\/metric-buckets", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/analytics\/metric-buckets" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Internal Analytics", "description": "", "item": [ { "name": "Resolve analytics entities", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/analytics\/entities\/resolve", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/analytics\/entities\/resolve" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Resolve backend entity identifiers for the analytics service." }, "response": [] }, { "name": "Store analytics metric snapshots", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/internal\/analytics\/metric-snapshots", "query": [], "raw": "{{baseUrl}}\/v1\/internal\/analytics\/metric-snapshots" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Upsert calculated feed metric snapshots from the analytics service." }, "response": [] } ] }, { "name": "Items", "description": "", "item": [ { "name": "List Items", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/items", "query": [ { "key": "filter[search]", "value": "sneaker", "description": "Search by name, slug, description, or SKU.", "disabled": false }, { "key": "filter[slug]", "value": "classic-polo-knit", "description": "Filter by exact item slug.", "disabled": false }, { "key": "filter[is_active]", "value": "1", "description": "Filter by active status.", "disabled": false }, { "key": "filter[is_available]", "value": "1", "description": "Filter by availability status.", "disabled": false }, { "key": "filter[shop_id]", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "Filter by shop ULID.", "disabled": false }, { "key": "filter[brand_id]", "value": "", "description": "Filter by brand ID.", "disabled": true }, { "key": "filter[category_id]", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "Filter by category ULID.", "disabled": false }, { "key": "filter[condition]", "value": "new", "description": "Filter by item condition.", "disabled": false }, { "key": "filter[price_min]", "value": "100", "description": "Minimum price (inclusive).", "disabled": false }, { "key": "filter[price_max]", "value": "500", "description": "Maximum price (inclusive).", "disabled": false }, { "key": "sort", "value": "-created_at", "description": "Sort column. Recommended sorting requires authentication and X-Profile-ID.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of items per page (1\u2013100).", "disabled": false }, { "key": "include", "value": "shop,brand", "description": "Comma-separated relationships to include: shop, brand, categories, variants.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/items?filter[search]=sneaker&filter[slug]=classic-polo-knit&filter[is_active]=1&filter[is_available]=1&filter[shop_id]=01ktwg1fhzq1dpagvermfbjzad&filter[brand_id]=&filter[category_id]=01ktwg1fhzq1dpagvermfbjzad&filter[condition]=new&filter[price_min]=100&filter[price_max]=500&sort=-created_at&per_page=20&include=shop,brand" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List items with filtering, sorting, pagination, and optional relationship includes.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"items\",\"attributes\":{\"name\":\"Adipisci Molestias Fugit\",\"slug\":\"adipisci-molestias-fugit\",\"description\":\"Distinctio eum doloremque id aut libero aliquam veniam corporis.\",\"external_url\":null,\"price\":3025.43,\"original_price\":null,\"currency\":\"EGP\",\"sku\":\"NO-351-QI\",\"condition\":\"new\",\"stock_level\":179,\"weight\":null,\"dimensions\":null,\"specifications\":null,\"is_available\":true,\"is_active\":true,\"url\":null,\"featured_image_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/items\\\/01ktwg1fhzq1dpagvermfbjzad\"}},{\"id\":\"\",\"type\":\"items\",\"attributes\":{\"name\":\"Officiis Corporis Nesciunt\",\"slug\":\"officiis-corporis-nesciunt\",\"description\":\"Ratione iure impedit molestiae ut rem.\",\"external_url\":null,\"price\":1962.84,\"original_price\":null,\"currency\":\"EGP\",\"sku\":\"RC-724-VA\",\"condition\":\"new\",\"stock_level\":140,\"weight\":null,\"dimensions\":null,\"specifications\":null,\"is_available\":true,\"is_active\":true,\"url\":null,\"featured_image_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/items\\\/01ktwg1fhzq1dpagvermfbjzad\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated item list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." } ] }, { "name": "Show Item", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/items\/:id", "query": [ { "key": "include", "value": "shop,brand", "description": "Comma-separated relationships to include: shop, brand, categories, variants.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/items\/:id?include=shop,brand", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "The ULID of the item." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch a single item by ULID.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"items\",\"attributes\":{\"name\":\"Eius Et Animi\",\"slug\":\"eius-et-animi\",\"description\":\"Velit et fugiat sunt nihil accusantium.\",\"external_url\":null,\"price\":1513.36,\"original_price\":null,\"currency\":\"EGP\",\"sku\":\"KH-954-WA\",\"condition\":\"new\",\"stock_level\":183,\"weight\":null,\"dimensions\":null,\"specifications\":null,\"is_available\":true,\"is_active\":true,\"url\":null,\"featured_image_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/items\\\/01ktwg1fhzq1dpagvermfbjzad\"}}}", "name": "Item details." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Item could not be found." } ] }, { "name": "Create Item", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/items", "query": [], "raw": "{{baseUrl}}\/v1\/items" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"shop_id\":\"01ktwg1fhzq1dpagvermfbjzad\",\"brand_id\":1,\"name\":\"White Sneakers\",\"slug\":\"white-sneakers\",\"description\":\"Comfortable everyday sneakers.\",\"price\":299.99,\"original_price\":399.99,\"currency\":\"EGP\",\"sku\":\"SNK-WHT-42\",\"condition\":\"new\",\"stock_level\":50,\"weight\":\"0.5kg\",\"dimensions\":\"30x20x10cm\",\"specifications\":{\"color\":\"white\",\"size\":\"42\"},\"is_available\":true,\"is_active\":true}" }, "description": "Create a new item record." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"\",\"type\":\"items\",\"attributes\":{\"name\":\"Aut Adipisci Quidem\",\"slug\":\"aut-adipisci-quidem\",\"description\":\"Qui commodi incidunt iure odit.\",\"external_url\":null,\"price\":568.81,\"original_price\":null,\"currency\":\"EGP\",\"sku\":\"TC-744-PS\",\"condition\":\"new\",\"stock_level\":120,\"weight\":null,\"dimensions\":null,\"specifications\":null,\"is_available\":true,\"is_active\":true,\"url\":null,\"featured_image_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/items\\\/01ktwg1fhzq1dpagvermfbjzad\"}}}", "name": "Item created." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Update Item", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/items\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "The ULID of the item." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"White Leather Sneakers\",\"slug\":\"white-leather-sneakers\",\"description\":\"Updated description.\",\"price\":249.99,\"original_price\":399.99,\"currency\":\"EGP\",\"sku\":\"SNK-WHT-LTH-42\",\"condition\":\"new\",\"stock_level\":30,\"is_available\":true,\"is_active\":true}" }, "description": "Patch an item by ULID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"items\",\"attributes\":{\"name\":\"Nostrum Qui Commodi\",\"slug\":\"nostrum-qui-commodi\",\"description\":\"Iure odit et et modi ipsum nostrum omnis.\",\"external_url\":null,\"price\":2911.47,\"original_price\":null,\"currency\":\"EGP\",\"sku\":\"LD-066-ZS\",\"condition\":\"new\",\"stock_level\":181,\"weight\":null,\"dimensions\":null,\"specifications\":null,\"is_available\":true,\"is_active\":true,\"url\":null,\"featured_image_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/items\\\/01ktwg1fhzq1dpagvermfbjzad\"}}}", "name": "Item updated." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Item could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Delete Item", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/items\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/items\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the item." }, { "id": "item", "key": "item", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "The ULID of the item." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an item by ULID." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Item deleted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Item could not be found." } ] } ] }, { "name": "Notifications", "description": "", "item": [ { "name": "List Notifications", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/notifications", "query": [ { "key": "per_page", "value": "20", "description": "Notifications per page (1-100).", "disabled": false }, { "key": "cursor", "value": "", "description": "Cursor for the next page.", "disabled": true } ], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/notifications?per_page=20&cursor=", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "actingProfile", "key": "actingProfile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the acting profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List the acting profile's notifications, newest first, with cursor pagination." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"notifications\",\"attributes\":{\"type\":\"friend_request.received\",\"message\":\"Clara Cronin V sent you a friend request.\",\"target_url\":\"\\\/friends\\\/requests\",\"actor_name\":\"Clara Cronin V\",\"actor_handle\":\"wleuschke\",\"actor_avatar_url\":null,\"context\":[],\"read_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\"}},{\"id\":\"\",\"type\":\"notifications\",\"attributes\":{\"type\":\"friend_request.received\",\"message\":\"Dr. Raleigh Kreiger sent you a friend request.\",\"target_url\":\"\\\/friends\\\/requests\",\"actor_name\":\"Dr. Raleigh Kreiger\",\"actor_handle\":\"oklocko\",\"actor_avatar_url\":null,\"context\":[],\"read_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated notification list." } ] }, { "name": "Unread Notification Count", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/notifications\/unread-count", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/notifications\/unread-count", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "actingProfile", "key": "actingProfile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the acting profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return the number of unread notifications for the acting profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"unread_count\":3}}", "name": "Unread count." } ] }, { "name": "Mark Notification Read", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/notifications\/:notification_id\/read", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/notifications\/:notification_id\/read", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "notification_id", "key": "notification_id", "value": "architecto", "description": "The ID of the notification." }, { "id": "actingProfile", "key": "actingProfile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the acting profile." }, { "id": "notification", "key": "notification", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The notification ULID." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mark a single notification as read." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"notifications\",\"attributes\":{\"type\":\"friend_request.received\",\"message\":\"Clara Cronin V sent you a friend request.\",\"target_url\":\"\\\/friends\\\/requests\",\"actor_name\":\"Clara Cronin V\",\"actor_handle\":\"wleuschke\",\"actor_avatar_url\":null,\"context\":[],\"read_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Notification marked read." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Notification does not belong to this profile." } ] }, { "name": "Mark All Notifications Read", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/notifications\/read-all", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/notifications\/read-all", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "actingProfile", "key": "actingProfile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the acting profile." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Mark every unread notification for the acting profile as read." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"unread_count\":0}}", "name": "All notifications marked read." } ] } ] }, { "name": "Post Likes", "description": "", "item": [ { "name": "Like Post", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/posts\/:post_id\/like", "query": [], "raw": "{{baseUrl}}\/v1\/posts\/:post_id\/like", "variable": [ { "id": "post_id", "key": "post_id", "value": "architecto", "description": "The ID of the post." }, { "id": "post", "key": "post", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The post ULID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Like a post for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"posts\",\"attributes\":{\"body\":\"Quidem nostrum qui commodi incidunt iure odit. Et modi ipsum nostrum omnis autem et consequatur. Dolores enim non facere tempora. Voluptatem laboriosam praesentium quis adipisci.\",\"status\":\"draft\",\"visibility\":\"Only me\",\"repost_of_post_id\":null,\"is_repost\":false,\"is_quote\":false,\"like_count\":0,\"reply_count\":0,\"repost_count\":0,\"liked_by_me\":false,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Post liked." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." } ] }, { "name": "Unlike Post", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/posts\/:post_id\/like", "query": [], "raw": "{{baseUrl}}\/v1\/posts\/:post_id\/like", "variable": [ { "id": "post_id", "key": "post_id", "value": "architecto", "description": "The ID of the post." }, { "id": "post", "key": "post", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The post ULID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove the authenticated user like from a post." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"posts\",\"attributes\":{\"body\":\"Quidem nostrum qui commodi incidunt iure odit. Et modi ipsum nostrum omnis autem et consequatur. Dolores enim non facere tempora. Voluptatem laboriosam praesentium quis adipisci.\",\"status\":\"draft\",\"visibility\":\"Only me\",\"repost_of_post_id\":null,\"is_repost\":false,\"is_quote\":false,\"like_count\":0,\"reply_count\":0,\"repost_count\":0,\"liked_by_me\":false,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Post unliked." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." } ] } ] }, { "name": "Posts", "description": "", "item": [ { "name": "List Posts", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/posts", "query": [ { "key": "filter[search]", "value": "launch update", "description": "Search by post body.", "disabled": false }, { "key": "filter[status]", "value": "published", "description": "Filter by post status.", "disabled": false }, { "key": "filter[visibility]", "value": "Public", "description": "Filter by post visibility.", "disabled": false }, { "key": "filter[author_id]", "value": "01jabcxyz1234567890abcdefg", "description": "Filter by author ULID.", "disabled": false }, { "key": "filter[repost_of_post_id]", "value": "01jabcxyz1234567890abcdefg", "description": "Filter by repost source post ULID.", "disabled": false }, { "key": "filter[published_from]", "value": "2026-04-01T00:00:00Z", "description": "Include posts published on or after this ISO 8601 timestamp.", "disabled": false }, { "key": "filter[published_until]", "value": "2026-04-30T23:59:59Z", "description": "Include posts published on or before this ISO 8601 timestamp.", "disabled": false }, { "key": "sort", "value": "-published_at", "description": "Sort column. Prefix with `-` for descending.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of posts per page (1-100).", "disabled": false }, { "key": "include", "value": "author,repostOfPost,repostOfPost.author", "description": "Comma-separated relationships to include: author, repostOfPost, repostOfPost.author.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/posts?filter[search]=launch update&filter[status]=published&filter[visibility]=Public&filter[author_id]=01jabcxyz1234567890abcdefg&filter[repost_of_post_id]=01jabcxyz1234567890abcdefg&filter[published_from]=2026-04-01T00:00:00Z&filter[published_until]=2026-04-30T23:59:59Z&sort=-published_at&per_page=20&include=author,repostOfPost,repostOfPost.author" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List posts with filtering, sorting, pagination, and optional relationship includes." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"posts\",\"attributes\":{\"body\":\"Quidem nostrum qui commodi incidunt iure odit. Et modi ipsum nostrum omnis autem et consequatur. Dolores enim non facere tempora. Voluptatem laboriosam praesentium quis adipisci.\",\"status\":\"draft\",\"visibility\":\"Only me\",\"repost_of_post_id\":null,\"is_repost\":false,\"is_quote\":false,\"like_count\":0,\"reply_count\":0,\"repost_count\":0,\"liked_by_me\":false,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}},{\"id\":\"\",\"type\":\"posts\",\"attributes\":{\"body\":\"Veritatis excepturi doloribus delectus fugit. Repudiandae laboriosam est alias tenetur ratione. Voluptate accusamus ut et recusandae. Rerum ex repellendus assumenda et.\",\"status\":\"draft\",\"visibility\":\"Only me\",\"repost_of_post_id\":null,\"is_repost\":false,\"is_quote\":false,\"like_count\":0,\"reply_count\":0,\"repost_count\":0,\"liked_by_me\":false,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated post list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." } ] }, { "name": "Show Post", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/posts\/:id", "query": [ { "key": "include", "value": "author,repostOfPost,repostOfPost.author", "description": "Comma-separated relationships to include: author, repostOfPost, repostOfPost.author.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/posts\/:id?include=author,repostOfPost,repostOfPost.author", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the post." }, { "id": "post", "key": "post", "value": "01jabcxyz1234567890abcdefg", "description": "The ULID of the post." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch a single post by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"posts\",\"attributes\":{\"body\":\"Quidem nostrum qui commodi incidunt iure odit. Et modi ipsum nostrum omnis autem et consequatur. Dolores enim non facere tempora. Voluptatem laboriosam praesentium quis adipisci.\",\"status\":\"draft\",\"visibility\":\"Only me\",\"repost_of_post_id\":null,\"is_repost\":false,\"is_quote\":false,\"like_count\":0,\"reply_count\":0,\"repost_count\":0,\"liked_by_me\":false,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Post details." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Post could not be found." } ] }, { "name": "Create Post", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/posts", "query": [], "raw": "{{baseUrl}}\/v1\/posts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"body\":\"Shipping the new posts endpoint today.\",\"status\":\"draft\",\"visibility\":\"Only me\",\"repost_of_post_id\":\"01jabcxyz1234567890abcdefg\",\"like_count\":0,\"reply_count\":0,\"repost_count\":0,\"published_at\":\"2026-04-17T18:45:00Z\"}" }, "description": "Create a new post for the authenticated user." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"\",\"type\":\"posts\",\"attributes\":{\"body\":\"Quidem nostrum qui commodi incidunt iure odit. Et modi ipsum nostrum omnis autem et consequatur. Dolores enim non facere tempora. Voluptatem laboriosam praesentium quis adipisci.\",\"status\":\"draft\",\"visibility\":\"Only me\",\"repost_of_post_id\":null,\"is_repost\":false,\"is_quote\":false,\"like_count\":0,\"reply_count\":0,\"repost_count\":0,\"liked_by_me\":false,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Post created." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Update Post", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/posts\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/posts\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the post." }, { "id": "post", "key": "post", "value": "01jabcxyz1234567890abcdefg", "description": "The ULID of the post." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"body\":\"Edited launch message.\",\"status\":\"published\",\"visibility\":\"Friends\",\"repost_of_post_id\":\"01jabcxyz1234567890abcdefg\",\"like_count\":12,\"reply_count\":4,\"repost_count\":2,\"published_at\":\"2026-04-17T18:45:00Z\"}" }, "description": "Patch a post by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"posts\",\"attributes\":{\"body\":\"Quidem nostrum qui commodi incidunt iure odit. Et modi ipsum nostrum omnis autem et consequatur. Dolores enim non facere tempora. Voluptatem laboriosam praesentium quis adipisci.\",\"status\":\"draft\",\"visibility\":\"Only me\",\"repost_of_post_id\":null,\"is_repost\":false,\"is_quote\":false,\"like_count\":0,\"reply_count\":0,\"repost_count\":0,\"liked_by_me\":false,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}}", "name": "Post updated." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Post could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Delete Post", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/posts\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/posts\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the post." }, { "id": "post", "key": "post", "value": "01jabcxyz1234567890abcdefg", "description": "The ULID of the post." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a post by ID." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Post deleted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Post could not be found." } ] } ] }, { "name": "Profile Blocks", "description": "", "item": [ { "name": "List Blocked Profiles", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/blocked-profiles", "query": [ { "key": "per_page", "value": "20", "description": "Number of profiles per page (1-100).", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/blocked-profiles?per_page=20", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the target profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List profiles blocked by the authenticated user profile or a target profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"daphne59\",\"display_name\":\"Morgan Hirthe\",\"bio\":\"Libero aliquam veniam corporis dolorem mollitia deleniti.\",\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=daphne59\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/daphne59\"}},{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"modesta58\",\"display_name\":\"Mr. Murl Cruickshank Jr.\",\"bio\":null,\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=modesta58\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/modesta58\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated blocked profile list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." } ] }, { "name": "Create Profile Block", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/blocked-profiles\/:targetProfile_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/blocked-profiles\/:targetProfile_id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "targetProfile_id", "key": "targetProfile_id", "value": "architecto", "description": "The ID of the targetProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the profile to block." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Block a profile for the authenticated user profile." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Profile block already exists.\"}", "name": "Profile block already exists." }, { "header": [], "code": 201, "body": "{\"message\":\"Profile block created.\"}", "name": "Profile block created." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "The target profile is the authenticated profile." } ] }, { "name": "Delete Profile Block", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/blocked-profiles\/:targetProfile_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/blocked-profiles\/:targetProfile_id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "targetProfile_id", "key": "targetProfile_id", "value": "architecto", "description": "The ID of the targetProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the profile to unblock." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a profile block from the authenticated user profile." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Profile block deleted.\"}", "name": "Profile block deleted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "The target profile is the authenticated profile." } ] }, { "name": "List Blocked Profiles", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/profiles\/:actingProfile_id\/blocked-profiles", "query": [ { "key": "per_page", "value": "20", "description": "Number of profiles per page (1-100).", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/profiles\/:actingProfile_id\/blocked-profiles?per_page=20", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the target profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List profiles blocked by the authenticated user profile or a target profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"cynthiafahey\",\"display_name\":\"Morgan Hirthe\",\"bio\":\"Officia est dignissimos neque blanditiis odio veritatis excepturi.\",\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=cynthiafahey\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/cynthiafahey\"}},{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"smithroxanne\",\"display_name\":\"Brennon Anderson\",\"bio\":null,\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=smithroxanne\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/smithroxanne\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated blocked profile list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." } ] } ] }, { "name": "Profile Friend Requests", "description": "", "item": [ { "name": "List Incoming Profile Friend Requests", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/friend-requests\/incoming", "query": [ { "key": "per_page", "value": "20", "description": "Number of requests per page (1-100).", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/friend-requests\/incoming?per_page=20", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List pending friend requests received by the authenticated user profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"profile-friend-requests\",\"attributes\":{\"requester_profile_id\":\"01kwve0y0dq6tzdc18cxxypme7\",\"recipient_profile_id\":\"01kwve0y0hdxnbys5jzdyrqh42\",\"created_at\":null,\"updated_at\":null}},{\"id\":\"\",\"type\":\"profile-friend-requests\",\"attributes\":{\"requester_profile_id\":\"01kwve0y0ndxrm4ggtm6f61svp\",\"recipient_profile_id\":\"01kwve0y0s2vz1gc4r09ythx6p\",\"created_at\":null,\"updated_at\":null}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated incoming friend request list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Authenticated user profile could not be found." } ] }, { "name": "List Outgoing Profile Friend Requests", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/friend-requests\/outgoing", "query": [ { "key": "per_page", "value": "20", "description": "Number of requests per page (1-100).", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/friend-requests\/outgoing?per_page=20", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List pending friend requests sent by the authenticated user profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"profile-friend-requests\",\"attributes\":{\"requester_profile_id\":\"01kwve0y0y57x02dbffmf895x3\",\"recipient_profile_id\":\"01kwve0y12qhz36bzkbh0637bp\",\"created_at\":null,\"updated_at\":null}},{\"id\":\"\",\"type\":\"profile-friend-requests\",\"attributes\":{\"requester_profile_id\":\"01kwve0y16m6m88jhgjexag9as\",\"recipient_profile_id\":\"01kwve0y19w2se3se86r17caxy\",\"created_at\":null,\"updated_at\":null}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated outgoing friend request list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Authenticated user profile could not be found." } ] }, { "name": "Create Profile Friend Request", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/friend-requests\/:targetProfile_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/friend-requests\/:targetProfile_id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "targetProfile_id", "key": "targetProfile_id", "value": "architecto", "description": "The ID of the targetProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the profile to request." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Send a pending friend request to another profile. A reciprocal pending request is accepted automatically." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Profile friend request already exists.\"}", "name": "Friend request already exists." }, { "header": [], "code": 200, "body": "{\"message\":\"Profile friend request accepted.\"}", "name": "Reciprocal request accepted automatically." }, { "header": [], "code": 201, "body": "{\"message\":\"Profile friend request created.\"}", "name": "Friend request created." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." }, { "header": [], "code": 409, "body": "{\"message\":\"Blocked profiles cannot become friends.\"}", "name": "Either profile has blocked the other." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "The target profile is the authenticated profile." } ] }, { "name": "Accept Profile Friend Request", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/friend-requests\/:targetProfile_id\/accept", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/friend-requests\/:targetProfile_id\/accept", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "targetProfile_id", "key": "targetProfile_id", "value": "architecto", "description": "The ID of the targetProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the requester profile." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Accept an incoming pending friend request from another profile." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Profile friend request accepted.\"}", "name": "Friend request accepted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Profile friend request not found.\"}", "name": "Incoming request could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "The target profile is the authenticated profile." } ] }, { "name": "Decline Profile Friend Request", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/friend-requests\/:targetProfile_id\/decline", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/friend-requests\/:targetProfile_id\/decline", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "targetProfile_id", "key": "targetProfile_id", "value": "architecto", "description": "The ID of the targetProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the requester profile." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Decline an incoming pending friend request from another profile." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Profile friend request declined.\"}", "name": "Friend request declined." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "The target profile is the authenticated profile." } ] }, { "name": "Cancel Profile Friend Request", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/friend-requests\/:targetProfile_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/friend-requests\/:targetProfile_id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "targetProfile_id", "key": "targetProfile_id", "value": "architecto", "description": "The ID of the targetProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the recipient profile." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Cancel an outgoing pending friend request to another profile." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Profile friend request canceled.\"}", "name": "Friend request canceled." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "The target profile is the authenticated profile." } ] } ] }, { "name": "Profile Friends", "description": "", "item": [ { "name": "List Profile Friends", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/friends", "query": [ { "key": "per_page", "value": "20", "description": "Number of profiles per page (1-100).", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/friends?per_page=20", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the target profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List friends for the authenticated user profile or a target profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"sleffler\",\"display_name\":\"Morgan Hirthe\",\"bio\":null,\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=sleffler\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/sleffler\"}},{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"micaela88\",\"display_name\":\"Prof. Annabelle Kshlerin\",\"bio\":\"Veniam corporis dolorem mollitia.\",\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=micaela88\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/micaela88\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated profile friend list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." } ] }, { "name": "List Profile Friends Of Friends", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/friends-of-friends", "query": [ { "key": "per_page", "value": "20", "description": "Number of profiles per page (1-100).", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/friends-of-friends?per_page=20", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the target profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List second-degree friends for the authenticated user profile or a target profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"matildafeeney\",\"display_name\":\"Morgan Hirthe\",\"bio\":null,\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=matildafeeney\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/matildafeeney\"}},{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"verlie08\",\"display_name\":\"Kirstin Nitzsche V\",\"bio\":\"Deleniti nemo odit quia officia.\",\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=verlie08\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/verlie08\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated friends-of-friends list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." } ] }, { "name": "Delete Profile Friend", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/friends\/:targetProfile_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/friends\/:targetProfile_id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "targetProfile_id", "key": "targetProfile_id", "value": "architecto", "description": "The ID of the targetProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the profile to unfriend." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a friendship from the authenticated user profile." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Profile friend deleted.\"}", "name": "Profile friendship deleted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "The target profile is the authenticated profile." } ] }, { "name": "List Profile Friends", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/profiles\/:actingProfile_id\/friends", "query": [ { "key": "per_page", "value": "20", "description": "Number of profiles per page (1-100).", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/profiles\/:actingProfile_id\/friends?per_page=20", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the target profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List friends for the authenticated user profile or a target profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"qankunding\",\"display_name\":\"Morgan Hirthe\",\"bio\":\"Corporis dolorem mollitia deleniti nemo odit quia officia.\",\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=qankunding\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/qankunding\"}},{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"gthiel\",\"display_name\":\"Mona Lemke\",\"bio\":null,\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=gthiel\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/gthiel\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated profile friend list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." } ] }, { "name": "List Profile Friends Of Friends", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/profiles\/:actingProfile_id\/friends-of-friends", "query": [ { "key": "per_page", "value": "20", "description": "Number of profiles per page (1-100).", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/profiles\/:actingProfile_id\/friends-of-friends?per_page=20", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "profile", "key": "profile", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the target profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List second-degree friends for the authenticated user profile or a target profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"wbatz\",\"display_name\":\"Morgan Hirthe\",\"bio\":\"Deleniti nemo odit quia officia.\",\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=wbatz\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/wbatz\"}},{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"walker26\",\"display_name\":\"Alexa Hamill DDS\",\"bio\":null,\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=walker26\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/walker26\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated friends-of-friends list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." } ] } ] }, { "name": "Profiles", "description": "", "item": [ { "name": "Show Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/profiles\/:handle", "query": [], "raw": "{{baseUrl}}\/v1\/profiles\/:handle", "variable": [ { "id": "handle", "key": "handle", "value": "jane_doe", "description": "The profile handle." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch a profile by handle." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"dareemelie\",\"display_name\":\"Morgan Hirthe\",\"bio\":null,\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=dareemelie\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/dareemelie\"}}}", "name": "Profile found." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." } ] }, { "name": "List Current User Profiles", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List profiles owned by the authenticated user." }, "response": [] }, { "name": "Create Current User Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"handle\":\"jane_doe\",\"display_name\":\"Jane Doe\",\"bio\":\"Curating local shops and finds.\",\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=jane_doe\",\"favorite_shops_visibility\":\"Public\",\"favorite_items_visibility\":\"Only me\"}" }, "description": "Create the authenticated user profile." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"alayna44\",\"display_name\":\"Morgan Hirthe\",\"bio\":\"Nostrum omnis autem et consequatur aut.\",\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=alayna44\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/alayna44\"}}}", "name": "Profile created." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 409, "body": "{\"message\":\"Profile already exists.\"}", "name": "Current user already has a profile." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Show Current User Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch the authenticated user profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"pfritsch\",\"display_name\":\"Morgan Hirthe\",\"bio\":null,\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=pfritsch\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/pfritsch\"}}}", "name": "Current user profile." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." } ] }, { "name": "Search Profiles", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/search", "query": [ { "key": "search", "value": "jane", "description": "Display name or handle search term.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/search?search=jane", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search profiles by display name or handle for the acting profile." }, "response": [] }, { "name": "Update Current User Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"handle\":\"jane_doe_updated\",\"display_name\":\"Jane Doe\",\"bio\":\"Updated profile biography.\",\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=jane_doe_updated\",\"favorite_shops_visibility\":\"Followers\",\"favorite_items_visibility\":\"Friends\"}" }, "description": "Patch the authenticated user profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"profiles\",\"attributes\":{\"handle\":\"carey67\",\"display_name\":\"Morgan Hirthe\",\"bio\":null,\"avatar_url\":\"https:\\\/\\\/i.pravatar.cc\\\/512?u=carey67\",\"favorite_shops_visibility\":\"Only me\",\"favorite_items_visibility\":\"Only me\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/profiles\\\/carey67\"}}}", "name": "Profile updated." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Delete Current User Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete the authenticated user profile." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Profile deleted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Profile could not be found." } ] }, { "name": "List My Profile Posts", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/posts", "query": [ { "key": "sort", "value": "-published_at", "description": "Sort column. Prefix with `-` for descending.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of posts per page (1-100).", "disabled": false }, { "key": "include", "value": "author,repostOfPost,repostOfPost.author", "description": "Comma-separated relationships to include: author, repostOfPost, repostOfPost.author.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/posts?sort=-published_at&per_page=20&include=author,repostOfPost,repostOfPost.author", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List published timeline posts for the authenticated user profile, including repost rows." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"posts\",\"attributes\":{\"body\":\"Quidem nostrum qui commodi incidunt iure odit. Et modi ipsum nostrum omnis autem et consequatur. Dolores enim non facere tempora. Voluptatem laboriosam praesentium quis adipisci.\",\"status\":\"draft\",\"visibility\":\"Only me\",\"repost_of_post_id\":null,\"is_repost\":false,\"is_quote\":false,\"like_count\":0,\"reply_count\":0,\"repost_count\":0,\"liked_by_me\":false,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}},{\"id\":\"\",\"type\":\"posts\",\"attributes\":{\"body\":\"Sit doloremque aut omnis quo sit. Mollitia aut rerum ipsa dolorem alias sapiente omnis harum. Itaque voluptas iste esse nesciunt optio.\",\"status\":\"draft\",\"visibility\":\"Only me\",\"repost_of_post_id\":null,\"is_repost\":false,\"is_quote\":false,\"like_count\":0,\"reply_count\":0,\"repost_count\":0,\"liked_by_me\":false,\"published_at\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated current profile post list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Current user profile could not be found." } ] } ] }, { "name": "Referrals", "description": "", "item": [ { "name": "Validate Referral Code", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/referrals\/validate", "query": [], "raw": "{{baseUrl}}\/v1\/referrals\/validate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"referral_code\":\"AbCdEfGhIjKlMnOpQrStUv\"}" }, "description": "Check whether a referral code can be used during registration.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"valid\":true}", "name": "Validation result." } ] }, { "name": "Show Profile Referral", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/referral", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/referral", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "actingProfile", "key": "actingProfile", "value": "architecto", "description": "Owned profile ULID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return the stable referral code and registration URL for an owned profile." }, "response": [ { "header": [], "code": 200, "body": "{\"code\":\"AbCdEfGhIjKlMnOpQrStUv\",\"url\":\"https:\\\/\\\/frontend.bazaarspot-api.test\\\/register?referral_code=AbCdEfGhIjKlMnOpQrStUv\"}", "name": "" } ] } ] }, { "name": "Reviews", "description": "", "item": [ { "name": "List Reviews", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/reviews", "query": [ { "key": "filter[search]", "value": "fast shipping", "description": "Search by review title or body.", "disabled": false }, { "key": "filter[shop_id]", "value": "01jabcxyz1234567890abcdefg", "description": "Filter by shop ULID.", "disabled": false }, { "key": "filter[item_id]", "value": "01jabcxyz1234567890abcdefg", "description": "Filter by item ULID.", "disabled": false }, { "key": "filter[user_id]", "value": "01jabcxyz1234567890abcdefg", "description": "Filter by reviewer user ULID.", "disabled": false }, { "key": "filter[rating]", "value": "5", "description": "Filter by exact rating from 1 to 5.", "disabled": false }, { "key": "sort", "value": "-created_at", "description": "Sort column. Prefix with `-` for descending.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of reviews per page (1-100).", "disabled": false }, { "key": "include", "value": "item,shop,user,reply", "description": "Comma-separated relationships to include: item, shop, user, reply.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/reviews?filter[search]=fast shipping&filter[shop_id]=01jabcxyz1234567890abcdefg&filter[item_id]=01jabcxyz1234567890abcdefg&filter[user_id]=01jabcxyz1234567890abcdefg&filter[rating]=5&sort=-created_at&per_page=20&include=item,shop,user,reply" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List shop and item reviews with filtering, sorting, pagination, and optional relationship includes." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"reviews\",\"attributes\":{\"title\":null,\"body\":\"Nostrum qui commodi incidunt iure.\",\"rating\":5,\"target_type\":\"shop\",\"target_id\":\"01kwve0y54ek2kerfcyzmqqsd0\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/reviews\\\/01ktwg1fhzq1dpagvermfbjzad\"}},{\"id\":\"\",\"type\":\"reviews\",\"attributes\":{\"title\":\"Et recusandae modi rerum ex.\",\"body\":null,\"rating\":1,\"target_type\":\"shop\",\"target_id\":\"01kwve0y58665m2f9ztdsvbk26\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/reviews\\\/01ktwg1fhzq1dpagvermfbjzad\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated review list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." } ] }, { "name": "Show Review", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/reviews\/:id", "query": [ { "key": "include", "value": "item,shop,user", "description": "Comma-separated relationships to include: item, shop, user.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/reviews\/:id?include=item,shop,user", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the review." }, { "id": "review", "key": "review", "value": "01jabcxyz1234567890abcdefg", "description": "The ULID of the review." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch a single review by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"reviews\",\"attributes\":{\"title\":null,\"body\":\"Nostrum qui commodi incidunt iure.\",\"rating\":5,\"target_type\":\"shop\",\"target_id\":\"01kwve0y5h2srqhcr3g0qbhk9y\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/reviews\\\/01ktwg1fhzq1dpagvermfbjzad\"}}}", "name": "Review details." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Review could not be found." } ] }, { "name": "Create Review", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/reviews", "query": [], "raw": "{{baseUrl}}\/v1\/reviews" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"item_id\":\"01jabcxyz1234567890abcdefg\",\"title\":\"Great buying experience\",\"body\":\"Fast shipping and accurate product photos.\",\"rating\":5}" }, "description": "Create a new review for a shop or item." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"\",\"type\":\"reviews\",\"attributes\":{\"title\":null,\"body\":\"Nostrum qui commodi incidunt iure.\",\"rating\":5,\"target_type\":\"shop\",\"target_id\":\"01kwve0y5s6r0674jt6va8t022\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/reviews\\\/01ktwg1fhzq1dpagvermfbjzad\"}}}", "name": "Review created." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Update Review", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/reviews\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/reviews\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the review." }, { "id": "review", "key": "review", "value": "01jabcxyz1234567890abcdefg", "description": "The ULID of the review." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"shop_id\":\"01jabcxyz1234567890abcdefg\",\"title\":\"Updated buying experience\",\"body\":\"Updated review text.\",\"rating\":4}" }, "description": "Patch a review by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"reviews\",\"attributes\":{\"title\":null,\"body\":\"Nostrum qui commodi incidunt iure.\",\"rating\":5,\"target_type\":\"shop\",\"target_id\":\"01kwve0y60jx9zbr3pmkwy91y0\",\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/reviews\\\/01ktwg1fhzq1dpagvermfbjzad\"}}}", "name": "Review updated." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Review could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Delete Review", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/reviews\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/reviews\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the review." }, { "id": "review", "key": "review", "value": "01jabcxyz1234567890abcdefg", "description": "The ULID of the review." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a review by ID." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Review deleted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Review could not be found." } ] } ] }, { "name": "Shareables", "description": "", "item": [ { "name": "List Received Shareables", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/shareables\/received", "query": [ { "key": "filter[shareable_type]", "value": "shop", "description": "Filter by target type.", "disabled": false }, { "key": "filter[shareable_id]", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "Filter by target ULID.", "disabled": false }, { "key": "sort", "value": "-created_at", "description": "Sort column. Prefix with `-` for descending.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of shareables per page (1-100).", "disabled": false }, { "key": "include", "value": "shareable,sharedByProfile", "description": "Comma-separated relationships to include: shareable, sharedByProfile, sharedWithProfile.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/shareables\/received?filter[shareable_type]=shop&filter[shareable_id]=01ktwg1fhzq1dpagvermfbjzad&sort=-created_at&per_page=20&include=shareable,sharedByProfile", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List shareables shared with the authenticated user profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"shareables\",\"attributes\":{\"shareable_type\":null,\"shareable_id\":null,\"shared_by_profile_id\":null,\"shared_with_profile_id\":null,\"created_at\":null,\"updated_at\":null}},{\"id\":\"\",\"type\":\"shareables\",\"attributes\":{\"shareable_type\":null,\"shareable_id\":null,\"shared_by_profile_id\":null,\"shared_with_profile_id\":null,\"created_at\":null,\"updated_at\":null}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated received shareable list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Authenticated user profile could not be found." } ] }, { "name": "List Sent Shareables", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/shareables\/sent", "query": [ { "key": "filter[shareable_type]", "value": "shop", "description": "Filter by target type.", "disabled": false }, { "key": "filter[shareable_id]", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "Filter by target ULID.", "disabled": false }, { "key": "sort", "value": "-created_at", "description": "Sort column. Prefix with `-` for descending.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of shareables per page (1-100).", "disabled": false }, { "key": "include", "value": "shareable,sharedWithProfile", "description": "Comma-separated relationships to include: shareable, sharedByProfile, sharedWithProfile.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/shareables\/sent?filter[shareable_type]=shop&filter[shareable_id]=01ktwg1fhzq1dpagvermfbjzad&sort=-created_at&per_page=20&include=shareable,sharedWithProfile", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List shareables sent by the authenticated user profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"shareables\",\"attributes\":{\"shareable_type\":null,\"shareable_id\":null,\"shared_by_profile_id\":null,\"shared_with_profile_id\":null,\"created_at\":null,\"updated_at\":null}},{\"id\":\"\",\"type\":\"shareables\",\"attributes\":{\"shareable_type\":null,\"shareable_id\":null,\"shared_by_profile_id\":null,\"shared_with_profile_id\":null,\"created_at\":null,\"updated_at\":null}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated sent shareable list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Authenticated user profile could not be found." } ] }, { "name": "Show Shareable", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/shareables\/:id", "query": [ { "key": "include", "value": "shareable,sharedByProfile", "description": "Comma-separated relationships to include: shareable, sharedByProfile, sharedWithProfile.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/shareables\/:id?include=shareable,sharedByProfile", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "id", "key": "id", "value": "16", "description": "The ID of the shareable." }, { "id": "shareable", "key": "shareable", "value": "1", "description": "The shareable ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch one shareable if the authenticated user profile is the sender or recipient." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"shareables\",\"attributes\":{\"shareable_type\":null,\"shareable_id\":null,\"shared_by_profile_id\":null,\"shared_with_profile_id\":null,\"created_at\":null,\"updated_at\":null}}}", "name": "Shareable details." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Shareable could not be found." } ] }, { "name": "Create Shareable", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/shareables", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/shareables", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"shareable_type\":\"shop\",\"shareable_id\":\"01ktwg1fhzq1dpagvermfbjzad\",\"shared_with_profile_id\":\"01ktwg1fhzq1dpagvermfbjzae\"}" }, "description": "Share a shop, item, or collection with a friend profile." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"\",\"type\":\"shareables\",\"attributes\":{\"shareable_type\":null,\"shareable_id\":null,\"shared_by_profile_id\":null,\"shared_with_profile_id\":null,\"created_at\":null,\"updated_at\":null}}}", "name": "Shareable created." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Authenticated user profile could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Delete Shareable", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/shareables\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/shareables\/:id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "id", "key": "id", "value": "16", "description": "The ID of the shareable." }, { "id": "shareable", "key": "shareable", "value": "1", "description": "The shareable ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete one shareable if the authenticated user profile is the sender or recipient." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Shareable deleted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Shareable could not be found." } ] } ] }, { "name": "Shops", "description": "", "item": [ { "name": "List Shops", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shops", "query": [ { "key": "filter[search]", "value": "odd", "description": "Search by name, slug, domain, website URL, or description.", "disabled": false }, { "key": "filter[slug]", "value": "odd-egypt", "description": "Filter by exact shop slug.", "disabled": false }, { "key": "filter[is_active]", "value": "1", "description": "Filter by active status.", "disabled": false }, { "key": "filter[verified]", "value": "1", "description": "Filter by verification status.", "disabled": false }, { "key": "filter[country_code]", "value": "", "description": "Filter by ISO country code.", "disabled": true }, { "key": "filter[classification]", "value": "online_store", "description": "Filter by shop classification.", "disabled": false }, { "key": "filter[category_id]", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "Filter by category ULID.", "disabled": false }, { "key": "filter[feature_id]", "value": "", "description": "Filter by shop feature ID.", "disabled": true }, { "key": "filter[ecommerce_provider_id]", "value": "", "description": "Filter by ecommerce provider ID.", "disabled": true }, { "key": "filter[social_platform]", "value": "instagram", "description": "Filter by social profile platform.", "disabled": false }, { "key": "filter[social_identifier_type]", "value": "username", "description": "Filter by social profile identifier type.", "disabled": false }, { "key": "filter[social_identifier]", "value": "odd.eg", "description": "Filter by normalized social profile identifier.", "disabled": false }, { "key": "filter[scraped_from]", "value": "2026-04-01", "description": "Only shops scraped on or after this date (`Y-m-d`).", "disabled": false }, { "key": "filter[scraped_until]", "value": "2026-04-15", "description": "Only shops scraped on or before this date (`Y-m-d`).", "disabled": false }, { "key": "sort", "value": "-created_at", "description": "Sort column. Recommended sorting requires authentication and X-Profile-ID.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of shops per page (1\u2013100).", "disabled": false }, { "key": "include", "value": "country,categories", "description": "Comma-separated relationships to include: country, categories, features.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/shops?filter[search]=odd&filter[slug]=odd-egypt&filter[is_active]=1&filter[verified]=1&filter[country_code]=&filter[classification]=online_store&filter[category_id]=01ktwg1fhzq1dpagvermfbjzad&filter[feature_id]=&filter[ecommerce_provider_id]=&filter[social_platform]=instagram&filter[social_identifier_type]=username&filter[social_identifier]=odd.eg&filter[scraped_from]=2026-04-01&filter[scraped_until]=2026-04-15&sort=-created_at&per_page=20&include=country,categories" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List shops with filtering, sorting, pagination, and optional relationship includes.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"shops\",\"attributes\":{\"name\":\"Bailey Ltd\",\"slug\":\"bailey-ltd\",\"description\":\"Et fugiat sunt nihil accusantium.\",\"website_url\":\"https:\\\/\\\/okuneva.test\",\"domain\":\"okuneva.test\",\"phone\":\"+1-463-622-3498\",\"email\":\"marquardt.noah@example.com\",\"address\":\"38862 Ferne Locks Suite 058\\nChristianshire, IA 97161\",\"classification\":\"department_store\",\"country_code\":null,\"region\":\"North Demarcusmouth\",\"is_active\":true,\"is_verified\":false,\"verified_at\":null,\"inactive_reason\":null,\"social_profiles\":[],\"url\":null,\"logo_url\":null,\"banner_image_url\":null,\"shop_image_url\":null,\"shop_favicon_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/shops\\\/01ktwg1fhzq1dpagvermfbjzad\"}},{\"id\":\"\",\"type\":\"shops\",\"attributes\":{\"name\":\"Labadie, Haag and Considine\",\"slug\":\"labadie-haag-and-considine\",\"description\":\"Eum doloremque id aut libero aliquam veniam corporis.\",\"website_url\":\"https:\\\/\\\/wisoky.test\",\"domain\":\"wisoky.test\",\"phone\":\"(907) 735-1679\",\"email\":\"libby.bradtke@example.com\",\"address\":\"4985 Jacques Lakes Apt. 004\\nRoxanneview, GA 41591-5182\",\"classification\":\"marketplace\",\"country_code\":null,\"region\":\"North Zachery\",\"is_active\":true,\"is_verified\":false,\"verified_at\":null,\"inactive_reason\":null,\"social_profiles\":[],\"url\":null,\"logo_url\":null,\"banner_image_url\":null,\"shop_image_url\":null,\"shop_favicon_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/shops\\\/01ktwg1fhzq1dpagvermfbjzad\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Paginated shop list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." } ] }, { "name": "Show Shop", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shops\/:id", "query": [ { "key": "include", "value": "country,features", "description": "Comma-separated relationships to include: country, categories, features.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/shops\/:id?include=country,features", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the shop." }, { "id": "shop", "key": "shop", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "The ULID of the shop." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetch a single shop by ULID.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"shops\",\"attributes\":{\"name\":\"Rempel, Gulgowski and O'Kon\",\"slug\":\"rempel-gulgowski-and-okon\",\"description\":\"Accusantium harum mollitia modi deserunt aut ab.\",\"website_url\":\"https:\\\/\\\/ernser.test\",\"domain\":\"ernser.test\",\"phone\":\"1-463-692-1881\",\"email\":\"wleuschke@example.net\",\"address\":\"1052 Carey Greens\\nLefflerhaven, TX 58408-7043\",\"classification\":\"marketplace\",\"country_code\":null,\"region\":\"Raynormouth\",\"is_active\":true,\"is_verified\":false,\"verified_at\":null,\"inactive_reason\":null,\"social_profiles\":[],\"url\":null,\"logo_url\":null,\"banner_image_url\":null,\"shop_image_url\":null,\"shop_favicon_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/shops\\\/01ktwg1fhzq1dpagvermfbjzad\"}}}", "name": "Shop details." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Shop could not be found." } ] }, { "name": "Create Shop", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shops", "query": [], "raw": "{{baseUrl}}\/v1\/shops" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Odd Egypt\",\"domain\":\"oddegypt.com\",\"slug\":\"odd-egypt\",\"website_url\":\"https:\\\/\\\/oddegypt.com\",\"description\":\"Independent Egyptian online store.\",\"phone\":\"+20 100 000 0000\",\"email\":\"hello@oddegypt.com\",\"address\":\"Cairo, Egypt\",\"classification\":\"online_store\",\"country_code\":\"EG\",\"country_id\":1,\"region\":\"Cairo\",\"is_active\":true,\"verified_at\":\"2026-04-15T12:00:00+00:00\",\"favorite\":true,\"social_profiles\":[{\"platform\":\"instagram\",\"handle\":\"@odd.eg\"}]}" }, "description": "Create a new shop record." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"\",\"type\":\"shops\",\"attributes\":{\"name\":\"Price Ltd\",\"slug\":\"price-ltd\",\"description\":\"Commodi incidunt iure odit.\",\"website_url\":\"https:\\\/\\\/cronin.test\",\"domain\":\"cronin.test\",\"phone\":\"203-867-3351\",\"email\":\"nstokes@example.org\",\"address\":\"427 Labadie Curve Suite 170\\nLake Micaela, ID 92203\",\"classification\":\"chain_store\",\"country_code\":null,\"region\":\"West Cynthiaberg\",\"is_active\":true,\"is_verified\":false,\"verified_at\":null,\"inactive_reason\":null,\"social_profiles\":[],\"url\":null,\"logo_url\":null,\"banner_image_url\":null,\"shop_image_url\":null,\"shop_favicon_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/shops\\\/01ktwg1fhzq1dpagvermfbjzad\"}}}", "name": "Shop created." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Update Shop", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shops\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/shops\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the shop." }, { "id": "shop", "key": "shop", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "The ULID of the shop." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Odd Egypt Boutique\",\"domain\":\"oddegypt.com\",\"slug\":\"odd-egypt-boutique\",\"website_url\":\"https:\\\/\\\/oddegypt.com\",\"description\":\"Updated shop description.\",\"phone\":\"+20 100 000 0000\",\"email\":\"hello@oddegypt.com\",\"address\":\"Cairo, Egypt\",\"classification\":\"boutique\",\"country_code\":\"EG\",\"country_id\":1,\"region\":\"Alexandria\",\"is_active\":true,\"verified_at\":\"2026-04-15T12:00:00+00:00\",\"social_profiles\":[{\"platform\":\"instagram\",\"handle\":\"@odd.eg\"}]}" }, "description": "Patch a shop by ULID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"\",\"type\":\"shops\",\"attributes\":{\"name\":\"Dare Group\",\"slug\":\"dare-group\",\"description\":\"Odit et et modi.\",\"website_url\":\"https:\\\/\\\/leuschke.test\",\"domain\":\"leuschke.test\",\"phone\":\"+1-715-952-7161\",\"email\":\"tleuschke@example.net\",\"address\":\"723 Wisoky Passage\\nMicaelatown, CA 87335-0574\",\"classification\":\"specialty_store\",\"country_code\":null,\"region\":\"West Gisselle\",\"is_active\":true,\"is_verified\":false,\"verified_at\":null,\"inactive_reason\":null,\"social_profiles\":[],\"url\":null,\"logo_url\":null,\"banner_image_url\":null,\"shop_image_url\":null,\"shop_favicon_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/shops\\\/01ktwg1fhzq1dpagvermfbjzad\"}}}", "name": "Shop updated." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Shop could not be found." }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\"}", "name": "Validation failed." } ] }, { "name": "Delete Shop", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/shops\/:id", "query": [], "raw": "{{baseUrl}}\/v1\/shops\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the shop." }, { "id": "shop", "key": "shop", "value": "01ktwg1fhzq1dpagvermfbjzad", "description": "The ULID of the shop." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Soft delete a shop by ULID." }, "response": [ { "header": [], "code": 204, "body": null, "name": "Shop deleted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Shop could not be found." } ] } ] }, { "name": "User Bookmarked Items", "description": "", "item": [ { "name": "List User Bookmarked Items", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/bookmarked-items", "query": [ { "key": "per_page", "value": "20", "description": "Number of bookmarked items per page (1-100).", "disabled": false }, { "key": "include", "value": "shop", "description": "Comma-separated item relationships to include: shop, brand, categories, variants.", "disabled": false } ], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/bookmarked-items?per_page=20&include=shop", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List bookmarked items for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"items\",\"attributes\":{\"name\":\"Incidunt Iure Odit\",\"slug\":\"incidunt-iure-odit\",\"description\":\"Et modi ipsum nostrum omnis autem et consequatur.\",\"external_url\":null,\"price\":3651.56,\"original_price\":null,\"currency\":\"EGP\",\"sku\":\"SN-515-RW\",\"condition\":\"new\",\"stock_level\":13,\"weight\":null,\"dimensions\":null,\"specifications\":null,\"is_available\":true,\"is_active\":true,\"url\":null,\"featured_image_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/items\\\/01ktwg1fhzq1dpagvermfbjzad\"}},{\"id\":\"\",\"type\":\"items\",\"attributes\":{\"name\":\"Reiciendis Quia Perspiciatis\",\"slug\":\"reiciendis-quia-perspiciatis\",\"description\":\"Ducimus corrupti et dolores quia maiores assumenda.\",\"external_url\":null,\"price\":689.49,\"original_price\":null,\"currency\":\"EGP\",\"sku\":\"SG-468-TV\",\"condition\":\"new\",\"stock_level\":143,\"weight\":null,\"dimensions\":null,\"specifications\":null,\"is_available\":true,\"is_active\":true,\"url\":null,\"featured_image_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/items\\\/01ktwg1fhzq1dpagvermfbjzad\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Bookmarked item list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." } ] }, { "name": "Create User Bookmarked Item", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/bookmarked-items\/:item_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/bookmarked-items\/:item_id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "item_id", "key": "item_id", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the item to bookmark." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Bookmark an item for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Bookmarked item already exists.\"}", "name": "Item was already bookmarked by the user." }, { "header": [], "code": 201, "body": "{\"message\":\"Bookmarked item created.\"}", "name": "Bookmarked item created." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Item could not be found." } ] }, { "name": "Delete User Bookmarked Item", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/bookmarked-items\/:item_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/bookmarked-items\/:item_id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "item_id", "key": "item_id", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the item to remove from bookmarks." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an item from the authenticated user bookmarked items." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Bookmarked item deleted.\"}", "name": "Bookmarked item deleted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Item could not be found." } ] } ] }, { "name": "User Favorite Shops", "description": "", "item": [ { "name": "List User Favorite Shops", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/favorite-shops", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/favorite-shops", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List favorite shops for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"\",\"type\":\"shops\",\"attributes\":{\"name\":\"Baumbach Ltd\",\"slug\":\"baumbach-ltd\",\"description\":\"Nostrum omnis autem et consequatur aut.\",\"website_url\":\"https:\\\/\\\/bauch.test\",\"domain\":\"bauch.test\",\"phone\":\"283.476.7809\",\"email\":\"jhaag@example.net\",\"address\":\"2127 Verlie Manors\\nWest Gisselle, CO 53669\",\"classification\":\"boutique\",\"country_code\":null,\"region\":\"East Nedra\",\"is_active\":true,\"is_verified\":false,\"verified_at\":null,\"inactive_reason\":null,\"social_profiles\":[],\"url\":null,\"logo_url\":null,\"banner_image_url\":null,\"shop_image_url\":null,\"shop_favicon_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/shops\\\/01ktwg1fhzq1dpagvermfbjzad\"}},{\"id\":\"\",\"type\":\"shops\",\"attributes\":{\"name\":\"Bradtke Group\",\"slug\":\"bradtke-group\",\"description\":\"Qui repudiandae laboriosam est alias.\",\"website_url\":\"https:\\\/\\\/emmerich.test\",\"domain\":\"emmerich.test\",\"phone\":\"269-915-6037\",\"email\":\"moises37@example.com\",\"address\":\"13733 Runolfsson Mall\\nMargarettaside, OH 29924\",\"classification\":\"marketplace\",\"country_code\":null,\"region\":\"Kreigerburgh\",\"is_active\":true,\"is_verified\":false,\"verified_at\":null,\"inactive_reason\":null,\"social_profiles\":[],\"url\":null,\"logo_url\":null,\"banner_image_url\":null,\"shop_image_url\":null,\"shop_favicon_url\":null,\"created_at\":\"2026-07-06T10:01:48+00:00\",\"updated_at\":\"2026-07-06T10:01:48+00:00\"},\"links\":{\"self\":\"http:\\\/\\\/bazaarspot-api.test\\\/v1\\\/shops\\\/01ktwg1fhzq1dpagvermfbjzad\"}}],\"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\":2,\"to\":2,\"total\":2}}", "name": "Favorite shop list." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." } ] }, { "name": "Create User Favorite Shop", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/favorite-shops\/:shop_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/favorite-shops\/:shop_id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "shop_id", "key": "shop_id", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the shop to favorite." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Favorite a shop for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Favorite shop already exists.\"}", "name": "Shop was already favorited by the user." }, { "header": [], "code": 201, "body": "{\"message\":\"Favorite shop created.\"}", "name": "Favorite shop created." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Shop could not be found." } ] }, { "name": "Delete User Favorite Shop", "request": { "url": { "host": "{{baseUrl}}", "path": "v1\/me\/profiles\/:actingProfile_id\/favorite-shops\/:shop_id", "query": [], "raw": "{{baseUrl}}\/v1\/me\/profiles\/:actingProfile_id\/favorite-shops\/:shop_id", "variable": [ { "id": "actingProfile_id", "key": "actingProfile_id", "value": "architecto", "description": "The ID of the actingProfile." }, { "id": "shop_id", "key": "shop_id", "value": "01AN4Z07BY79KA1307SR9X4MV3", "description": "The ULID of the shop to unfavorite." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a shop from the authenticated user favorite shops." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Favorite shop deleted.\"}", "name": "Favorite shop deleted." }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "Authentication failed." }, { "header": [], "code": 403, "body": "{\"message\":\"Forbidden.\"}", "name": "Token is missing the required ability." }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found.\"}", "name": "Shop could not be found." } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }