BigCity Rewards Management

Manage and retrieve reward offerings, denominations, and product mappings in the BigCity rewards system.

Overview

The rewards management system allows companies to:

Retrieve Denominations

Get available reward denominations and values

SKU Mappings

View product SKU mappings for each reward

Check Availability

Monitor reward availability and quantities

Status Monitoring

Track reward status and trigger conditions

Prerequisites

Company Authentication

Valid company auth token from /v1/company/auth

Active Company Account

Account must be in "Active" state

API Access

Proper permissions for rewards listing

API Endpoint

GET /v1/bigcity/rewards

Retrieve a comprehensive list of all available reward brands, denominations, and their associated product SKUs.

Authentication

Requires company authentication token obtained from the company auth endpoint.

Required Headers

Authorization: Bearer {company_auth_token}
Content-Type: application/json

Parameters

None - This endpoint returns all available rewards.

Request Example

curl -X GET https://api.bigcity.in/v1/bigcity/rewards \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." \
  -H "Content-Type: application/json"

Response Examples

200 OK
[
  {
    "id": 1,
    "denomination_value": "10",
    "status": 1,
    "qty_trigger_limit": "0",
    "qty": "0",
    "skus": "BIGCITY Seeds\t1200"
  },
  {
    "id": 4,
    "denomination_value": "30",
    "status": 1,
    "qty_trigger_limit": "0",
    "qty": "0",
    "skus": "BIGCITY Oats - All Variants"
  },
  {
    "id": 3,
    "denomination_value": "40",
    "status": 1,
    "qty_trigger_limit": "0",
    "qty": "0",
    "skus": "BIGCITY Herbs 800"
  },
  {
    "id": 5,
    "denomination_value": "50",
    "status": 1,
    "qty_trigger_limit": "0",
    "qty": "0",
    "skus": "BIGCITY 5 Grain"
  }
]
401 Unauthorized
{
  "name": "Unauthorized",
  "message": "Invalid company token",
  "code": 0,
  "status": 401,
  "type": "yii\\web\\HttpException"
}

Response Schema

Reward Object

Field Type Description
id integer Unique reward identifier
denomination_value string Monetary value of the reward
status integer Reward status (1 = Active, 0 = Inactive)
qty_trigger_limit string Minimum quantity threshold for availability
qty string Current available quantity
skus string Product SKUs eligible for this reward (tab-separated)

Status Codes

200

Success

Continue with reward processing

401

Unauthorized

Refresh company authentication token

403

Forbidden

Check company account permissions

429

Rate Limited

Implement retry with exponential backoff

Reward Status Interpretation

Status Values

1 (Active) Reward is available for redemption
0 (Inactive) Reward is temporarily unavailable

Quantity Management

qty: Current stock available for immediate redemption
qty_trigger_limit: Minimum threshold before low stock alerts
Unlimited: When qty = "0" but status = 1, rewards have unlimited availability

SKU Format

SKUs are tab-separated values containing:

  • Product name
  • Variant information
  • Quantity specifications (if applicable)

Example SKU Parsing:

"BIGCITY Seeds\t1200" 
→ Product: "BIGCITY Seeds"
→ Quantity: "1200"