API Overview

Version 2.0.0

Endpoints

All API access is over HTTPS, and is accessed from the following domains:

Url	Description
https://sandbox.dropship.provet.com.au/v2	Sandbox environment for development and testing
https://dropship.provet.com.au/v2	AU Production environment
https://dropship.provet.co.nz/v2	NZ Production environment

Versions

To utilise Version 2 of the Provet Dropship API, /v2 needs to be appended to the endpoint domain. Otherwise Version 1 will be used.

eg: https://dropship.provet.com.au/v2/...

Authentication

The Dropship service is authenticated via Token Authentication over HTTPS.
If you do not provide correct authentication details with each request, you will be returned a 401 Unauthorized HTTP Response.

The following tokens are required to be placed in the headers of each request:

Application key - this is the key to identify your unique application. This is to be shared amongst your integrations
Application-Key
Account key - this is the key to identify the Provet Account for the Dropship service
Account-Key

Media Types

The Dropship API provides the following media types:

application/json

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.

Please see the Swagger Documentation for the relevant return objects.

Creating an Order

The following properties / rules are to be considered when integrating with the Orders endpoint

Metadata - string dictionary used to hold specific data relating to the integrator's system. This is stored and returned along with the order
Items.Metadata - string dictionary utilised as above for storing item related data
OrderCarrierService - set the preferred carrier service available for the order. This can be found via the ShippingEstimate endpoint.
If this is not supplied, the Dropship service will select the most appropriate carrier service available
DeliverToVetAccountNumber - Provet Account number. If set, the Dropship order wil be sent to the address of the nominated clinic identified by via the account number
ShippingAddress.Country - the 2 character reference of a country (eg: AU)
Status
- Ordered placed in the system
- Sent sent to the warehouse
- AwaitingStock one or more lines cannot be fulfilled
- Shipped order has been shipped
- Cancelled order has been cancelled

International Orders
Orders can be shipped globally (outside of Australia), with the following conditions:

An estimate of the ETA and freight price cannot be given for orders outside of Australia (AU)
In this case, ShipmentOptions[i].Price = null and ShipmentOptions[i].Eta = null

Products

The following properties / rules are to be considered when integrating with the Products endpoint

Status
- InStock Product is in stock and can be ordered
- TemporarilyUnavailable Product is temporarily unavailable
- Discontinued Product is no longer stocked and is not orderable

Testing an Order `sandbox only`

Orders will automatically have their status progressed to Shipped after 15 minutes.

Although Dropship handles the status updates, you can force the sandbox to change the status to Cancelled or Awaiting Stock by using the following data during order creation.

Awaiting Stock

To test a line that cannot be fulfilled (out of stock), order a quantity greater than or equal to 1000. The system will recognise this amount and notify via the status Awaiting Stock.
The awaiting stock status will change to Shipped after 30 minutes.
{ "Items[i].Quantity": "1000" }

Cancelled

To test a cancelled order, place the word cancel in the DeliveryInstructions field.
Note: Orders cannot be cancelled from a client request. This is to simulate an order being cancelled from Provet.
{ "DeliveryInstructions": "cancel" }

API Usage Example

Examples of consuming the Provet Dropship API via common languages.

Note: this is a trivial example and is used as a starting point to illustrate how to consume the API data