Locally offers an SDK and API for orchestrating your own local shopping UI/UX using Locally's dealer and brand network.
Locally Headless API is currently available by invitation. This is an add-on service, please contact your Account Manager to inquire.
Getting Started
You will need an API Key to access Locally's Headless API. See Generate An API Key for more info.
Download the Javascript SDK (optional)
Locally offers an SDK to kick-start your headless integration. Visit the NPM repository for more: https://www.npmjs.com/package/@locally-com/lcly-js-sdk
Guides
The following guides will help you to understand how to use to the Headless API to create your own local shopping experiences:
This guide will help you display local availability of your products to local shoppers. Topics covered in this guide:
- Shopper session initialization
- On-demand product discovery, availability and paths to purchase
- Managing geographic location suggestions
- Managing geographic location changes
This guide will provide you with a walk-through of the recommended approach to building a shopper's checkout journey using Locally's Headless API. Topics covered:
- Creating and adding items to a local store's shopping cart.
- Using the Cart API to retrieve information about a cart and its status.
- Updating a cart's contents
- Making an order and finalizing the checkout experience.