{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "http:\/\/localhost" } ], "info": { "name": "Webparts 2 API Documentation", "_postman_id": "5525740b-366f-4c48-8ff3-8d9648e3a67d", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Endpoints", "description": "", "item": [ { "name": "GET api\/user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user", "query": [], "raw": "{{baseUrl}}\/api\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/login", "query": [], "raw": "{{baseUrl}}\/api\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"ymohr@example.net\",\"password\":\"Yrwv;Uc+\"}" }, "description": "" }, "response": [] }, { "name": "Destroy an authenticated session.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/logout", "query": [], "raw": "{{baseUrl}}\/api\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Send a reset link to the given user and respond with JSON.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/forgot-password", "query": [], "raw": "{{baseUrl}}\/api\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"sherwood17@example.net\"}" }, "description": "Fortify's own PasswordResetLinkController returns a session-based\nredirect\/view response, which this stateless API can't use.\n\nAlways responds with the same generic message regardless of whether the\nemail is registered, to avoid leaking account existence." }, "response": [] }, { "name": "Reset the user's password and respond with JSON.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reset-password", "query": [], "raw": "{{baseUrl}}\/api\/reset-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"voluptatum\",\"email\":\"haylee.boehm@example.org\",\"password\":\"quos\"}" }, "description": "Fortify's own NewPasswordController returns a session-based\nredirect\/view response, which this stateless API can't use." }, "response": [] }, { "name": "Search dealers by title with optional country_code filter and sorting.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/dealers\/search\/:searchQuery", "query": [ { "key": "country_code", "value": "dk", "description": "Filter by country code.", "disabled": false }, { "key": "sort_field", "value": "title", "description": "The field to sort by. Valid values: title, country_code.", "disabled": false }, { "key": "sort_direction", "value": "asc", "description": "The direction to sort by.", "disabled": false }, { "key": "per_page", "value": "20", "description": "The number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/dealers\/search\/:searchQuery?country_code=dk&sort_field=title&sort_direction=asc&per_page=20&page=1", "variable": [ { "id": "searchQuery", "key": "searchQuery", "value": "cumque", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"searchQuery\":\"qltcarobfjtqek\",\"sort_field\":\"country_code\",\"sort_direction\":\"asc\",\"country_code\":\"dy\",\"page\":25,\"per_page\":24}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 422, "body": "{\"message\":\"The selected country code is invalid.\",\"errors\":{\"country_code\":[\"The selected country code is invalid.\"]}}", "name": "" } ] }, { "name": "GET api\/brands Paginated list of brands.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/brands", "query": [ { "key": "all", "value": "1%2A", "description": "Get all brands.", "disabled": false }, { "key": "page", "value": "2", "description": "The page number. Defaults to 1.", "disabled": false }, { "key": "per_page", "value": "20", "description": "The number of items per page.", "disabled": false }, { "key": "first_letter", "value": "A", "description": "The first letter of the brand.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/brands?all=1%2A&page=2&per_page=20&first_letter=A" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Display the specified brand from slug.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/brands\/slug\/:brandSlug", "query": [], "raw": "{{baseUrl}}\/api\/brands\/slug\/:brandSlug", "variable": [ { "id": "brandSlug", "key": "brandSlug", "value": "aksel-ketner", "description": "The slug of the brand." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/brands\/{code} Display the specified brand by code.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/brands\/:code", "query": [], "raw": "{{baseUrl}}\/api\/brands\/:code", "variable": [ { "id": "code", "key": "code", "value": "AK", "description": "The brand code." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET all cart items for the user or session.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/carts\/:sessionId", "query": [ { "key": "currency_code", "value": "DKK", "description": "The currency code to use for the cart items.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/carts\/:sessionId?currency_code=DKK", "variable": [ { "id": "sessionId", "key": "sessionId", "value": "aut", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST a new cart item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/carts", "query": [], "raw": "{{baseUrl}}\/api\/carts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"part_id\":1,\"quantity\":2306896.7381714}" }, "description": "It will be registered for the user if logged in, otherwise it will be registered for the session." }, "response": [] }, { "name": "PUT cart item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/carts\/:cart_id", "query": [], "raw": "{{baseUrl}}\/api\/carts\/:cart_id", "variable": [ { "id": "cart_id", "key": "cart_id", "value": "14", "description": "The ID of the cart." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"part_id\":14,\"quantity\":24470330.84102246,\"session_id\":\"ee17137f-7ec7-3e83-a96f-a160895e05e5\"}" }, "description": "It will be updated for the user if logged in, otherwise it will be updated for the session." }, "response": [] }, { "name": "DELETE cart item if the item belongs to the user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/carts\/:cart_id", "query": [], "raw": "{{baseUrl}}\/api\/carts\/:cart_id", "variable": [ { "id": "cart_id", "key": "cart_id", "value": "17", "description": "The ID of the cart." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Paginated list of countries.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/countries", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "20", "description": "The number of items per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/countries?page=1&per_page=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Display the specified country.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/countries\/:country_code", "query": [], "raw": "{{baseUrl}}\/api\/countries\/:country_code", "variable": [ { "id": "country_code", "key": "country_code", "value": "ae", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Display a listing of the resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/currencies", "query": [], "raw": "{{baseUrl}}\/api\/currencies" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Issue a signed JWT for the authenticated user, for use by the data import app.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data-import\/token", "query": [], "raw": "{{baseUrl}}\/api\/data-import\/token" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET all inquiries made to the dealer company\nFilter by status and archived flag", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inquiries\/dealer\/:company_id", "query": [ { "key": "dealer_id", "value": "40", "description": "Filter by company.", "disabled": false }, { "key": "status[][0]", "value": "quidem", "description": "Filter by status. Provide as repeated query params (status[]=pending&status[]=completed). Allowed values: pending, completed, rejected.", "disabled": false }, { "key": "archived", "value": "1", "description": "Optional. Filter by archived flag. Use archived=true to return only archived inquiries, archived=false for only non-archived. If omitted, returns all.", "disabled": false }, { "key": "sort_field", "value": "created_at", "description": "The field to sort by. Valid values are: created_at.", "disabled": false }, { "key": "sort_direction", "value": "asc", "description": "The direction to sort by.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "20", "description": "The number of items per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/inquiries\/dealer\/:company_id?dealer_id=40&status[][0]=quidem&archived=1&sort_field=created_at&sort_direction=asc&page=1&per_page=20", "variable": [ { "id": "company_id", "key": "company_id", "value": "1", "description": "The ID of the company." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":18,\"status\":[\"pending\"],\"archived\":\"true\",\"sort_field\":\"dealer_title\",\"sort_direction\":\"asc\",\"page\":12,\"per_page\":13}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET all inquiries for the authenticated user (customer)\nFilters by status[] (optional) and paginates.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inquiries\/:user_id", "query": [ { "key": "sort_field", "value": "iure", "description": "Optional. Sort by field. Supports: created_at, status, dealer_title.", "disabled": false }, { "key": "sort_direction", "value": "tenetur", "description": "Optional. Sort direction: asc or desc. Default: asc.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/inquiries\/:user_id?sort_field=iure&sort_direction=tenetur", "variable": [ { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":16,\"status\":[\"rejected\"],\"archived\":\"true\",\"sort_field\":\"status\",\"sort_direction\":\"asc\",\"page\":7,\"per_page\":11}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST Inquiry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inquiries", "query": [ { "key": "dealer_id", "value": "40", "description": "The company id of the dealer.", "disabled": false }, { "key": "from_company_id", "value": "928", "description": "The company id of the company that the inquiry is sent from. The user has to be related to that company", "disabled": false }, { "key": "from_name", "value": "John+Doe", "description": "The name of the sender.", "disabled": false }, { "key": "customer_id", "value": "12", "description": "The authenticated user placing the inquiry. Must match the current account.", "disabled": false }, { "key": "currency_code_customer", "value": "DKK", "description": "The currency the customer selected.", "disabled": false }, { "key": "generated_message", "value": "Part+number%3A+12345%2C+Quantity%3A+10", "description": "The generated message.", "disabled": false }, { "key": "user_message", "value": "Hi.+How+much+is+shipping+to+Denmark+for+these+parts%3F", "description": "The user message.", "disabled": false }, { "key": "send_copy_to_email", "value": "1", "description": "Send a copy of the inquiry to the sender.", "disabled": false }, { "key": "address[]", "value": "", "description": "Custom shipping address for this inquiry.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/inquiries?dealer_id=40&from_company_id=928&from_name=John+Doe&customer_id=12¤cy_code_customer=DKK&generated_message=Part+number%3A+12345%2C+Quantity%3A+10&user_message=Hi.+How+much+is+shipping+to+Denmark+for+these+parts%3F&send_copy_to_email=1&address[]=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"dealer_id\":42,\"from_company_id\":7,\"from_name\":\"Alice Sender\",\"customer_id\":12,\"currency_code_customer\":\"USD\",\"generated_message\":\"Hello, I would like to request a quote for the following parts\u2026\",\"user_message\":\"Please prioritize delivery by next week if possible.\",\"send_copy_to_email\":false,\"parts\":[{\"part_id\":1001,\"quantity\":2,\"price\":49.95},{\"part_id\":1002,\"quantity\":5,\"price\":19.5}],\"address\":{\"address1\":\"Main Street 1\",\"address2\":\"Suite 2\",\"city\":\"Aarhus\",\"postal_code\":\"8000\",\"country_code\":\"dk\",\"phone_number\":\"+4512345678\"}}" }, "description": "" }, "response": [] }, { "name": "Update the specified resource in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/inquiries\/:inquiry_id", "query": [], "raw": "{{baseUrl}}\/api\/inquiries\/:inquiry_id", "variable": [ { "id": "inquiry_id", "key": "inquiry_id", "value": "tenetur", "description": "The ID of the inquiry." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"archived\":false,\"status\":\"rejected\",\"user_message\":\"accusantium\"}" }, "description": "" }, "response": [] }, { "name": "Display a listing of parts matching the search query and filters.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/parts\/search\/:searchQuery", "query": [ { "key": "brand_slug", "value": "john-deere", "description": "The brand slug to filter parts by.", "disabled": false }, { "key": "country_code", "value": "DK", "description": "The country code to filter parts by.", "disabled": false }, { "key": "sort_field", "value": "part_number", "description": "The field to sort by.", "disabled": false }, { "key": "sort_direction", "value": "asc", "description": "The direction to sort by.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number to display.", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items to display per page.", "disabled": false }, { "key": "currency_code", "value": "EUR", "description": "The currency code to filter parts by.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/parts\/search\/:searchQuery?brand_slug=john-deere&country_code=DK&sort_field=part_number&sort_direction=asc&page=1&per_page=10¤cy_code=EUR", "variable": [ { "id": "searchQuery", "key": "searchQuery", "value": "fuga", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"searchQuery\":\"pyykjzskxovghzwjcnjzwkkg\",\"brandSlug\":\"zllgfrgbuqu\",\"page\":57,\"dealer_id\":65,\"sort_field\":\"dealer\",\"sort_direction\":\"asc\",\"country_code\":\"nv\",\"currency_code\":\"tgy\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Display a listing of parts with the specified brand_slug filtered by optional search query.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/parts\/brand\/search\/:brandSlug\/:searchQuery", "query": [ { "key": "country_code", "value": "DK", "description": "The country code to filter parts by.", "disabled": false }, { "key": "sort_field", "value": "part_number", "description": "The field to sort by.", "disabled": false }, { "key": "sort_direction", "value": "asc", "description": "The direction to sort by.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number to display.", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items to display per page.", "disabled": false }, { "key": "currency_code", "value": "EUR", "description": "The currency code to filter parts by.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/parts\/brand\/search\/:brandSlug\/:searchQuery?country_code=DK&sort_field=part_number&sort_direction=asc&page=1&per_page=10¤cy_code=EUR", "variable": [ { "id": "brandSlug", "key": "brandSlug", "value": "tenetur", "description": "" }, { "id": "searchQuery", "key": "searchQuery", "value": "voluptas", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"searchQuery\":\"csyqevffsrtlvgfwbvftkzik\",\"brandSlug\":\"quouzhmyngpzj\",\"page\":89,\"dealer_id\":71,\"sort_field\":\"description1\",\"sort_direction\":\"asc\",\"country_code\":\"kl\",\"currency_code\":\"gqx\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Display the specified parts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/parts\/:partNumber", "query": [ { "key": "sort_field", "value": "price", "description": "The field to sort by. Valid values are: part_number, price and inventory.", "disabled": false }, { "key": "sort_direction", "value": "asc", "description": "The direction to sort by.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/parts\/:partNumber?sort_field=price&sort_direction=asc", "variable": [ { "id": "partNumber", "key": "partNumber", "value": "", "description": "" }, { "id": "part", "key": "part", "value": "1", "description": "The ID of the part." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sort_field\":\"part_number\",\"sort_direction\":\"desc\"}" }, "description": "Include parts that match the manufacturer_part_number\nInclude parts that do not have a manufacturer_part_number but match the part_number" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 404, "body": "{\n \"message\": \"The route api\/parts could not be found.\"\n}", "name": "" } ] }, { "name": "GET api\/general-statistics \u2014 Return the most recent statistics snapshot.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/general-statistics", "query": [], "raw": "{{baseUrl}}\/api\/general-statistics" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET dealers with optional sorting and pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/dealers", "query": [ { "key": "sort_field", "value": "title", "description": "Sort by field. Valid values: title, country_code, nearest, random. random renders a shuffled dealer list that stays stable within the cache window (DEALERS_RANDOM_LIST_CACHE_SECONDS, default 300) and changes afterwards. Defaults to title.", "disabled": false }, { "key": "sort_direction", "value": "asc", "description": "Sort direction. Valid values: asc, desc.", "disabled": false }, { "key": "country_code", "value": "dk", "description": "Filter by country code.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "extend", "value": "address", "description": "Include additional data. Valid values: address.", "disabled": false }, { "key": "has_parts", "value": "1", "description": "Only include dealers that have parts. Maintained with app\/Observers\/PartObserver.php observer", "disabled": false }, { "key": "sales_target", "value": "All", "description": "Filter by sales target. Valid values: Dealers, All, None.", "disabled": false }, { "key": "has_sales_target", "value": "1", "description": "Only include dealers whose sales target is All or Dealers (excludes None and no sales target).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/dealers?sort_field=title&sort_direction=asc&country_code=dk&per_page=20&page=1&extend=address&has_parts=1&sales_target=All&has_sales_target=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"sort_field\":\"title\",\"sort_direction\":\"asc\",\"country_code\":\"va\",\"page\":73,\"per_page\":16,\"extend\":\"address\",\"has_parts\":true,\"sales_target\":\"All\",\"has_sales_target\":false}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/dealer-information", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/dealer-information", "query": [], "raw": "{{baseUrl}}\/api\/dealer-information" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"updated_since\":\"2026-10-13T14:20:32\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "A single dealer, same field shape as the listing (Azure DevOps #58591).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/dealer-information\/:company", "query": [], "raw": "{{baseUrl}}\/api\/dealer-information\/:company", "variable": [ { "id": "company", "key": "company", "value": "999", "description": "The dealer's company id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET a single dealer by slug.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/dealers\/:slug", "query": [], "raw": "{{baseUrl}}\/api\/dealers\/:slug", "variable": [ { "id": "slug", "key": "slug", "value": "alpha-tractors", "description": "The slug of the dealer." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/events\/callback", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/events\/callback", "query": [], "raw": "{{baseUrl}}\/api\/events\/callback" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "POST api\/events\/{topic}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/events\/:topic", "query": [], "raw": "{{baseUrl}}\/api\/events\/:topic", "variable": [ { "id": "topic", "key": "topic", "value": "in", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Display the specified resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/:company_id", "query": [], "raw": "{{baseUrl}}\/api\/companies\/:company_id", "variable": [ { "id": "company_id", "key": "company_id", "value": "1", "description": "The ID of the company." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update the specified resource in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/:company_id", "query": [], "raw": "{{baseUrl}}\/api\/companies\/:company_id", "variable": [ { "id": "company_id", "key": "company_id", "value": "1", "description": "The ID of the company." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"yguwbtaqcsedr\",\"company_type_id\":14,\"country_code\":\"aw\",\"vat_number\":\"vfzyjdpf\",\"currency_code\":\"xlr\",\"sales_target\":\"All\",\"website\":\"hiutkrqqr\",\"restricted_sell\":false,\"address\":{\"address1\":\"eaque\",\"address2\":\"impedit\",\"city\":\"mpxucykrimsopeagt\",\"postal_code\":\"rnqpkrmandhj\",\"phone_number\":\"unnpuijb\",\"company_email\":\"turner.carmen@example.org\",\"country_code\":\"gb\"}}" }, "description": "" }, "response": [] }, { "name": "Update the logo of the specified company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/:company_id\/logo", "query": [], "raw": "{{baseUrl}}\/api\/companies\/:company_id\/logo", "variable": [ { "id": "company_id", "key": "company_id", "value": "1", "description": "The ID of the company." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "logo", "src": [], "type": "file" } ] }, "description": "Converts the uploaded image to WebP (resized down to a maximum of 1024\npixels on the longest side, metadata stripped), stores it on the public\ndisk, and returns the company including the public logo_url to fetch\nthe logo from." }, "response": [] }, { "name": "Set which countries the company is allowed to sell to when\nrestricted_sell is true (Azure DevOps #58322). Accepts one or more\ncountries at a time; each is attached or detached independently, so\ncountries not included in the request are left untouched.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/:company_id\/allowed-countries", "query": [], "raw": "{{baseUrl}}\/api\/companies\/:company_id\/allowed-countries", "variable": [ { "id": "company_id", "key": "company_id", "value": "1", "description": "The ID of the company." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"countries\":[{\"country_code\":\"dk\",\"allowed\":true}]}" }, "description": "" }, "response": [] }, { "name": "Countries a customer may ship an inquiry to for this company (Azure\nDevOps #58720) - every country when restricted_sell is false (the\npivot is ignored, matching #58322's rule), otherwise only the\ncountries explicitly allowed. Public\/browsable: no company membership\nrequired, unlike updateAllowedCountries().", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/:company_id\/available-countries", "query": [], "raw": "{{baseUrl}}\/api\/companies\/:company_id\/available-countries", "variable": [ { "id": "company_id", "key": "company_id", "value": "1", "description": "The ID of the company." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "All 11 discount levels for a company (Azure DevOps #58255), any level\nwithout a configured row defaulting to 0%.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/:company_id\/discount-indices", "query": [], "raw": "{{baseUrl}}\/api\/companies\/:company_id\/discount-indices", "variable": [ { "id": "company_id", "key": "company_id", "value": "1", "description": "The ID of the company." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a single discount level's percentage for a company (Azure\nDevOps #58255). Uses upsert() rather than updateOrCreate()\/save():\nCompanyDiscountIndex declares company_id as its Eloquent primary key,\nbut the table's real key is the composite (company_id, discount_index)\n- a save() on an existing row would update by company_id alone and\nsilently overwrite every discount level for that company, not just\nthis one.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/:company_id\/discount-indices\/:discountIndex", "query": [], "raw": "{{baseUrl}}\/api\/companies\/:company_id\/discount-indices\/:discountIndex", "variable": [ { "id": "company_id", "key": "company_id", "value": "1", "description": "The ID of the company." }, { "id": "discountIndex", "key": "discountIndex", "value": "maiores", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"discount_index\":\"50\",\"discount_percentage\":13}" }, "description": "" }, "response": [] }, { "name": "The company's configured min\/max discount ranges by country (Azure\nDevOps #58741) - unlike discountIndices(), there is no fixed set of\nlevels; only countries the company has actually configured are\nreturned.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/:company_id\/country-discounts", "query": [], "raw": "{{baseUrl}}\/api\/companies\/:company_id\/country-discounts", "variable": [ { "id": "company_id", "key": "company_id", "value": "1", "description": "The ID of the company." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a single country's discount range for a company (Azure DevOps\n#58741). Uses upsert() for the same reason as updateDiscountIndex():\nthe table's real primary key is the composite (company_id,\ncountry_code), which CompanyCountryDiscount cannot declare.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/:company_id\/country-discounts\/:countryCode", "query": [], "raw": "{{baseUrl}}\/api\/companies\/:company_id\/country-discounts\/:countryCode", "variable": [ { "id": "company_id", "key": "company_id", "value": "1", "description": "The ID of the company." }, { "id": "countryCode", "key": "countryCode", "value": "dignissimos", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"country_code\":\"bt\",\"percent\":21,\"max_discount\":23}" }, "description": "" }, "response": [] }, { "name": "Remove a company's discount range for a country (Azure DevOps #58741).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/companies\/:company_id\/country-discounts\/:countryCode", "query": [], "raw": "{{baseUrl}}\/api\/companies\/:company_id\/country-discounts\/:countryCode", "variable": [ { "id": "company_id", "key": "company_id", "value": "1", "description": "The ID of the company." }, { "id": "countryCode", "key": "countryCode", "value": "magni", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Unlike discount levels, a country with no configured row simply has no\ndiscount range - there is no implicit default to fall back to." }, "response": [] }, { "name": "Live-check a VAT number while a registration form is being filled in\n(Azure DevOps #58486), before the dealer\/customer\/address form is\nsubmitted. A real VIES check for EU countries, a format check\notherwise - the same rule storeDealer\/storeCustomer enforce on submit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/vat\/validate", "query": [], "raw": "{{baseUrl}}\/api\/vat\/validate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"country_code\":\"dk\",\"vat_number\":\"DK12345678\"}" }, "description": "" }, "response": [] }, { "name": "Create an Admin user (role_id = 1).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/admin", "query": [], "raw": "{{baseUrl}}\/api\/users\/admin" }, "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\":\"secret-password\",\"language_code\":\"en\",\"marketing_consent\":false}" }, "description": "Only admins may create admin users." }, "response": [] }, { "name": "Add a user to the authenticated dealer's currently selected company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/company", "query": [], "raw": "{{baseUrl}}\/api\/users\/company" }, "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\",\"get_part_requests\":false}" }, "description": "If a user with the given email already exists, they are simply attached\nto the company and notified - no duplicate account, no email verification\n(their email was already verified previously). Otherwise a new Dealer\nuser is created; once they confirm their email a password is generated\nand emailed to them (see EmailVerificationController::verifyCompanyUser)." }, "response": [] }, { "name": "Update a user of the caller's company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/company\/:user_id", "query": [], "raw": "{{baseUrl}}\/api\/users\/company\/:user_id", "variable": [ { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"get_part_requests\":false}" }, "description": "Updates a user belonging to the authenticated dealer's currently\nselected company. Updating a colleague only get_part_requests may be\nchanged; updating yourself name and email may be changed as well." }, "response": [] }, { "name": "Remove a user from the caller's company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/company\/:user_id", "query": [ { "key": "confirm", "value": "1", "description": "Confirm deleting a company's last user (with its companies and parts). Without it the request is a dry run.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/users\/company\/:user_id?confirm=1", "variable": [ { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"confirm\":false}" }, "description": "Detaches the user from the caller's selected company. When that was the\nuser's last company, the account is soft deleted (tokens revoked, carts\nremoved); inquiries the user created are always preserved. Inviting the\nsame email again through the company user creation endpoint restores a\nsoft deleted account.\n\nRemoving the LAST user of the company is a two-step request: without\nthe confirm query parameter it dry runs and reports what would be\ndeleted; with confirm=1 it permanently deletes the parts of every\ncompany where this user is the last user, soft deletes those companies\nand the account, and reports what happened." }, "response": [] }, { "name": "Paginated list of users. Only allowed for admin users.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users", "query": [ { "key": "sort_field", "value": "name", "description": "The field to sort by. Valid values are: name, email, role_id and status.", "disabled": false }, { "key": "sort_direction", "value": "asc", "description": "The direction to sort by.", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "query", "value": "aage", "description": "Search across name, email, and related company name.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/users?sort_field=name&sort_direction=asc&per_page=10&page=1&query=aage" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search across name, email, and related company name." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Paginated list of users related to a specific company. Only allowed for admin users or users connected to the company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/company\/:company_id", "query": [ { "key": "sort_field", "value": "name", "description": "The field to sort by. Valid values are: name, email, role_id and status.", "disabled": false }, { "key": "sort_direction", "value": "asc", "description": "The direction to sort by.", "disabled": false }, { "key": "per_page", "value": "10", "description": "The number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "The page number.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/users\/company\/:company_id?sort_field=name&sort_direction=asc&per_page=10&page=1", "variable": [ { "id": "company_id", "key": "company_id", "value": "1", "description": "The ID of the company." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update the specified resource in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user_id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user_id", "variable": [ { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"ltjoyctzdb\",\"email\":\"helga.buckridge@example.com\",\"password\":\"Ymr?._kDp4P\",\"role_id\":\"3\",\"selected_company_id\":2,\"status\":\"active\",\"language_code\":\"xe\",\"get_part_requests\":true,\"marketing_consent\":true}" }, "description": "" }, "response": [] }, { "name": "Display the specified resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:user_id", "query": [], "raw": "{{baseUrl}}\/api\/users\/:user_id", "variable": [ { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Allow an admin to switch\/impersonate an existing Dealer or Customer user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/switch\/:user_id", "query": [], "raw": "{{baseUrl}}\/api\/users\/switch\/:user_id", "variable": [ { "id": "user_id", "key": "user_id", "value": "1", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Send a support email. The recipient is fixed by the backend, and a\nlogged-in user's own name\/email\/role\/company override anything the\nclient sends.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/support\/email", "query": [], "raw": "{{baseUrl}}\/api\/support\/email" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subject\":\"Help needed\",\"message\":\"I need help with my order.\",\"sender_email\":\"user@example.com\",\"sender_name\":\"John Doe\"}" }, "description": "" }, "response": [] }, { "name": "Create a Dealer user (role_id = 2) and its required company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/dealer", "query": [], "raw": "{{baseUrl}}\/api\/users\/dealer" }, "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\":\"secret-password\",\"language_code\":\"en\",\"secondary_language_code\":\"da\",\"status\":\"pending\",\"get_part_requests\":true,\"marketing_consent\":true,\"message\":\"Please approve my account.\",\"company\":{\"title\":\"Alpha Tractors\",\"country_code\":\"dk\",\"currency_code\":\"DKK\",\"vat_number\":\"DK12345678\",\"sales_target\":\"Dealers\",\"website\":\"https:\\\/\\\/alpha-tractors.example.com\",\"address\":{\"company_email\":\"inbox@alpha-tractors.example.com\",\"phone_number\":\"+45 12 34 56 78\"}}}" }, "description": "" }, "response": [] }, { "name": "Create a Customer user (role_id = 3). Company (with vat_number) is required (ADO #58508).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/customer", "query": [], "raw": "{{baseUrl}}\/api\/users\/customer" }, "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\":\"secret-password\",\"language_code\":\"en\",\"secondary_language_code\":\"da\",\"status\":\"pending\",\"get_part_requests\":true,\"marketing_consent\":true,\"message\":\"Please approve my account.\",\"company\":{\"title\":\"Beta Farms\",\"country_code\":\"dk\",\"currency_code\":\"DKK\",\"vat_number\":\"DK12345678\",\"website\":\"https:\\\/\\\/beta-farms.example.com\",\"address\":{\"address1\":\"Main Street 1\",\"address2\":\"Building B\",\"city\":\"Aarhus\",\"postal_code\":\"8000\",\"country_code\":\"dk\",\"company_email\":\"inbox@beta-farms.example.com\",\"phone_number\":\"+45 12 34 56 78\"}}}" }, "description": "" }, "response": [] }, { "name": "Verify the given user's email address via a signed, stateless link\n(the user is not authenticated when they click the link, so this\ncannot rely on Fortify's session-based verification routes).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/email\/verify\/:id\/:hash", "query": [], "raw": "{{baseUrl}}\/api\/email\/verify\/:id\/:hash", "variable": [ { "id": "id", "key": "id", "value": "culpa", "description": "The ID of the verify." }, { "id": "hash", "key": "hash", "value": "optio", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 403, "body": "{\n \"message\": \"Invalid signature.\"\n}", "name": "" } ] }, { "name": "Verify the email for a user added to a company via ADO #58304\n(App\\Http\\Controllers\\UserController::storeCompanyUser). Unlike the\nself-registration flow above, this activates the account immediately\nand generates+emails a password, since the user is joining an\nalready-vetted, active company rather than registering a new one.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/email\/verify\/company-user\/:id\/:hash", "query": [], "raw": "{{baseUrl}}\/api\/email\/verify\/company-user\/:id\/:hash", "variable": [ { "id": "id", "key": "id", "value": "iste", "description": "The ID of the company user." }, { "id": "hash", "key": "hash", "value": "dolore", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 403, "body": "{\n \"message\": \"Invalid signature.\"\n}", "name": "" } ] }, { "name": "GET api\/events\/test", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/events\/test", "query": [], "raw": "{{baseUrl}}\/api\/events\/test" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 200, "body": "This is a test", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "type": "string" } ] } }