Home › Help centre › API documentation

Merchant REST API

Available on plans that include API access. Create keys in the app under Integrations → API access. Base URL https://www.vyanrarewards.movetransora.com/api/v1. Every response is JSON; rate limit 120 requests per minute per key.

Authentication

Send your key in the X-API-Key header on every request. Keys are scoped to one store and can be revoked at any time from the app.

Members

GET/members?q=&per_page=50&page=1

List members; q searches name, email and referral code.

GET/members/{identifier}

identifier is an email, a Shopify customer ID or the member ID.

GET/members/{identifier}/history?page=1

The member's points ledger, newest first.

Points & credit

POST/members/{identifier}/points

Body {"points": 100, "note": "…", "idempotency_key": "optional"} — negative values remove points. Repeating the same idempotency_key is a no-op.

POST/members/{identifier}/credit

Body {"amount": 5.00, "note": "…"} — store-credit adjustment, synced to Shopify.

Rewards & earning

POST/members/{identifier}/award/{rule_id}

Body {"source_id": "unique-per-event", "points": optional} — awards an earn rule; the rule's limits (once, per day, per month) still apply.

POST/members/{identifier}/redeem/{reward_id}

Body {"points": n} for variable rewards — deducts points and issues a single-use Shopify discount code.

Catalogue

GET/rewardsGET/earn-rulesGET/tiers

Active rewards, earn rules and VIP tiers as the storefront sees them.

Errors

4xx responses contain {"error": "message", "code": "machine_code"}. 402 — plan does not include the feature, 422 — validation or business rule, 429 — rate limited.

Example

curl -H "X-API-Key: lk_…" -H "Content-Type: application/json" \
  -d '{"points": 250, "note": "Event attendance"}' \
  https://www.vyanrarewards.movetransora.com/api/v1/members/jane@example.com/points

Shopify Flow

No code needed for automations: the app provides Flow triggers (points earned, points expiring, reward redeemed, referral completed, tier changed) and actions (add points, remove points, change tier). Find them in Shopify Flow under the app's name.