Jump to Content

API Reference

All

Pages

Start typing to search…

Welcome

Introduction to Locally APIs

CREDENTIALS

Generate An API Key

Cart API

Cart API Overview
PushCart Integration
Cart-to-Cart Integration
Ship-to-Store Integration
Webhooks
Get All Cartsget
Get A Single Cartget
Update a Cartpost
Update a Cart Itempost
Cart Item Statuses

External Headless API

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

Data Sharing API

Data Sharing API Overview
Report Indexget
Report Pageget
ShopSense Reports

"SwitchLIve" real-time Data pixel

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

Local marketing api

Local Marketing API Overview
Stores By Brandget
Stores By Productget
Stores By UPCget

Product Locator API

Product Locator API Overview
Launch Product Page
Launch Cart Page
Product Locator Events

Suggest locations

get https://www.locally.com/headless/api/1.0/location/suggest

Get suggested locations for a multi-store search.

Language

Click Try It! to start a request and see the response here!