Vanilo REST API

The Vanilo REST API is primarily built for integration with other systems.

It is an HTTP-based, RESTful API, having the following main characteristics:

• It gives admin-level access to all data in the system;
• URLs are resource-oriented;
• Uses the Bearer authentication method;
• Responds with standard HTTP response codes to indicate errors;
• Returns JSON.

SDK

To make it easier working with the Vanilo Cloud REST API, there's a PHP SDK available:

• https://github.com/vaniloecc/vcl-php-sdk

OpenAPI (Swagger) Specification

The API has an OpenAPI specification page at:

• Vanilo API Reference (Modern UI)
• Vanilo API Reference (Swagger UI)

Base URL

Vanilo Cloud API calls referenced in this documentation start with a base URL. Vanilo offers live and sandbox environments. Be sure to use the appropriate base URL based on which environment you want to target.

Vanilo uses URI versioning for the API endpoints.

The Base URL depends on your shop URL:

https://your-shop.v-shop.cloud/api/1.0/

For sandbox environments, the URL looks something like:

https://sandbox.your-shop.v-shop.cloud/api/1.0

Next Steps

• API Authentication
• API Conventions