Vend API
Vend is a cloud retail POS and commerce platform—now part of Lightspeed and rebranded as Lightspeed Retail (X-Series)—that powers point of sale, inventory, customer, and multi-channel selling for independent and multi-store retailers. An unofficial API lets you programmatically pull products, variants, sales, customers, inventory counts, outlets, and registers—and push updates like new sales, stock orders, and customer records back into Vend.
What is Vend?
Vend is a cloud-based retail POS and commerce platform that helps retailers run point of sale, inventory, customer, and multi-channel operations from one system. Following its acquisition by Lightspeed, Vend has been rebranded as Lightspeed Retail (X-Series). Retailers use it to process sales with embedded payments, manage stock across locations, run loyalty and marketing, and sell across in-store, online, and marketplace channels—serving apparel, electronics, jewelry, pet supplies, and other specialty retail from single shops through multi-store operations.
Core product areas include:
- Point of Sale (unified register, embedded payments, multi-location, real-time sales reporting)
- Inventory Management (stock levels, SKUs, product variants, composite products, purchase/stock orders)
- Customer & Marketing (loyalty, store credit, gift cards, email/SMS campaigns, segmentation)
- eCommerce & Multi-channel (online store, social and marketplace selling, fulfillments, shipping)
- Open API, webhooks, and add-on ecosystem for custom integrations
Common data entities:
- Products, Variants, Composite Products, Price Books, Promotions
- Sales, Line Items, Payments, Registers, Register Closures
- Inventory Counts, Stock Orders, Consignments, Outlets
- Customers, Loyalty, Store Credit, Gift Cards, Addresses
- Suppliers, Taxes, Payment Types, Fulfillments, Service Orders
The Vend Integration Challenge
Retailers run daily sales and inventory on Vend, but turning its portal- and POS-driven workflows into reliable API-driven automation is non-trivial:
- Split API versions: some resources live on v2.0 while others (such as sale creation) remain exclusive to the legacy v0.9 surface
- OAuth and add-on gates: developer access requires registering an add-on or personal token, and multi-retailer integrations need OAuth flows per account
- Rate limiting and pagination: high-volume product and sales pulls hit throttles and require careful cursor/version-based pagination
- Per-domain account URLs: each retailer's data sits behind its own store subdomain, so generic integrations break across tenants
- Object versioning and sync: v2.0 auto-incrementing object versions help sync but require tracking deltas to avoid full re-pulls
- Lightspeed migration drift: the ongoing Vend-to-Lightspeed Retail (X-Series) rebrand shifts endpoints, hosts, and docs over time
How Supergood Creates Vend APIs
Supergood reverse-engineers authenticated browser flows alongside Vend's open API to deliver a resilient, normalized API layer for your store—spanning both the v2.0 and v0.9 surfaces.
- Handles OAuth token exchange, personal tokens, and per-store subdomains securely
- Maintains session continuity with automated token refresh and version-based change detection
- Normalizes responses across products, sales, inventory, and customers so you integrate once across v2.0 and v0.9
- Adapts to the Lightspeed Retail (X-Series) rebrand and endpoint shifts without breaking your integration
Use Vend with AI agents: Vend MCP Server →
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your store, API version, and authentication model.
- Supergood Builds and Validates Your API
We deliver a hardened Vend adapter tailored to your store configuration and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as Vend and Lightspeed Retail evolve.
API Endpoints
Authentication
/authenticateAuthenticate to a Vend store using OAuth or a personal token and obtain a session token for downstream calls.
Products
/productsList products and variants with filters for SKU, type, supplier, and updated-since version cursor.
Products
/create_productCreate or update a product, variant, or composite product with pricing, tax, and inventory settings.
Sales
/salesRetrieve sales, line items, and payments across outlets and registers with status and date filters.
Sales
/create_saleRegister a new sale with line items, payments, and customer association (via the v0.9 sale-creation surface).
Inventory
/inventoryPull inventory counts, stock orders, and consignments by outlet to reconcile stock across locations.
Use Cases
Sync products and inventory across channels
- Pull products, variants, and composite items into a central catalog or PIM - Reconcile inventory counts and stock orders across outlets in near real time - Push price, tax, and stock-level updates back to Vend from upstream systems
Stream sales data to analytics and accounting
- Export sales, line items, and payments to BI and data warehouse tools - Reconcile register closures and payment types against accounting systems - Surface per-outlet and per-product revenue trends for reporting
Unify customer and loyalty records
- Sync customers, loyalty balances, store credit, and gift cards into a CRM - Trigger email/SMS marketing workflows from in-store purchase events - Build a unified customer 360 across online and in-store channels
Automate omnichannel order fulfillment
- Create sales and fulfillments from external eCommerce and marketplace orders - Route stock orders and consignments between outlets to balance inventory - Update fulfillment and shipping status back into Vend automatically
Technical Specifications
Authentication
OAuth token exchange and personal tokens handled in a managed session per store subdomain
Connectivity
Vend / Lightspeed Retail (X-Series) REST API (v2.0 and v0.9) plus authenticated browser flows where needed
Response format
Normalized JSON across Products, Sales, Inventory, Customers, and Outlets
Rate limits
Adaptive throttling tuned to your store to respect Vend API rate limits and avoid 429s
Session management
Automatic OAuth token refresh, credential rotation, and per-store session handling
Data freshness
Near real-time pulls for sales and inventory with version-cursor incremental syncs
Security
Encrypted credential vault, scoped access tokens, SOC 2-aligned controls, and audit logging
Webhooks
Event-style callbacks for sale, product, inventory, and customer changes
Latency
Sub-second reads on cached entities; multi-second writes when posting sales and stock orders
Throughput
Horizontally scaled workers sized to multi-outlet product and sales volume
Reliability
Retry, backoff, and idempotency keys for sale creation and inventory adjustments
Adaptation
Continuous monitoring of Vend-to-Lightspeed Retail (X-Series) migration, version, and endpoint drift
Frequently asked questions
Yes. Vend was acquired by Lightspeed and rebranded as Lightspeed Retail (X-Series). Supergood works against the same API surfaces and tracks endpoint and host changes through the migration so your integration keeps working.
Yes. Supergood normalizes data across both versions—using v2.0 for performance and incremental syncing while still reaching v0.9-only operations such as sale creation—so you integrate once across the full surface.
No. Supergood works with your existing store credentials and authenticated sessions, handling OAuth token exchange or personal tokens for you. You do not need to build and maintain your own add-on registration.
Yes. The API supports writes including new sales, products, stock orders, and customer records—with idempotency and retry handling so high-volume sale and inventory operations stay consistent.
Each store's data sits behind its own subdomain and outlets. Supergood profiles your store configuration and normalizes outlets, registers, and inventory so multi-location data lands in one consistent schema.