API Reference

Getting started with Locally's "Data Sharing" API

Data Sharing is Locally's reporting platform. Reports are generated daily or weekly (based on the report-type) and are accessible via one of the following methods:

  • A Simple REST API (documented here)
  • S/FTP Server
  • Google Cloud Storage Bucket

Hundreds of different data elements can be shared: product catalog, store quantity on hand, platform consumer behavior data, locations, opportunity, and more.

Data Sharing services are available to Locally's clients as an add-on to their service.

Reports

To use Locally Data Sharing you must subscribe to a report. Contact your Client Success Manager at Locally to have a report set up.

Report Types

The following is a general list of the report types that are available:

  • Product Catalog Reports
  • ShopSense Inventory Reports
  • ShopSense Inventory and Sales Reports
  • ShopSense Inventory, Sales and Demand Reports
  • Dealer List Reports
  • Geo-based Reports
  • Order History Reports

API Key

You will need an API Key to access your Data Sharing endpoint. See Generate An API Key for more info.

Rate Limit

There is a rate limit of 1000 requests per minute for the Data Sharing API