🚧
Notice to Ferret API (v1) users
We’re excited to announce the beta release of Ferret API v2, offering a more consistent and expanded approach, with access to a wider range of objects.
New clients are encouraged to start with Ferret API v2 and/or Octopus API to take advantage of the latest updates. Existing clients are also encouraged to transition to v2, although Ferret API v1 will remain stable and fully operational. For those looking to migrate to the Octopus API, we’ve prepared a detailed migration guide.

About Ferret API

The Ferret API is a business layer API that operates using the REST protocol. It is user-friendly and straightforward to utilize.

It works only for cloud users only.

Endpoints versions

Endpoints are categorized by the following versions:

❗️
STUB
Endpoint is currently returning stub data, it is still a work in progress.

🚧
DEVELOPMENT
Endpoint is currently working on a development version. You will be able to see real data, however, data structure is subject to change.

📘
STAGING
Endpoint is currently working on a staging version, and is under user acceptance tests.

👍
PRODUCTION
Endpoint is stable and ready to be consumed.

Rate limits and accounts

Maximizer APIs are subject to rate limiting. These limits are applied per account for custom integrations using VendorId/AppKey pairs or per app per account for integrations using OAuth. You can see the specific limits detailed in our full API guidelines.

Each Maximizer account will have access to different APIs based on the products and product levels it has. You can see a detailed breakdown for which APIs are supported for each product level on our APIs by Product Tier page.

Date and times

🚧
DATE AND TIME TO UTC
All date and times for requests that create, or update (POST, PUT) resources are converted to UTC.
All date and times on read operations (GET) are in UTC.