API Usage Monitoring

We monitor your use of the API to improve our overall service to all partners and to ensure your compliance with this Fair Usage Policy.

Use of Our Push Services

Where possible, we strongly encourage the use of Push Services rather than Retrieve Services through the API. This results in less data being served and less data consumed by our partners. Push Services only send data when required and as such we apply no limits to data pushed.

Polling Mechanim

Avoid excessive use of the polling mechanism as this might make data retrieval slower and will increase the volume of data consumed.

Maintenance of Service Quality

In order to maintain a high quality service for all of our partners, we also impose reasonable limits on the way our services can be used. The following limitations must be observed:

The maximum length of the query string is 2048 bytes (including API Key).
Retrieve Dispatches: Please use "Push Dispatch Confirmation" service instead. If you have to use "Retrieve Dispatches", then please limit calls to every 30 minutes for active dispatches.
Retrieve Goods Received Notices: Please use "Push Goods Received Notice Confirmation" service instead. If you have to use "Retrieve Goods Received Notices", then please limit calls to every 30 minutes for active receipts.
Retrieve Stock Quantity: Please only call before loading a sales order, or once every 30 minutes for larger result sets.
Retrieve Delivery Arrivals: Please use "Push Delivery Arrive" service instead. If you have to use "Retrieve Delivery Arrivals", then please limit calls to once every hour.
Retrieve Stock Adjustments: Please use "Push Stock Adjustment" service instead. If you have to use "Retrieve Stock Adjustments", then please limit calls to once every hour.
Retrieve Tracking Details: Please use "Push Dispatch Confirmation" service instead. If you have to use "Retrieve Tracking Details", then please limit calls to every 30 minutes for active dispatches.
Load Sales Orders: When orders fail due to insufficient stock, please limit retry calls to once every hour.
Load Web Orders: When orders fail due to insufficient stock, please limit retry calls to once every hour.