Divendo API 2.0

We’ve rebuilt our API from the ground up to be easier than ever to integrate our platform with your favourite software

Getting Started

With the Divendo API 2.0, you can integrate seamlessly with your store and automate a wide range of e-commerce, business and customer relationship tasks. Our API features a RESTful architecture allowing to you extend your store in the language of your choosing.

After reading through this guide, be sure to explore our API Reference articles to see all available API requests.

Before you start

Divendo's API is intended for use by developers, systems engineers, or anybody else who is comfortable creating bespoke solutions integrating with RESTful API's. If you think that you may need some assistance, or would like us to help develop a custom tool for your needs - feel free to connect with one of our experts.

Current release

The current release of the Divendo API can be found at the following location:

https://api.diven.do

Resources

The API consists of a wide-range of endpoints, which are typically resources like ‘products’ or ‘orders’ that you take actions on using supported HTTP methods.

Each resource is typically separated into a resource/{id} format, with subresources following the same pattern. For example, if you’re looking for information about orders, make a GET request to https://api.diven.do/orders. To access an individual order, make a GET request to https://api.diven.do/orders/{orderid}.

Authentication and Authorization

The Divendo REST API uses the OAuth 2.0 protocol to authorise calls. OAuth is an open standard that many companies use to provide secure access to protected resources.

When you register a new API user, Divendo generates a set of OAuth client ID and secret credentials for your application. You pass these credentials in the Authorization header in a get access token request.

In exchange for these credentials, Divendo's authorisation server issues access tokens called bearer tokens that you use for authorisation when you make REST API requests. A bearer token enables you to complete actions on behalf of, and with the approval of, the resource owner.

Be sure to explore our Authentication guide to see example authentication requests and responses.

HTTP Methods

The Divendo API supports 4 HTTP methods/verbs for interacting with resources:

GET/resource/{id}

Make a GET request to retrieve data. GET requests will never cause an update or change to your data.

POST/resource

Use a POST request to create new resources. For example, make a POST request to a collection endpoint (like /products) where the body of your request JSON is a new product.

PUT/resource/{id}

Use a PUT request to update an existing resource. This method is most commonly used for keeping resources in-sync with internal data.

DELETE/resource/{id}

Make a DELETE request to remove a resource permanently.

JSON

Divendo's API only supports JSON. So instead of XML, HTTP POST parameters, or other serialisation formats, most POST and PUT requests require a valid JSON object for the body.

Throttling

To improve connections and experiences for all our users, the Divendo API enforces some connection limits when we see suspicious activity or other overloads. Each user account is permitted up to 5 simultaneous connections, and if you reach the threshold, you will receive an error message to this effect.

Downtime

Divendo's API has a 99.9% uptime. It's very rare we're offline for planned maintenance, for example as part of necessary updates. If we do have downtime, we'll provide updates via our online status portal.