Postman Collection

Import our Postman collection to quickly explore and test the VasBox API.

Our Postman collection includes pre-configured requests for all VasBox API endpoints, making it easy to explore the API and test your integration.

New to Postman? Download Postman to get started.

Installation

Import the VasBox collection into Postman:

One-Click Import

Click the button below to import the collection directly into Postman:

Manual Import

  1. Download the VasBox Postman Collection
  2. Open Postman
  3. Click Import in the top left
  4. Drag the downloaded file or click Upload Files
  5. Click Import to confirm

Configuration

Configure the collection with your API credentials:

Environment Setup

  1. Click Environments in the left sidebar
  2. Select VasBox Sandbox (imported with collection)
  3. Set your API key in the vasbox_api_key variable
  4. Click Save
  5. Select the environment from the dropdown in the top right
Environment Variables
{
  "vasbox_api_key": "vb_test_your_api_key_here",
  "vasbox_base_url": "https://sandbox.api.vasbox.co.zw/v1"
}
Never share your API key. Use the "Current Value" column for sensitive data, which won't be synced to Postman's servers.

Using the Collection

The collection is organized by resource type:

Collection Structure

  • Invoices - Create, list, get, update, submit, void
  • Receipts - Create, list, get, void
  • Products - CRUD operations for products
  • Customers - CRUD operations for customers
  • Webhooks - Webhook management
  • Reports - Generate various reports

Running Requests

  1. Expand a folder (e.g., "Invoices")
  2. Select a request (e.g., "Create Invoice")
  3. Review and modify the request body if needed
  4. Click Send
  5. View the response in the lower panel

Using Variables

The collection uses variables for common values. After creating a resource, save its ID as a variable:

  1. Create an invoice using "Create Invoice"
  2. Copy the id from the response
  3. Set it as invoice_id in your environment
  4. Other requests will automatically use this ID

Environments

The collection includes two pre-configured environments:

Sandbox Environment

Use for development and testing. No real transactions are created.

  • Base URL: https://sandbox.api.vasbox.co.zw/v1
  • Use test API keys (prefix: vb_test_)

Production Environment

Use for live transactions with real ZIMRA submissions.

  • Base URL: https://api.vasbox.co.zw/v1
  • Use live API keys (prefix: vb_live_)

Warning

Production requests create real transactions and are submitted to ZIMRA. Double-check your data before sending.