API Overview
This describes the resources that make up the Provet Dropship API.
Endpoints
All API access is over HTTPS, and is accessed from the following domains:
| Url | Description |
|---|---|
| https://sandbox.dropship.provet.com.au | Sandbox environment for development and testing |
| https://dropship.provet.com.au | AU Production environment |
| https://dropship.provet.co.nz | NZ Production environment |
Versions
By default, all requests receive the v1 of the API. We encourage you to explicity request this version via the Accept header.
Authentication
The Dropship service is authenticated via Basic Authentication over HTTPS.
If you do not provide correct authentication details with each request, you will be returned a 401 Unauthorized HTTP Response.
Media Types
The API provides the following media types:
application/jsonapplication/xml
Errors
Any HTTP return code of 400 or greater is considered an error.
Any return code in the range 400-499 is considered a client side error.
And return code greater than or equal to 500 is considered a server side error.
Additional details of errors will be provided where applicable.
Pagination
Requests that return multiple items will be paginated to 20 items by default. You can specify further pages with the ?page parameter.
You can also set a custom page size with the ?pageSize parameter.
Page numbering is 1-based and that omitting the ?page parameter will return the first page.