Warwick Customer API
Welcome to the Warwick API. This API provides information for all Warwick products, and is for Warwick customer use only.
To request access to the API please contact your sales representative.
Using the Warwick API requires technical expertise and you will need to employ or contract a software developer. As an alternative, we provide a CSV export of the information contained in this API. To request access to the CSV please contact your sales representative.
The remainder of this page provides technical information. You should send this page to your website developer as well as the authentication details provided to you by your sales representative.
Authentication
Authentication is via token, and tokens can be requested by Warwick customers via their sales representative.
The token should be included in the Authorization header and prefixed by the string literal "Token", with whitespace separating the two strings. For example:
Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b
Unauthenticated requests will return a 401 (Unauthorized) response.
Rate Limits
Requests to the API are limited to:
- 5 per second; and
- 120 per minute
Rate limited requests will return a 429 (Too Many Requests) response.
The bulk of the product information provided by the API is imported from a product information system overnight. Changes throughout the business day are relatively infrequent and API consumers are therefore encouraged to cache data locally for the duration of the business day.
For this reason, all product information is included in the products list endpoint and usage of this endpoint (with appropriate caching) is encouraged over use of the product retrieve endpoint.
The product information system import typically concludes at approximately 3:30am NZST. Use of the API around this time may result in unexpected outcomes, for example during pagination.
Schema
The API schema is available in OpenAPI format, Swagger, or ReDoc via the links above.