Developer docs

API reference for LocaPrice integrations

Build secure integration flows for locations, prices, and runtime price resolution using scoped API tokens.

Quickstart

  1. Install the app and open API Access in Shopify admin.
  2. Create a scoped token for your integration use case.
  3. Send `Authorization: Bearer YOUR_TOKEN` on each API request.
  4. Handle structured error codes and rate-limit headers safely.

Scopes

Supported token scopes

locations:read

Read synced Shopify location records.

prices:read

Read location prices, location groups, price rules, catalog lookups, and resolution endpoints.

prices:write

Create, update, and delete pricing data (including rules/groups), plus trigger runtime checks.

sync:write

Reserved for sync workflows. Keep for forward compatibility when creating broad integration tokens.

Error handling

Common response codes

Error responses use a structured envelope with `ok: false`, an error code, and a safe message.

CodeStatusMeaning
API_TOKEN_UNAUTHORIZED401Missing, malformed, expired, or revoked bearer token.
API_TOKEN_FORBIDDEN403Token is valid but does not include the required scope.
RATE_LIMIT_EXCEEDED429Too many requests in the current rate-limit window.
PLAN_LIMIT_EXCEEDED403Feature is not available on the current billing tier.
VALIDATION_ERROR400Request body or query parameters are invalid.