2024-04 Deprecation of vendhq.com domain for API access

Starting in January 2024, Lightspeed Retail (X-Series) stores were migrated from the vendhq.com domain to new URLs in the retail.lightspeed.app domain. This is one of the final steps in our journey to integrate Vend into Lightspeed, paving the way for a unified commerce platform under the Lightspeed brand.

As part of this domain change, we are now deprecating use of the vendhq.com domain to access X-Series API endpoints.

All developers of applications using X-Series APIs should update their software to access store URLs in the retail.lightspeed.app domain.

Legacy URLs in the vendhq.com domain will continue to accept API requests until March 31, 2025. That domain will no longer be supported after this date.

API Request Example

Previously, to access the List customers API endpoint in a store with the domain prefix example, you would make a GET request to the following URL:

https://example.vendhq.com/api/2.0/customers

Following this deprecation, the URL must be changed to:

https://example.retail.lightspeed.app/api/2.0/customers

The domain is the only part of the request that is changing.

OAuth 2.0 Example

When implementing the OAuth 2.0 connection flow to authorize an application to access a Lightspeed Retail (X-Series) Retailer account, previously you would redirect the user to a URL like the following:

https://secure.vendhq.com/connect?response_type=code&client_id={client_id}&redirect_uri={redirect_uri}&state={state}

Following this deprecation, the URL must be changed to:

https://secure.retail.lightspeed.app/connect?response_type=code&client_id={client_id}&redirect_uri={redirect_uri}&state={state}

The domain is the only part of the request that is changing.