For AI agents: visit https://hub.locally.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Guides API Reference Release Notes For Brands For Retailers API Docs Site Status Join Locally Contact Support

API Reference

Jump to Content

Guides API Reference Release Notes For Brands For Retailers API Docs Site Status Join Locally Contact Support

Introduction to Locally APIs

Generate an API Key

Cart API Overview
PushCart Integration
PushCart: Same-Day Delivery Orders
Ship-to-Store Integration
Webhooks
Get All Cartsget
Get a Single Cartget
Update a Cart Itempost
Cart Item Statuses

Session
- Get session IDget
Headless API Overview
Delivery
Conversion
Location
Utility
- Send Save for Later emailget
- Send emailget
Product
- Locate products at stores by style or UPCget
- Search for productspost
Cart
Search

Data Sharing API Overview
Report Indexget
Report Pageget
ShopSense Reports
Download a Full ShopSense Report
ShopSense Suggested Orders

Live Events API Overview
Live Events Integration Guide
Live Event Model Reference
Recipe: Capture "Product Locator Funnel" data
Setting up GTM to Capture SwitchLive Events
Sending SwitchLive Order Events to Meta
Sending SwitchLive Order Events to Google Ads

Local Marketing API Overview

Product Locator API Overview
Stores by Brandget
Stores by Productget
Stores by UPCget
Launch Product Page
Launch Cart Page
Product Locator Events

Search

Updated 8 months ago

Authorize payment

Data Sharing API Overview

Did this page help you?

Updated 8 months ago

Authorize payment

Data Sharing API Overview

Did this page help you?

Locally HUB · Knowledge base for brands, retailers & developers. Release Notes ← Back to locally.com