API endpoint reference

Every read endpoint an API key can call, with paths, scopes and query parameters.

8 min read

Base URL: https://veedo.store/api/v1/stores/{storeId}. All paths below are relative to that. Send Authorization: Bearer vd_live_… on every call. See Connect to the veedo API for auth and response shape.

Scope column: read needs a read key; orders works with either read or orders.

Store

Method	Path	Scope	Notes
GET	`/`	read	Store settings: name, slug, plan flags, branding URLs

Catalog

Method	Path	Scope	Notes
GET	`/products`	read	All products for the store
GET	`/products/{productId}`	read	One product, including variants and media
GET	`/products/export`	read	CSV download of the catalog
GET	`/gift-cards`	read	Gift cards
GET	`/gift-cards/{giftCardId}`	read	One gift card
GET	`/badges`	read	Recognition badges on this store
GET	`/search?q=`	read	Quick search across the store

Vendors

Method	Path	Scope	Notes
GET	`/vendors`	read	In-world vendors (not delivery servers), with groups and today's L$
GET	`/vendors/{vendorId}`	read	One vendor

Sales

Method	Path	Scope	Notes
GET	`/transactions`	orders	Sales. Filters: `status`, `productId`, `vendorId`, `from`, `to` (ISO dates), `limit`
GET	`/activity`	orders	Activity feed. `limit`, optional `cursor` for the next page
GET	`/analytics/export`	orders	CSV export of sales analytics
GET	`/splits`	orders	Split payee board
GET	`/affiliates`	orders	Affiliates
GET	`/affiliate-rules`	orders	Affiliate rules
GET	`/integrations`	orders	Connected CasperVend, mdVendor and Marketplace status

Transaction status values: PENDING, VERIFIED, DELIVERED, REFUNDED, FAILED.

Customers

Method	Path	Scope	Notes
GET	`/customers`	read	Buyer list. `q` searches name or avatar UUID; `filter` = `all`, `top`, `credit`, `issue`, `group`
GET	`/customers/{customerId}`	read	One customer with purchase history
GET	`/customers/export`	read	CSV of customers

Analytics

Method	Path	Scope	Notes
GET	`/analytics/overview?range=`	read	`range`: `today`, `7d`, `30d`, or `all` (Premium for full history)
GET	`/analytics/products`	read	Product performance for a range
GET	`/analytics/funnel`	read	Website → teleport → sale funnel
GET	`/analytics/retention`	read	Retention cohorts (Premium)
GET	`/analytics/report`	read	Bundled analytics report
GET	`/analytics/goal`	read	Revenue goal progress
GET	`/attention`	read	Things that need a look (failed deliveries, offline servers, …)
GET	`/digest`	read	Digest preferences / summary

Example: recent sales

curl -sS -H "Authorization: Bearer vd_live_YOUR_KEY" "https://veedo.store/api/v1/stores/STORE_ID/transactions?limit=20&status=DELIVERED"

Example: today's overview

curl -sS -H "Authorization: Bearer vd_live_YOUR_KEY" "https://veedo.store/api/v1/stores/STORE_ID/analytics/overview?range=today"

Not available with API keys

Creating or editing products, vendors, site content or settings
Pairing in-world objects or claiming deliveries
Redelivery, broadcasts, team invites or billing changes
Staff /admin routes and shopper-facing /api/v1/site/… routes (those use different auth)

CSV export paths return a file download, not { ok, data } JSON. Still send the same Bearer header.

For in-world payment, retries and delivery confirmations (vendors and servers), see In-world vendor API.