apidocs.aithomedelivery.co.uk Open in urlscan Pro
44.209.144.191  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Public


Documentation Settings

ENVIRONMENT
Production

LAYOUT
Single Column

LANGUAGE
cURL - cURL



AIT Home Delivery - Client API (Docs)
Introduction
Client Actions
Order Actions
Storage Actions


AIT HOME DELIVERY - CLIENT API (DOCS)

AIT provides a simple API should you wish to integrate programatically rather
than using files/edi.

We 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.

The minimum TLS version our API will allow is TLS 1.2, any requests sent using
older TLS versions will be rejected.

We 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:

Note: An API key and portal username/password will be provided by your account
manager.

TEST ENVIRONMENT

Item Value API URL
https://client-api-staging.aithomedelivery.co.uk/apiv2/public/{action} API Key
{request from account manager} Portal Access
https://staging.aithomedelivery.co.uk

PRODUCTION ENVIRONMENT

Note: An API key and portal username/password will be provided by your account
manager.

Item Value API URL
https://client-api.aithomedelivery.co.uk/apiv2/public/{action} API Key {request
from account manager} Portal Access https://portal.aithomedelivery.co.uk

Once you are happy everything is working ok its very easy to switch live, simply
switch to use the PRODUCTION API details.

HTTP Response Codes

Our response codes are listed below:

View More

ResponseCode Description 200 Response OK 420 Order limit reached 421 Integration
Suspended 450 Unknown action 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 452 Order
not found 454 Validation errors 455 Cannot delete - order already routed 456
Postcode not recognised 498 No API key/token sent 499 Invalid API key/token
received 503 Service Unavailable (see Throttling section below)

Throttling

Currently, 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.