Aller au contenu principal

API Overview

Phase 2

The Store Locator Map: SE REST API is currently in development as part of Phase 2. This documentation is a preview of the planned endpoints and behavior. Features described here are subject to change before general availability.

Current Integration Model​

Today, Store Locator Map: SE integrates with your Shopify store through the following mechanisms:

  • Shopify Admin UI -- Manage locations, settings, and appearance directly from the app within Shopify admin.
  • Shopify Locations Sync -- Import and synchronize location data from Shopify's native Locations feature.
  • CSV Import/Export -- Bulk-manage locations by uploading or downloading CSV files.
  • Webhooks -- Receive real-time notifications when Shopify location data changes (used internally for auto-sync).

No external API key or direct API access is required for standard use of the app.

Planned API (Phase 2)​

The Phase 2 API will provide programmatic access to your store locator data, enabling custom integrations, third-party applications, and advanced automation workflows.

Base URL​

https://api.scrollengine.com/v1

Planned Endpoints​

EndpointMethodDescription
/v1/locationsGETList all locations with pagination.
/v1/locations/{id}GETRetrieve a single location by ID.
/v1/locationsPOSTCreate a new location.
/v1/locations/{id}PATCHUpdate an existing location.
/v1/locations/{id}DELETEDelete a location.
/v1/locations/searchGETSearch locations by proximity, query, or tags.

Response Format​

All responses use JSON. Successful responses follow this structure:

{
  "success": true,
  "data": { },
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 142
  }
}

Error responses follow this structure:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The 'address' field is required."
  }
}

Authentication​

API requests will require a Bearer token. See Authentication for details on generating and managing API keys.

Rate Limits​

All endpoints will be subject to rate limiting. See Rate Limits for plan-specific thresholds and best practices.

Staying Informed​

To receive updates when the API enters beta or reaches general availability, enable notifications in Settings > API within the app. You can also monitor the Scrollengine changelog for release announcements.

Next Steps​