Gift Vouchers

​

Apply Gift Voucher

​

Authentication

​

Request Body

​

Response

​

Validation Process

1. Code Sanitization - Voucher code is sanitized
2. Ownership Check - Verifies voucher belongs to user (by email or phone)
3. Status Check - Ensures voucher is active (status=1)
4. Cart Validation - Vouchers cannot be applied to gift-voucher-only carts
5. Discount Application - Applies available voucher balance to cart

{
  "products": {
    "items": [
      {
        "prod_id": 12345,
        "product": "Classic T-Shirt",
        "price": 799,
        "quantity": 2,
        "sub_total": 1598
      }
    ]
  },
  "meta": {
    "items": [
      {
        "name": "gift_voucher",
        "voucher_code": "GV2024ABC123"
      },
      {
        "name": "calculations",
        "sub_total": 1598,
        "gift_voucher_value": 500,
        "total": 1098
      }
    ]
  }
}

​

Error Responses

{
  "title": "Bad Request",
  "description": "Please provide the voucher code"
}

{
  "title": "Bad Request",
  "description": "Invalid voucher code"
}

{
  "title": "Bad Request",
  "description": "Gift Voucher not applicable on current cart"
}

​

View Gift Vouchers

​

Authentication

​

Query Parameters

​

Response

[
  {
    "name": "John Doe",
    "voucher_code": "GV2024ABC123",
    "voucher_value": 500,
    "voucher_initial_value": 1000
  },
  {
    "name": "Jane Smith",
    "voucher_code": "GV2024XYZ456",
    "voucher_value": 750,
    "voucher_initial_value": 750
  },
  {
    "event_id": "pageview_1234567890"
  }
]

​

Gift Voucher Ownership

• Email Address - Primary identifier
• Phone Number - Secondary identifier (if email is empty)

​

Database Query Logic

SELECT voucher_code, voucher_value, voucher_initial_value, sender_name
FROM gift_vouchers gv
INNER JOIN users u ON u.id = gv.from_id
WHERE gv.status = 1 
  AND (
    gv.to_id = :user_email 
    OR (gv.to_id IN ('', NULL) AND gv.to_phone = :user_phone)
  )

​

Gift Voucher Restrictions

• Cannot be the only items in cart when applying voucher
• Must have regular products in cart along with gift vouchers
• Voucher must be active (status=1)
• Voucher must belong to the authenticated user
• Partial usage is supported (remaining balance preserved)

​

Purchase Gift Vouchers

• Generated with unique codes
• Sent to recipient’s email/phone
• Tracked in order history
• Activated upon successful payment

​

Tracking & Analytics

• Page views
• Voucher applications
• Purchase events

• User email and phone
• Event source URL
• Action source (web=1, app=2)
• Client IP address
• User agent information