# Locally HUB Documentation

> One place for every answer about Locally. Onboarding walkthroughs for brands and retailers, plus the full API reference for developers — kept current by the team that builds it.

Append .md to any documentation page URL to get its markdown version.

## Guides
- [onboarding-all-product-locator-options](https://hub.locally.com/docs/onboarding-all-product-locator-options.md)
- [Product Locator Addition- Buy Online](https://hub.locally.com/docs/product-locator-buy-online.md)
- [turn-online-searches-into-in-store-sales-a-retailer-s-guide-to-swis-and-lia](https://hub.locally.com/docs/turn-online-searches-into-in-store-sales-a-retailer-s-guide-to-swis-and-lia.md)

## API Reference
- [Generate an API Key](https://hub.locally.com/reference/generate-api-key.md)
- [PushCart Integration](https://hub.locally.com/reference/push-cart-integration.md)
- [PushCart: Same-Day Delivery Orders](https://hub.locally.com/reference/same-day-delivery-orders.md): Receive, confirm, and track Same-Day Delivery orders through the Cart API and webhooks.
- [Ship-to-Store Integration](https://hub.locally.com/reference/ship-to-store-integration.md)
- [Webhooks](https://hub.locally.com/reference/webhooks.md): Payloads sent to your system whenever important changes about your orders happen.
- [Get All Carts](https://hub.locally.com/reference/all-carts.md): Returns all available carts
- [Get a Single Cart](https://hub.locally.com/reference/cart.md): Retrieves all of the data for a specific cart.
- [Update a Cart Item](https://hub.locally.com/reference/update-a-cart-item.md)
- [Cart Item Statuses](https://hub.locally.com/reference/cart-item-statuses.md): The various cart item status possibilities
- [Get session ID](https://hub.locally.com/reference/headlessapicontrollerget_session_id.md): Get a session ID. A session is used to persist user data when making API calls (e.g. location and cart items).
- [Headless API Overview](https://hub.locally.com/reference/headless-api-overview.md)
- [Create a Product Locator](https://hub.locally.com/reference/create-a-product-locator.md): This guide will help you create a local shopping experience for website users of your product detail pages (PDPs)
- [Decide on a Checkout Flow](https://hub.locally.com/reference/deciding-on-the-right-checkout-flow.md)
- [Create a Checkout Experience](https://hub.locally.com/reference/create-a-checkout-experience.md): This guide is for creating a checkout experience where items will be added to a Locally cart individually
- [Submit a Cart & Credit Card Authorization](https://hub.locally.com/reference/submit-a-cart-credit-card-authorization-in-a-single-request.md): This guide is for creating a complete and fully formed Locally cart and authorizing for payment in a single request
- [Testing Your Integration](https://hub.locally.com/reference/testing-your-integration.md): Some guidance on setting up an end-to-end testing platform for your local shopper experience
- [Handling Errors in Production](https://hub.locally.com/reference/handling-errors-in-production.md)
- [Get delivery options](https://hub.locally.com/reference/headlessapicontrollerget_delivery_options.md): Retrieve available delivery options (same-day and conventional) for a cart based on store location and customer address.
- [Set Chosen Delivery Option](https://hub.locally.com/reference/headlessapicontrollercart_delivery_options_chosen.md): Select the delivery option for the cart. The cart must be associated with a user session or JWT.
- [Set Delivery Option Used](https://hub.locally.com/reference/headlessapicontrollercart_delivery_options_used.md): Select the delivery option for the cart. The cart must be associated with a user session, JWT, or its secret.
- [Manual delivery status update](https://hub.locally.com/reference/headlessapicontrollercart_manual_delivery_status_update.md): For testing purposes only. Updates the delivery status of a cart. The cart must be associated with a user session or JWT.
- [Get common data](https://hub.locally.com/reference/headlessapicontrollerconversion_common.md): Retrieve commonly used global data such as currencies and languages.
- [Start conversion](https://hub.locally.com/reference/headlessapicontrollerconversion_start.md): Locate a product based on the UPC or product ID and get the coordinates of a store that has the product in stock.
- [Get inventory data](https://hub.locally.com/reference/headlessapicontrollerconversion_store_data.md): Get information for one or many stores and their in-stock data for a given UPC (Universal Product Code).
- [Get location data](https://hub.locally.com/reference/headlessapicontrollerconversion_location_data.md): Get data about a specific store or dealer. Lacks inventory data.
- [Get shipping options](https://hub.locally.com/reference/headlessapicontrollerconversion_shipping.md): Get shipping options for a product. Returns affiliate (buy online) and/or Locally network shipping options based on the type parameter. Requires either product_id, style or upc. When type is 'default', returns both affiliate and Locally options. Provide lat and lng together to order results by distance.
- [Switch session location](https://hub.locally.com/reference/headlessapicontrollerswitch_location.md): Switch the location of the current session to a new location. The location is specified by latitude and longitude coordinates.
- [Suggest locations](https://hub.locally.com/reference/headlessapicontrollersuggest_locations.md): Get suggested locations for a multi-store search.
- [Suggest addresses](https://hub.locally.com/reference/headlessapicontrollersuggest_address.md): Get suggested address locations for same-day delivery.
- [Send Save for Later email](https://hub.locally.com/reference/headlessapicontrollersend_save_for_later_email.md): Send an email containing a Save for Later link.
- [Send email](https://hub.locally.com/reference/headlessapicontrolleremail_template_send.md): Send an email using a template.
- [Locate products at stores by style or UPC](https://hub.locally.com/reference/headlessapicontrollerproduct_locate.md): Given a style or a list of UPCs, locate stores that have the product in stock.
- [Search for products](https://hub.locally.com/reference/headlessapicontrollerproduct_search.md): Search for products by company, category, department, and filters.
- [Get cart](https://hub.locally.com/reference/headlessapicontrollercart_get_detail.md): Retrieve existing cart data for a given session or cart JWT.
- [Update cart](https://hub.locally.com/reference/headlessapicontrollercart_update.md): Update an existing cart by session ID or hash. If a valid session ID is passed, the cart will be updated for the session user. If the session ID is invalid, a cart will be retrieved and updated by the JWT.
- [Add cart items](https://hub.locally.com/reference/headlessapicontrollercart_add_item.md): Add an item to a new or existing cart. If a valid session ID is passed, the item will be added to the cart owned by the session user. If a user can't be found or if the session ID is invalid or if the JWT is not able to retrieve an existing cart, a new cart and user will be created before adding the item.
- [Validate cart email](https://hub.locally.com/reference/headlessapicontrollercart_validate_email.md): Validate a customer email address during checkout.
- [Authorize payment. Commit order.](https://hub.locally.com/reference/headlessapicontrollercart_complete_order_request.md): Create bank holds and commit the cart for processing. The cart must be associated with a user session or JWT.
- [Get Stripe Connected ID](https://hub.locally.com/reference/headlessapicontrollerget_stripe_connected_id_for.md): Get the Stripe Connected ID for a given store. Requires additional permissions.
- [Create cart. Add items. Authorize payment.](https://hub.locally.com/reference/headlessapicontrollercart_validate.md): Create a cart and add/validate multiple cart items. Authorize payment.
- [Commit order](https://hub.locally.com/reference/headlessapicontrollercart_commit.md): Retrieve a validated cart and commit the order for processing.
- [Authorize payment](https://hub.locally.com/reference/headlessapicontrollercart_auth.md): Create bank holds for items in an existing cart.
- [Data Sharing API Overview](https://hub.locally.com/reference/data-sharing.md): Getting started with Locally's "Data Sharing" API
- [Report Index](https://hub.locally.com/reference/report-index.md)
- [Report Page](https://hub.locally.com/reference/report-page.md)
- [ShopSense Reports](https://hub.locally.com/reference/shopsense-reports.md): Documentation for Locally's "ShopSense" Advanced Analytics reports
- [Download a Full ShopSense Report](https://hub.locally.com/reference/how-to-programmatically-download-a-full-report.md): How to programmatically download store-level inventory, sales and more with our ShopSense API Report
- [ShopSense Suggested Orders](https://hub.locally.com/reference/suggested-orders.md): Access your ShopSense "Suggested Orders" report via API
- [Live Event Model Reference](https://hub.locally.com/reference/live-event-model-reference.md)
- [Recipe: Capture "Product Locator Funnel" data](https://hub.locally.com/reference/recipe-capture-product-locator-funnel-data.md)
- [Setting up GTM to Capture SwitchLive Events](https://hub.locally.com/reference/setting-up-gtm-to-capture-switchlive-events.md): This guide walks you through capturing SwitchLive event data from the Locally store and product locator widgets using Google Tag Manager (GTM). By the end, each individual event field will be available as its own parameter in GA4 — making the data fully queryable and filterable.
- [Sending SwitchLive Order Events to Meta](https://hub.locally.com/reference/sending-switchlive-order-events-to-meta.md): This guide covers how to send Locally purchase events to Meta (Facebook) Ads Manager using GTM. When complete, every order placed through the Locally widget will fire a custom `LocallyPurchase` event to your Meta Pixel — visible in Events Manager and usable for custom conversions and campaign optimization.
- [Sending SwitchLive Order Events to Google Ads](https://hub.locally.com/reference/sending-switchlive-order-events-to-google-ads.md): This guide covers how to send Locally purchase events to Google Ads using GTM. When complete, every order placed through the Locally widget will record as a conversion in Google Ads — with the correct purchase value and transaction ID — usable for bidding optimization and reporting.
- [Product Locator API Overview](https://hub.locally.com/reference/product-locator-api-overview.md)
- [Stores by Brand](https://hub.locally.com/reference/stores-by-brand.md): Request a list of stores authorized for the brand
- [Stores by Product](https://hub.locally.com/reference/stores-by-product.md): Request a list of authorized stores that have any UPC within the style group in-stock.
- [Stores by UPC](https://hub.locally.com/reference/stores-by-upc.md): Get a list of authorized stores that have the UPC(s) in-stock.
- [Launch Product Page](https://hub.locally.com/reference/launch-product-page.md)
- [Launch Cart Page](https://hub.locally.com/reference/launch-cart-page.md)
- [Product Locator Events](https://hub.locally.com/reference/product-locator-events.md)

## Changelog
- [🕒 See how fresh local inventory really is](https://hub.locally.com/changelog/see-how-fresh-local-inventory-really-is.md)
- [🌍 Retailer onboarding now available in 13 more languages](https://hub.locally.com/changelog/retailer-onboarding-now-available-in-13-more-languages.md)
- [📊 Break down Direct Sales by Surface in Brand Analytics](https://hub.locally.com/changelog/break-down-direct-sales-by-surface-in-brand-analytics.md)
- [🚚 Same-Day Delivery comes to the Cart API](https://hub.locally.com/changelog/same-day-delivery-comes-to-the-cart-api.md)
- [🇨🇿 Locally storefronts now speak Czech](https://hub.locally.com/changelog/locally-storefronts-now-speak-czech.md)
- [🔧 Add dealers seamlessly after switching brands](https://hub.locally.com/changelog/add-dealers-seamlessly-after-switching-brands.md)
- [🏪 Business types now included in DoorDash catalog feeds](https://hub.locally.com/changelog/business-types-now-included-in-doordash-catalog-feeds.md)
- [🚚 Same-day delivery confirmation just got simpler](https://hub.locally.com/changelog/announce-simplified-sdd-confirm-auto-delivery-creation.md)
- [🏪 Richer store data in Stores by UPC and Stores by Brand](https://hub.locally.com/changelog/richer-store-data-in-stores-by-upc-and-stores-by-brand.md)
- [🚗 DoorDash Drive now available for same-day delivery](https://hub.locally.com/changelog/doordash-drive-now-available-for-same-day-delivery.md)