{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"55d25086-4ee4-48aa-97fd-bab0b8d8dbd5","name":"AIT Home Delivery - Client API (Docs)","description":"AIT provides a simple API should you wish to integrate programatically rather than using files/edi.\n\nWe accept either json or xml payloads as simple http posts and return either json or xml responses. Actions are defined on this page, you can see dev/production environment endpoints using the environment switcher on the top right. If you use POSTMAN for api testing you can click RUN IN POSTMAN on the top right of this page to start testing our API immediately.\n\nThe minimum TLS version our API will allow is TLS 1.2, any requests sent using older TLS versions will be rejected.\n\nWe operate a test/sandbox server so you can complete your integration in safety before switching to our production environment, please select the desired environment at the top left of this postman collection to view the endpoint urls:\n\nNote: An API key and portal username/password will be provided by your account manager.\n\n**TEST ENVIRONMENT**\n\n| Item | Value |\n| --- | --- |\n| API URL | [https://client-api-staging.uk.aithomedelivery.com/apiv2/public/{action}](https://client-api-staging.uk.aithomedelivery.com/apiv2/public/%7Baction%7D) |\n| API Key | {request from account manager} |\n| Portal Access | [https://staging.aithomedelivery.co.uk](https://staging.aithomedelivery.co.uk) |\n\n**PRODUCTION ENVIRONMENT**\n\nNote: An API key and portal username/password will be provided by your account manager.\n\n| Item | Value |\n| --- | --- |\n| API URL | [https://client-api.uk.aithomedelivery.com/apiv2/public/{action}](https://client-api.uk.aithomedelivery.com/apiv2/public/%7Baction%7D) |\n| API Key | {request from account manager} |\n| Portal Access | [https://portal.aithomedelivery.co.uk](https://portal.aithomedelivery.co.uk) |\n\nOnce you are happy everything is working ok its very easy to switch live, simply switch to use the PRODUCTION API details.\n\n**HTTP Response Codes**\n\nOur response codes are listed below:\n\n| ResponseCode | Description |\n| --- | --- |\n| 200 | Response OK |\n| 420 | Order limit reached |\n| 421 | Integration Suspended |\n| 450 | Unknown action |\n| 451 | Wrong parameters (can be missing or extra parameters). Note: Sometimes you can see this if you are incorrectly setting the content type please use text/xml as the content type not urlencoded |\n| 452 | Order not found |\n| 454 | Validation errors |\n| 455 | Cannot delete - order already routed |\n| 456 | Postcode not recognised |\n| 498 | No API key/token sent |\n| 499 | Invalid API key/token received |\n| 503 | Service Unavailable (see Throttling section below) |\n\n**Throttling**\n\nCurrently, the API access is throttled to allow a max of 3 requests per second. Although some contingency is allowed for special scenarios, once that limit is exceeded the response will hold an HTTP 503 message.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1517985","team":43321,"collectionId":"55d25086-4ee4-48aa-97fd-bab0b8d8dbd5","publishedId":"2sA3QpCZCr","public":true,"publicUrl":"https://apidocs.aithomedelivery.co.uk","privateUrl":"https://go.postman.co/documentation/1517985-55d25086-4ee4-48aa-97fd-bab0b8d8dbd5","customColor":{"top-bar":"0055A5","right-sidebar":"303030","highlight":"0055A5"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/40978e88-28aa-4f26-bcc0-29d9e6cb90ec/Y3JvcHBlZC1BSVQtSG9tZS1EZWxpdmVyeS1Mb2dvLVdoaXRlLTEucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/56718b19-6918-4e27-bb1c-9cbada3ff6e8/Y3JvcHBlZC1BSVQtSG9tZS1EZWxpdmVyeS1Mb2dvLVdoaXRlLTEucG5n","colors":{"top-bar":"0055A5","right-sidebar":"303030","highlight":"0055A5"}}]}},"version":"8.10.1","publishDate":"2024-05-23T10:57:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/56718b19-6918-4e27-bb1c-9cbada3ff6e8/Y3JvcHBlZC1BSVQtSG9tZS1EZWxpdmVyeS1Mb2dvLVdoaXRlLTEucG5n","logoDark":"https://content.pstmn.io/40978e88-28aa-4f26-bcc0-29d9e6cb90ec/Y3JvcHBlZC1BSVQtSG9tZS1EZWxpdmVyeS1Mb2dvLVdoaXRlLTEucG5n"}},"statusCode":200},"environments":[{"name":"Production","id":"30f4f882-41ee-44c5-b84b-92cfeab2874b","owner":"1517985","values":[{"key":"url","value":"https://client-api.aithomedelivery.co.uk/apiv2/public","enabled":true},{"key":"api_token","value":"TEST_TOKEN","enabled":true},{"key":"env","value":"PRODUCTION","enabled":true,"type":"default"},{"key":"portal","value":"https://portal.aithomedelivery.co.uk","enabled":true,"type":"default"}],"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/4e10ecaf43346bfbf6432e22b6ccccea184282257f0d826b0e2a760861aa5ce7","favicon":"https://aithomedelivery.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":"Production","value":"1517985-30f4f882-41ee-44c5-b84b-92cfeab2874b"}],"canonicalUrl":"https://apidocs.aithomedelivery.co.uk/view/metadata/2sA3QpCZCr"}