Version 2.0 Realease Candidate 1
\nThis API documentation is currently going through final review and may have some minor changes.
\nThe TMT Connect API Service enables you to integrate your systems with TMT First to support the automated processing of devices.
\nEmail: business@tmtfirst.co.uk
\nPhone: 01782 576920
\nReplace URL references to \"{{URL}}\" with the URL of the environment listed below:
\nPROD
\n\nTEST
\n\nAs our systems and services are updated, responses from our API endpoints may include new data fields so it's important your system allows for the additional fields or simply ignores them.
\nWe won't change existing field names or response structures without providing notice.
\nWhen testing against our Test environment, the API treats jobs differently based on customer reference prefixes:
\nPrefix \"0-\" (e.g., \"0-ref1\"): This will automatically advance the job to the Quote Stage, allowing you to test scenarios such as viewing, accepting, or rejecting quotes.
\nPrefix \"1-\" (e.g., \"1-ref2\"): This will push the job through as 'Cannot be Repaired' and randomly select between the statuses 'No Fault Found' or 'Beyond Economic Repair (BER)'.
\nIf the customer reference is not prefixed with \"0-\" or \"1-\", no automatic status changes will occur.
\nAll Connect endpoints have a rate limit of 60 / minute.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Environments","slug":"environments"},{"content":"Testing","slug":"testing"},{"content":"Rate Limits","slug":"rate-limits"}],"owner":"19015415","collectionId":"3a64f96d-8a42-4d99-a835-ae4b1811f91a","publishedId":"2s93JowQek","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2024-06-18T10:44:27.000Z"},"item":[{"name":"Authentication","item":[],"id":"f6b61efd-d840-4da9-bb6e-2015f37064d3","description":"Our API uses API keys to authenticate requests. An API key is a unique identifier that allows you to access the API.
\nYour API key can be generated by an Organisation Admin within the Manage My Organisation screen.
\nInclude your API key in the 'Authorization' header of your requests. The format of the header should be as follows:
\nAuthorization: <your-api-key>\n\nThe '/prealert' endpoint is used to send us the device/job details.
\n{\n \"customer_reference\": \"REF124\",\n \"po_number\": \"PO123456\",\n \"make\": \"Samsung\",\n \"model\": \"Galaxy S20\",\n \"imei\": \"123456789012347\",\n \"serial_number\": \"SN123454\",\n \"job_description\": \"Job / Repair Details\",\n \"ra_flag\": 0,\n \"return_address\": null,\n \"user_name\": \"John Doe\"\n}\n\nThe '/devices' endpoint retrieves a list of all your devices.
\n","urlObject":{"path":["devices"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d0956761-ba5e-45c4-845f-edfdfcb8fca7","name":"devices","originalRequest":{"header":[]},"_postman_previewlanguage":"","header":[""],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\r\n {\r\n \"connect_id\": 12345,\r\n \"customer_reference\": \"\",\r\n \"date_in\": \"Tue, 23 Apr 2024 09:30:00 GMT\",\r\n \"date_out\": \"Tue, 14 May 2024 15:35:26 GMT\",\r\n \"date_received\": \"Thu, 25 Apr 2024 08:23:50 GMT\",\r\n \"imei\": \"123456789123456\",\r\n \"job_description\": \"Broken Screen\",\r\n \"job_id\": 123456,\r\n \"make\": \"Samsung\",\r\n \"model\": \"SM-G525F\",\r\n \"notes\": \"Screen\",\r\n \"po_number\": \"\",\r\n \"quote\": {\r\n \"quote_price\": \"100.00\",\r\n \"quote_status\": 1,\r\n \"quote_update_date\": \"Wed, 08 May 2024 07:43:24 GMT\",\r\n \"repair_outcome\": \"Repaired\",\r\n \"repairable\": \"Y\",\r\n \"triage_conditions\": \"Broken Display\"\r\n },\r\n \"ra_flag\": 0,\r\n \"serial_number\": \"X123456X\",\r\n \"status\": \"DISPATCHED\",\r\n \"tracking_number\": \"123456789\"\r\n },\r\n {\r\n \"connect_id\": 12346,\r\n \"customer_reference\": \"\",\r\n \"date_in\": \"Tue, 23 Apr 2024 09:30:00 GMT\",\r\n \"date_out\": \"Tue, 14 May 2024 15:35:26 GMT\",\r\n \"date_received\": \"Thu, 25 Apr 2024 08:23:50 GMT\",\r\n \"imei\": \"123456789123457\",\r\n \"job_description\": \"Broken Screen\",\r\n \"job_id\": 123457,\r\n \"make\": \"Samsung\",\r\n \"model\": \"SM-G525F\",\r\n \"notes\": \"Screen\",\r\n \"po_number\": \"\",\r\n \"quote\": {\r\n \"quote_price\": \"100.00\",\r\n \"quote_status\": 1,\r\n \"quote_update_date\": \"Wed, 08 May 2024 07:43:24 GMT\",\r\n \"repair_outcome\": \"Repaired\",\r\n \"repairable\": \"Y\",\r\n \"triage_conditions\": \"Broken Display\"\r\n },\r\n \"ra_flag\": 0,\r\n \"serial_number\": \"X123457X\",\r\n \"status\": \"DISPATCHED\",\r\n \"tracking_number\": \"1234567890\"\r\n }\r\n]"}],"_postman_id":"4bd60101-690f-49eb-8c09-178b8d200554"},{"name":"job","id":"841f3d9b-b4a7-4661-aa2e-8fda7831a267","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"Authorization","value":"The '/job' endpoint retrieves details of the specified device/job.
\n","urlObject":{"path":["job","The '/get-quotes' endpoint retrieves a list of devices with outstanding quotes. Use this endpoint to fetch information about devices that have pending quotes associated with them.
\n","urlObject":{"path":["get-quotes"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"8bf949c1-17d8-4ffb-adcf-88ed4c1000c2","name":"get-quotes","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"connect_id\": 123456,\n \"job_id\": 123456,\n \"quote_price\": \"100.00\",\n \"repairable\": \"Y\",\n \"triage_conditions\": \"Triage Finding 1, Triage Finding 2\"\n }\n]"}],"_postman_id":"9735d188-6b63-4c4e-99f6-9740bae3b4ce"},{"name":"quote-response","id":"8ee5e063-0f0f-4628-a0b5-8bb4b54ebb53","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Authorization","value":"The '/quote-response' endpoint enables you to accept or reject a quote.
\n","urlObject":{"path":["quote-response"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6a388068-4733-48a7-b198-1b1070b4e8ae","name":"quote-response REJECTED","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Purchase Order numbers can be added during the Pre-Alert call, if it's unknown at that time, you can use this enpoint to update it, PO numbers can only be added if one doesn't already exist.
\n","urlObject":{"path":["update-po"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"27da0dda-b418-4e26-9e37-e68fa9e6828c","name":"update-po","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"connect_id\": 12345,\r\n \"po_number\": \"\",\r\n \"user_name\": \"John Doe\"\r\n}","options":{"raw":{"language":"json"}}}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"PO number updated successfully\"\n}"},{"id":"5ab27f17-a077-4eb0-a327-b15e1b21eebe","name":"update-po (not empty)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"connect_id\": 12345,\r\n \"po_number\": \"\",\r\n \"user_name\": \"John Doe\"\r\n}","options":{"raw":{"language":"json"}}}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"error\": \"PO number can only be updated if it is currently empty\"\n}"}],"_postman_id":"336f6474-5731-4579-99b2-e200b319cdaf"}],"id":"f476b0e9-20b5-443f-91ca-6d6d54866e55","_postman_id":"f476b0e9-20b5-443f-91ca-6d6d54866e55","description":""},{"name":"Appendix","item":[{"name":"Manufacturer List","item":[],"id":"36786eea-4a2a-447e-8dba-5e8f90bdbba2","description":"Please use the relevant brand/manufacturer mentioned below, if you have a manufacturer that's not listed below, please contact us.
\n","_postman_id":"36786eea-4a2a-447e-8dba-5e8f90bdbba2"},{"name":"Status List","item":[],"id":"0e0163bf-f137-4dc6-b6ed-7696a2fd8c7b","description":"These are the different statuses and what they mean.
\n*Please Note - Completed means it has finished the repair process but doesn't mean it's repaired, the outcome of the repair process will be stated in the API Data and Connect Portal.
\n","_postman_id":"0e0163bf-f137-4dc6-b6ed-7696a2fd8c7b"}],"id":"1dbf06a6-8633-49f9-bc11-33e54ce9f7c8","_postman_id":"1dbf06a6-8633-49f9-bc11-33e54ce9f7c8","description":""}]}