Jump to Content
API Reference
Log In
API Reference
Log In
API Reference
Webhooks
All
Pages
Start typing to search…
JUMP TO
Welcome
Introduction to Locally APIs
CREDENTIALS
Generate An API Key
Cart API
Cart API Overview
PushCart Integration
Ship-to-Store Integration
Webhooks
Get All Carts
get
Get A Single Cart
get
Update a Cart Item
post
Cart Item Statuses
External Headless API
Session
Get session ID
get
Headless API Overview
Create a Product Locator
Decide on a Checkout Flow
Create a Checkout Experience
Submit a Cart & Credit Card Authorization
Testing Your Integration
Handling Errors in Production
Delivery
Get delivery options
post
Set Chosen Delivery Option
put
Set Delivery Option Used
post
Manual delivery status update
post
Conversion
Get common data
get
Start conversion
get
Get inventory data
get
Get location data
get
Location
Switch session location
get
Suggest locations
get
Suggest addresses
get
Utility
Send Save for Later email
get
Send email
get
Product
Locate products at stores by style or UPC
get
Search for products
post
Cart
Get cart
get
Update cart
post
Add cart items
get
Validate cart email
post
Authorize payment. Commit order.
post
Get Stripe Connected ID
get
Create cart. Add items. Authorize payment.
post
Commit order
post
Authorize payment
post
Search
MCP phrase search
post
Data Sharing API
Data Sharing API Overview
Report Index
get
Report Page
get
ShopSense Reports
Download a Full ShopSense Report
"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
Product Locator API
Product Locator API Overview
Stores By Brand
get
Stores By Product
get
Stores By UPC
get
Launch Product Page
Launch Cart Page
Product Locator Events
Powered by
Webhooks
Ask AI
Payloads sent to your system whenever important changes about your orders happen.
