REST API Access for Business Integration

REST API Access for Business Integration

REST API Access for Business Integration

Step-by-step

How to Get Vendtill REST API Access for Business Integration

If you're looking to integrate Vendtill POS with your own inventory, accounting, or ERP system, our REST API allows you to securely access business-critical data like products, orders, stock levels, and more.

This guide will help you get started with accessing and using Vendtill APIs effectively.

NOTICE !

Webhook support is now available in the Vendtill POS system.

Developers can now receive real-time notifications for key events such as product updates, inventory changes, customer records, receipts, and credit notes.
Instead of polling the API for updates, use webhooks to automatically receive event data via HTTP POST requests to your configured URL. 

What You Can Do with Vendtill API

Vendtill currently provides REST API access for the following resources:

  • Categories
  • Subcategories
  • Measurements
  • Taxes
  • Customers
  • Suppliers
  • Products
  • Receipts
  • Orders
  • Shops
  • Payment Types
  • GRN (Goods Received Notes)
  • Inventory

You can use these APIs to build real-time integrations with your internal systems.

Generate an Access Token

Step 1: Generate an Access Token

To authenticate API requests, you need a personal access token.

Here’s how to get it:

  1. Log in to Vendtill Backoffice
  2. Go to Integrations > Access Token
  3. Click Generate Token
  4. Copy the token securely (you’ll use this in your API requests)

Keep this token confidential and never expose it publicly.

Step 2: Set Up Your Environment (Optional for Developers)

To test the API using Postman:

  1. Download Postman: https://www.postman.com/downloads/
  2. Import the Vendtill API Collection into Postman
  3. Define variables in Postman environment:
    • baseUrl: https://api.vendtill.com/v1.0
    • Token: Your personal access token from Step 1

This setup allows for streamlined testing across multiple endpoints.

Example: How to Call the Products API

Endpoint to Get Product List:

bash

GET /products

 

Full URL:

bash

https://api.vendtill.com/v1.0/products

 

Headers Required:

pgsql

Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

 

Sample cURL Request:

bash

curl --request GET \
--url https://api.vendtillpos.com/v1.0/products \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'Content-Type: application/json'

This will return a paginated list of products. Use the cursor parameter to navigate large datasets.

Handling Pagination

  • By default, responses are limited to 10 items.
  • You can increase this using ?limit=100 (max 250).
  • Use the cursor from the response to fetch the next batch.

API Rate Limits

Vendtill APIs are rate-limited:

  • 300 requests per 300 seconds per account
  • If exceeded, you'll receive an HTTP 429 error

Plan your integration to respect this limit and implement retry logic if necessary.

Date & Time Format

All timestamps in the API follow 24-hour format. Make sure to convert them to your local time zone as needed.

API Versioning

All API endpoints follow versioning in the base URL:

arduino

https://api.vendtill.com/v1.0

Future updates may include new versions (e.g., v1.1, v2.0), so be sure to reference the correct one.

Need Help?

If you have any issues or need help with your API integration:

We’re happy to assist!

    • Related Articles

    • E-commerce Integration with Vendtill POS ( WooCommerce & Shopify

      E-commerce Integration with Vendtill POS ( WooCommerce & Shopify ) Help Steps Enhance your retail operations by integrating your e-commerce platform with Vendtill POS. Whether you use WooCommerce or Shopify, this integration allows you to seamlessly ...

    • E-commerce Integration with Vendtill POS ( WooCommerce & Shopify

      E-commerce Integration with Vendtill POS ( WooCommerce & Shopify ) Help Steps Enhance your retail operations by integrating your e-commerce platform with Vendtill POS. Whether you use WooCommerce or Shopify, this integration allows you to seamlessly ...

    • How to Manage Employee POS Access Rights

      How to Manage Employee POS Access Rights Vendtill Back Office → Users 1. Manage Employee POS Access Rights 2. Manage Employee POS Access Rights 3. Manage Employee POS Access Rights 4. Manage Employee POS Access Rights 5. Manage Employee POS Access ...

    • WooCommerce Website Setup to Vendtill POS

      WooCommerce Website Setup to Vendtill POS Step-by-step You can now integrate your WooCommerce online store with the Vendtill POS System. This allows you to manage online orders directly from your POS system. Follow the steps below to complete the ...

    • Shopify Website Connect to Vendtill POS

      Shopify Website Connect to Vendtill POS Step-by-step Video Guide You can now link your Shopify online store with the Vendtill POS System to manage online orders directly from your POS app. Follow these steps to complete the setup. Setup Overview This ...