Docs / Endpoints

Complete endpoint reference

23 endpoints organized by resource. All /api/v1/* routes require bearer token authentication with the listed scopes.

Quick reference

Send Authorization: Bearer YOUR_TOKEN on every request.
Scopes are enforced per endpoint and method.
Rate limit: 100 requests per 60s per token prefix.
Responses use { "ok": true | false, ... } envelope.

Authentication & Status

Token verification and platform health.

GET/api/v1/auth-status200Bearer token requiredNo scope required

Auth status

Validate a bearer token and inspect safe token metadata.

GET/api/health200No token required

Platform health

Merchant-safe liveness endpoint for service monitoring.

Locations

Read synced Shopify locations.

GET/api/v1/locations200Bearer token requiredlocations:read

List synced locations

Return synced store locations used by LocaPrice.

Location Prices

CRUD for variant-location price overrides.

GET/api/v1/location-prices200Bearer token requiredprices:read

List location prices

List configured location prices, optionally filtered by variant and location.

POST/api/v1/location-prices201Bearer token requiredprices:write

Create location price

Create a location-specific price for a variant.

PATCH/api/v1/location-prices/:id200Bearer token requiredprices:write

Update location price

Update one location-price record by id.

DELETE/api/v1/location-prices/:id200Bearer token requiredprices:write

Delete location price

Delete a location-price record by id.

Bulk Pricing

Batch import and job management.

POST/api/v1/location-prices/bulk202Bearer token requiredprices:write

Bulk upsert location prices

Submit up to 1000 rows in one request and process inline or async based on row volume.

GET/api/v1/location-price-bulk-jobs/:id200Bearer token requiredprices:read

Get bulk job

Read bulk job status, counters, and row-level errors.

POST/api/v1/location-price-bulk-jobs/:id200Bearer token requiredprices:write

Process bulk job now

Trigger processing for a queued job manually.

Location Groups

Group locations for operational workflows.

GET/api/v1/location-groups200Bearer token requiredprices:read

List location groups

Return location groups with memberships.

POST/api/v1/location-groups201Bearer token requiredprices:write

Create location group

Create a new named location group.

GET/api/v1/location-groups/:id200Bearer token requiredprices:read

Get location group

Read one location group by id.

PATCH/api/v1/location-groups/:id200Bearer token requiredprices:write

Update location group

Update group name or description.

DELETE/api/v1/location-groups/:id200Bearer token requiredprices:write

Delete location group

Delete a location group and its memberships.

POST/api/v1/location-groups/:id201Bearer token requiredprices:write

Add or remove location group member

Manage location memberships with action-based payloads.

Price Rules

Rule-based percentage adjustments by location or group.

GET/api/v1/price-rules200Bearer token requiredprices:read

List price rules

List active and inactive price rules with resolved scope metadata.

POST/api/v1/price-rules201Bearer token requiredprices:write

Create price rule

Create a percentage discount/increase rule scoped by location or location group.

DELETE/api/v1/price-rules/:id200Bearer token requiredprices:write

Delete price rule

Delete one price rule and republish runtime state.

Price Resolution

Resolve effective price for variant-location pairs.

GET/api/v1/price-resolution200Bearer token requiredprices:read

Resolve single price

Resolve the effective location price for one variant-location pair.

POST/api/v1/price-resolution/batch200Bearer token requiredprices:read

Resolve price batch

Resolve up to 50 variant-location pairs in one call.

Catalog

Search Shopify product variants.

GET/api/v1/catalog/variants200Bearer token requiredprices:read

Search catalog variants

Search variants for integration-side mapping and lookups.

Runtime

Runtime health and consistency checks.

GET/api/v1/runtime-health-check200Bearer token requiredprices:write

Runtime health check

Run a runtime consistency check for the authenticated shop.