Skip to main content
GET
/
{locale}
/
shop
/
coupons
curl -X GET "https://staging-api.loyalty.lt/en/shop/coupons?shop_id=1&status=active&per_page=10" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

{
  "success": true,
  "message": "Coupons retrieved successfully",
  "data": {
    "coupons": [
      {
        "id": 123,
        "code": "K1234567890",
        "qr_code": "uuid-1234-5678",
        "status": "active",
        "expires_at": "2025-01-31T23:59:59Z",
        "is_used": false,
        "is_pending": false,
        "offer": {
          "id": 456,
          "title": "Free Coffee",
          "description": "Reward for completing stamp card",
          "discount_type": "game_reward",
          "reward_type": "free_product",
          "reward_details": "Free medium coffee"
        },
        "game": {
          "id": 789,
          "name": "Coffee Stamp Card",
          "type": "stamps",
          "reward_description": "Collect 10 stamps for a free coffee"
        },
        "user": {
          "id": 100,
          "name": "Jonas Jonaitis",
          "email": "jonas@example.com"
        },
        "products": [],
        "categories": [],
        "requires_product_selection": false
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 10,
      "total": 25,
      "last_page": 3
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.loyalty.lt/llms.txt

Use this file to discover all available pages before exploring further.

​
List Coupons

Get a paginated list of coupons. Filter by shop, customer, or status.
This endpoint uses Partner API authentication (X-API-Key and X-API-Secret headers).

​
Query Parameters

​
shop_id
integer
required
Filter coupons valid for this shop
​
user_id
integer
Filter by customer user ID
​
card_id
integer
Filter by loyalty card ID (alternative to user_id)
​
status
string
default:"active"
Filter by status: active, used, expired, all
​
page
integer
default:"1"
Page number for pagination
​
per_page
integer
default:"20"
Items per page (max 100)

​
Response

​
success
boolean
Indicates successful retrieval
​
data
object
curl -X GET "https://staging-api.loyalty.lt/en/shop/coupons?shop_id=1&status=active&per_page=10" \
  -H "X-API-Key: your_api_key" \
  -H "X-API-Secret: your_api_secret"

{
  "success": true,
  "message": "Coupons retrieved successfully",
  "data": {
    "coupons": [
      {
        "id": 123,
        "code": "K1234567890",
        "qr_code": "uuid-1234-5678",
        "status": "active",
        "expires_at": "2025-01-31T23:59:59Z",
        "is_used": false,
        "is_pending": false,
        "offer": {
          "id": 456,
          "title": "Free Coffee",
          "description": "Reward for completing stamp card",
          "discount_type": "game_reward",
          "reward_type": "free_product",
          "reward_details": "Free medium coffee"
        },
        "game": {
          "id": 789,
          "name": "Coffee Stamp Card",
          "type": "stamps",
          "reward_description": "Collect 10 stamps for a free coffee"
        },
        "user": {
          "id": 100,
          "name": "Jonas Jonaitis",
          "email": "jonas@example.com"
        },
        "products": [],
        "categories": [],
        "requires_product_selection": false
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 10,
      "total": 25,
      "last_page": 3
    }
  }
}

Card Coupons

Get coupons for a specific customer

Verify Coupon

Verify a scanned coupon