The Virtual Mall
API v1

The Virtual Mall API

Manage your shop presence on The Virtual Mall. Push offers, vouchers, and keep your shop profile up to date.

Get StartedAPI Reference

Core Capabilities

Everything you need to manage your shop's presence on The Virtual Mall

Offers

Create and manage special offers, discounts, and promotions for your shop.

Voucher Codes

Add voucher codes with descriptions, terms, and expiry dates.

Shop Profile

Update your shop description, logo, categories, and contact information.

Quick Start

Start creating offers in seconds with a simple API call

Create an Offer
curl -X POST https://api.thevirtualmall.co.uk/v1/offers \
  -H "Authorization: Bearer tvm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "20% Off Everything",
    "description": "Save 20% across our entire range",
    "landingUrl": "https://yourshop.com/sale",
    "discountType": "percentage",
    "discountValue": 20,
    "expiresAt": "2026-03-01"
  }'
Response
{
  "success": true,
  "data": {
    "id": "offer_abc123",
    "title": "20% Off Everything",
    "status": "needs_review",
    "createdAt": "2026-02-06T10:30:00Z"
  }
}

API Endpoints

Full REST API for managing your shop content

Shop

GET/v1/shop
PUT/v1/shop

Offers

GET/v1/offers
POST/v1/offers
GET/v1/offers/:id
PUT/v1/offers/:id
DELETE/v1/offers/:id

Vouchers

GET/v1/vouchers
POST/v1/vouchers
GET/v1/vouchers/:id
PUT/v1/vouchers/:id
DELETE/v1/vouchers/:id