Shop API

Retrieve and update your shop profile information.

GET/v1/shop

Get your shop's profile information. For shop keys, returns the shop associated with the API key.

Required Scope

shops:read

Example Request

curl https://api.thevirtualmall.co.uk/v1/shop \
  -H "Authorization: Bearer tvm_your_api_key"

Example Response

{
  "success": true,
  "data": {
    "id": "shop_abc123",
    "slug": "example-store",
    "name": "Example Store",
    "teaser": "Your one-stop shop for everything",
    "description": "Full description of the store...",
    "primaryDomain": "example-store.com",
    "domains": ["example-store.com", "example.co.uk"],
    "logoUrl": "https://...",
    "isActive": true
  }
}

PUT/v1/shop

Update your shop's profile information. Only provided fields will be updated.

Required Scope

shops:write

Request Body

teaserstringShort description (max 255 chars)

descriptionstringFull description (max 5000 chars)

Example Request

curl -X PUT https://api.thevirtualmall.co.uk/v1/shop \
  -H "Authorization: Bearer tvm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "teaser": "Updated store tagline",
    "description": "Updated full description..."
  }'