Enjovia API

Enjovia API
3.2.9

Base URL 
https://api.gb.enjovia.app

API documentation for the Enjovia platform post-order processing and fulfillment system.

Authentication

All endpoints require Bearer token authentication via the Authorization header.

Obtaining an API Token

API tokens can be created through the Enjovia dashboard:

  1. Navigate to Settings → API Tokens in your account
  2. Click "Create New Token"
  3. Enter a name for the token and select the required permissions
  4. Configure which stores and redeem locations the token can access
  5. Copy the token value immediately - it will only be shown once

Using the API Token

Include the token in the Authorization header of all API requests:

Authorization: Bearer YOUR_API_TOKEN

Token Permissions

Each API token is associated with specific permissions that determine which endpoints it can access.

Required Headers

  • Account-ID: Required for most endpoints (UUID format)
  • Store-Subdomain: Required for store-specific operations
  • Redeem-Location-ID: Required for redemption operations

Permissions

Endpoints require specific permissions:

  • Orders endpoints: view_orders permission
  • Vouchers endpoints: view_orders permission
  • Redeemables endpoints: view_orders permission
  • Transactions endpoints: manage_payments permission
  • Packages endpoints: fulfil_orders permission
  • Terminal endpoints: redeem_vouchers or process_orders permission

Sorting

List endpoints support sorting via the sort query parameter:

  • Use field names to sort ascending (e.g., sort=name)
  • Use - prefix for descending order (e.g., sort=-created_at)
  • Combine multiple fields with commas (e.g., sort=type,-price)
  • Most endpoints default to -updated_at (most recently updated first)
  • Available sort fields vary by endpoint - see individual endpoint documentation

Filtering

List endpoints support filtering via query parameters with the filter[field] syntax:

  • Single values: filter[is_active]=true
  • Multiple values (OR logic): filter[store.id][]=id1&filter[store.id][]=id2
  • Boolean filters: filter[is_live][]=true&filter[is_live][]=false
  • Relationship filters: filter[store.id]=uuid (filters by related entity)
  • Tag filters: filter[tags][key]=value (filters by tag key-value pairs)
  • Available filter fields vary by endpoint - see individual endpoint documentation

Query Examples: 

# Get active products sorted by price (lowest first)
GET /products?filter[is_active]=true&sort=price

# Get live orders from specific store, newest first
GET /orders?filter[store.id]=store-uuid&filter[is_live]=true&sort=-created_at

# Get USD promotions with codes, sorted by last used
GET /promotions?filter[currency_code]=usd&filter[has_codes]=true&sort=-last_used

# Get public monetary products in a category, sorted by name
GET /products?filter[type]=monetary&filter[status]=public&filter[categories.slug]=gift-cards&sort=name

# Complex query: Active products with tags, sorted by multiple fields
GET /products?filter[is_active]=true&filter[tags][season]=summer&filter[tags][featured]=true&sort=type,-price

# Get stores with pagination, filtering, and sorting
GET /stores?filter[is_live]=true&filter[payment_gateway]=Stripe&sort=-last_purchase&page=2&per_page=25

This is version 3.2.9 of this API documentation. Last update on Sep 16, 2025.