{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a884afa3-58e3-4fbc-9e9e-948d3a308260","name":"Matter Management API v1","description":"The **Matter Management External API v1** enables customers to seamlessly interact with the system to manage orders, view product catalogues, query invoices, and access related documents. This API facilitates smooth integration with external systems, allowing customers to perform essential business operations efficiently.\n\n## **Getting Started**\n\nTo begin using the API, customers must first obtain their credentials. This is achieved by registering on the Matter Management Portal. Once registered, customers must submit a request to the Wessex Searches Team to enable API trade. The Wessex Searches Team will review and approve the request, after which the API will be accessible with the provided credentials.\n\n## **Available Operations**\n\n### **1\\. Authentication (/auth)**\n\nThe **Auth** folder contains endpoints to manage user authentication and access control. This ensures secure access to the system. Users must authenticate via the `/auth/login` endpoint to obtain an access token, which is required for all subsequent API requests.\n\n**Key Operation:**\n\n- **Login (/auth/login)** – Authenticate users and generate access tokens.\n    \n\n---\n\n### **2\\. Product Catalogue and Price Enquiry**\n\nCustomers can browse the available product catalogue and check product prices. This operation enables them to view product details and associated pricing, allowing for informed decision-making before placing orders.\n\n**Key Operations:**\n\n- **View Product Catalogue** – Retrieve the list of available products.\n    \n- **Price Enquiry** – Request product pricing information.\n    \n\n---\n\n### **3\\. Order Management**\n\nCustomers can place and manage their orders using this API. It provides endpoints to create new orders, view existing orders, and access order details.\n\n**Key Operations:**\n\n- **Create Order** – Submit a new order request.\n    \n- **List of Orders** – View a summary of all orders associated with the user's account.\n    \n- **Order Details** – Retrieve detailed information about a specific order.\n    \n\n---\n\n### **4\\. Invoice Queries**\n\nThis API allows customers to access and query invoices. Customers can view invoices at different levels, including all invoices, invoices for a specific branch, or invoices related to a specific user.\n\n**Key Operations:**\n\n- **All Invoices** – Retrieve all invoices associated with the customer account.\n    \n- **Branch Invoices** – Retrieve invoices linked to a specific branch.\n    \n- **User Invoices** – Retrieve invoices that are linked to the specific user's activity.\n    \n\n---\n\n### **5\\. Document Management**\n\nThis API provides access to documents related to orders and order lines. Customers can retrieve document metadata, download specific order-related documents, and access supporting files for order lines.\n\n**Key Operations:**\n\n- **Get Order Documents** – Retrieve a list of documents attached to an order.\n    \n- **Get Order Line Documents** – Retrieve a list of documents attached to an order line.\n    \n- **Download Order Document** – Download a document linked to an order.\n    \n- **Download Order Line Document** – Download a document linked to an order line.\n    \n\n---\n\n## **Usage Notes**\n\n- **Authentication Required**: All API requests, except for the `/auth/login` endpoint, require a valid access token to be included in the `Authorization` header as a **Bearer Token**.\n    \n- **Security**: The API employs secure access mechanisms, ensuring that only authorised users can perform the available operations.\n    \n- **Data Filtering**: Customers can query specific invoices or order details based on user, branch, or order ID.\n    \n\nThis API enables customers to integrate their systems with the Matter Management platform, facilitating seamless interaction for order processing, document retrieval, and financial tracking.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"33506024","collectionId":"a884afa3-58e3-4fbc-9e9e-948d3a308260","publishedId":"2sAYHwKkCw","public":true,"publicUrl":"https://searches-sit.api.dynamics365.co.uk","privateUrl":"https://go.postman.co/documentation/33506024-a884afa3-58e3-4fbc-9e9e-948d3a308260","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"Enable seamless integration with Wessex Searches using the Matter Management External API v1. Order directly through the API and integrate with your preferred applications for streamlined order processing and delivery into our system."},{"name":"title","value":"Matter Management External API v1 | Seamless Integration for Wessex Searches Orders"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/89fcedd3-d190-431a-b4d4-e7ed73c2a8d3/V2Vzc2V4X1NlYXJjaGVzX0xvZ28ucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/89fcedd3-d190-431a-b4d4-e7ed73c2a8d3/V2Vzc2V4X1NlYXJjaGVzX0xvZ28ucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-12-27T11:39:40.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Matter Management External API v1 | Seamless Integration for Wessex Searches Orders","description":"Enable seamless integration with Wessex Searches using the Matter Management External API v1. Order directly through the API and integrate with your preferred applications for streamlined order processing and delivery into our system."},"logos":{"logoLight":"https://content.pstmn.io/89fcedd3-d190-431a-b4d4-e7ed73c2a8d3/V2Vzc2V4X1NlYXJjaGVzX0xvZ28ucG5n","logoDark":"https://content.pstmn.io/89fcedd3-d190-431a-b4d4-e7ed73c2a8d3/V2Vzc2V4X1NlYXJjaGVzX0xvZ28ucG5n"}},"statusCode":200},"environments":[{"name":"searches-sit","id":"63492470-3928-4e21-928a-8bf61abe406f","owner":"6867850","values":[{"key":"tenant","value":"wessexwater.co.uk","enabled":true,"type":"default"},{"key":"clientid","value":"ef078699-2241-4b1b-b0b0-9db6547edf96","enabled":true,"type":"default"},{"key":"secret","value":"dDW8Q~GL.fX3.Bac8TwLKoX~OE9Fysk5BOflectx","enabled":true,"type":"default"},{"key":"url","value":"https://searches-sit.sandbox.operations.dynamics.com","enabled":true,"type":"default"},{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6InEtMjNmYWxldlpoaEQzaG05Q1Fia1A1TVF5VSIsImtpZCI6InEtMjNmYWxldlpoaEQzaG05Q1Fia1A1TVF5VSJ9.eyJhdWQiOiJodHRwczovL3NlYXJjaGVzLXNpdC5zYW5kYm94Lm9wZXJhdGlvbnMuZHluYW1pY3MuY29tIiwiaXNzIjoiaHR0cHM6Ly9zdHMud2luZG93cy5uZXQvZDE0OTE1YWYtZmMzNS00MWRmLTkzZWItNjYxMjJiZjFmMjRhLyIsImlhdCI6MTcxMjY4MzYxNiwibmJmIjoxNzEyNjgzNjE2LCJleHAiOjE3MTI2ODc1MTYsImFpbyI6IkUyTmdZSkNPbjdqQjdjR2xhUnF2RGZvNGJMbW5BZ0E9IiwiYXBwaWQiOiIxZWJjOTc4OS00NDhlLTRkYWUtODRlNC0yOWYyODMxNzJkZmEiLCJhcHBpZGFjciI6IjEiLCJpZHAiOiJodHRwczovL3N0cy53aW5kb3dzLm5ldC9kMTQ5MTVhZi1mYzM1LTQxZGYtOTNlYi02NjEyMmJmMWYyNGEvIiwicmgiOiIwLkFTOEFyeFZKMFRYODMwR1Q2MllTS19IeVNoVUFBQUFBQUFBQXdBQUFBQUFBQUFDd0FBQS4iLCJ0aWQiOiJkMTQ5MTVhZi1mYzM1LTQxZGYtOTNlYi02NjEyMmJmMWYyNGEiLCJ1dGkiOiI3MHZZcl9RUzRVS3llT216MlVLQkFBIiwidmVyIjoiMS4wIn0.oss98LnYsnIeRZn8yx4OI3ZwY8zkMWGHlJ2DiAjzzEnMIdOioiVf3e3_3uopas_hpaaAxHyiBH3mu9Y7Kkadq_-JN7Zwm0PaR5lhNJgT-4CInTgNSVx-4ZXBTewqyL21UuKiRbB-PZ-AqltlL-SMRgVP39FLe2wBPmmwP7zA5QQV3KgyFdN87Fkh3ey5qTzrcJR7lIaOT_wfvWbqpNC1TegUuIC7oOc86DdcqmPrbpvrdNczRnrBOkCRQTFbwRXFjHqiByaaDSQ_Ac5wtAGT-9R8mUSQPKT46klWFAO-ZupLXLaBmT2r0eX7j8OBX_xxdE6xUN5JLlMCj-jxyDhQaw","enabled":true,"type":"any"},{"key":"path","value":"postcode?postcode=SK102NG","enabled":true,"type":"default"},{"key":"os-api-key","value":"TeKgGzG2A3opAKN7gSQpGey9VEAbwxpG","enabled":true,"type":"default"},{"key":"serviceUrl","value":"https://searches-sit.sandbox.operations.dynamics.com/api/services/MatterManagement/","enabled":true,"type":"default"},{"key":"nxUrl","value":"https://searches-sit.csu.azureapp.net/api","enabled":true,"type":"default"},{"key":"nxToken","value":"TOKEN-OBTAINED-FROM-API","enabled":true,"type":"default"},{"key":"userPassword","value":"userpassword","enabled":true,"type":"default"},{"key":"userEmail","value":"username@email.com","enabled":true,"type":"default"},{"key":"w3w-api-key","value":"LNMV3VV9","enabled":true,"type":"default"},{"key":"externalToken","value":"","enabled":true,"type":"any"},{"key":"nxAppToken","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/269c9ca3f2e9ee2fcffbe62b982688fdcda976f217b9d4cf82202c63c1fca6bf","favicon":"https://dynamics365.co.uk/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"searches-sit","value":"6867850-63492470-3928-4e21-928a-8bf61abe406f"}],"canonicalUrl":"https://searches-sit.api.dynamics365.co.uk/view/metadata/2sAYHwKkCw"}