Get All Gift Received | LITT White Label API

{
  "message": "Successfully retrieved all user's gifts.",
  "api": "all-gifts-Received",
  "status": "success",
  "data": {
    "coupons": [],
    "promotions": [],
    "vouchers": [
      {
        "merchant_username": "mrmodsbeer",
        "voucher_id": "355d5007-76b5-4c9d-b89b-992d6496db90",
        "barcode_batch_id": null,
        "country_id": 14,
        "currency_id": 1,
        "zone_id": 0,
        "name": "$10 Voucher",
        "description": "Get $10 to put towards anything on our website - including preorders and subscription products!",
        "balance_options": "10",
        "is_universal": 0,
        "bonus_amount": "0.00",
        "total_bonus_available": "0.00",
        "total_bonus_remaining": "0.00",
        "status": "approved",
        "validity_period": 1095,
        "url": "",
        "created_at": "2024-04-26 03:47:29",
        "updated_at": "2024-04-26 03:47:29",
        "user_voucher_id": "6a93b04-5ace-4749-b4b3-b1d9d735121c",
        "barcode_id": null,
        "user_receiver_id": "0b307581-21d1-4f4d-a9fa-8045111b030e",
        "message": "Thanks Steven. ",
        "expiry_date": "2027-04-26 00:00:00",
        "delivery_date": "2024-04-26 00:00:00",
        "original_balance": "10.00",
        "available_balance": "10.00",
        "category_name": "Bottle Shop",
        "category_id": "57c7c418bd12x",
        "country_name": "Australia",
        "city_name": "Cowes",
        "image_url": "https://d1zm7p5dmuuq6t.cloudfront.net/1353513e-28db-4c21-b022-3126cc25c830/image/669aa796-1f-45db-af1c-b233821c8196.jpg",
        "payment_type": "LITT Wallet",
        "user_buyer": {
          "user_id": "a9a7b9b-ec5b-49d9-a197-db886fccc3ae",
          "name": "Maria S Capili",
          "username": "salvemaria",
          "role": 0,
          "status": 1,
          "merchant": "0",
          "is_litt": 0,
          "parent_id": null,
          "parent_type": null,
          "type": "public",
          "is_show_advt": 1,
          "is_vip": 0,
          "is_local_hero": 0,
          "is_investor": 1,
          "two_factor_code": null,
          "two_factor_expires_at": null,
          "sales_rep": null,
          "littland_referrer": null,
          "created_at": "2021-03-04 06:33:36",
          "updated_at": "2024-04-28 04:40:05",
          "deleted_at": null,
          "last_active": "2024-04-28 04:40:40",
          "last_in_app_otp": null,
          "failed_login": 0,
          "history_passwords": "$2y$10$9LSVrAv1zJ0jPyNlvhoPwefrkm6Zo5CDnumKImzHMFpCPb3/OZLGa",
          "flags": "",
          "user_image": "https://litt-ap-southeast-2.s3-accelerate.amazonaws.com/1353513e-28db-4c21-b022-3126cc25c830/profile/c48008c3-61fd-45ff-b30f-e43295c0e772.jpg",
          "user_profiles": []
        },
        "converted_balance_options": [
          {
            "balance": "10.00",
            "bonus": "0.00",
            "symbol": "A$",
            "converted_balance": "10.00",
            "converted_symbol": "A$",
            "base_currency_balance": "10.00"
          }
        ],
        "converted_original_balance": {
          "balance": "10.00",
          "symbol": "A$",
          "converted_balance": "10.00",
          "converted_symbol": "A$"
        },
        "converted_available_balance": {
          "balance": "10.00",
          "symbol": "A$",
          "converted_balance": "10.00",
          "converted_symbol": "A$"
        },
        "full_address": "247 Settlement Road, Cowes, 3922, VIC, Australia",
        "address_1": "247 Settlement Road",
        "postcode": "3922",
        "city": "Cowes",
        "merchants": [],
        "payments": [
          {
            "payment_id": "ced6382c-bee5-41a8-a126-dde78953c6ec",
            "user_id": "a9a7b9b-ec5b-49d9-a197-db886fccc3ae",
            "origin_id": "6a93b04-5ace-4749-b4b3-b1d9d735121c",
            "type": "voucher",
            "credit_card_id": null,
            "currency_id": 1,
            "exchange_rate": 1.000001,
            "external_transaction_reference": "wallet",
            "amount": "10.00",
            "commission_percentage": "0.00",
            "loyalty_percentage": "0.00",
            "loyalty_min_transaction": "0.00",
            "loyalty_max_cashback": "0.00",
            "commission": "0.00",
            "commission_discount": "0.00",
            "net": "10.00",
            "created_at": "2024-04-26 03:47:29",
            "updated_at": "2024-04-26 03:47:29",
            "credit_card": null
          }
        ],
        "barcode": null,
        "merchant": {
          "merchant_id": "f02cea7-e3c7-4419-b85c-aaec38d34aff",
          "username": "mrmodsbeer",
          "online_store": 1
        },
        "redemptions": [],
        "currency": {
          "id": 1,
          "name": "Australian Dollar",
          "code": "AUD",
          "code_symbol": "A$",
          "exchange_rate": 1.000001,
          "decimal_digits": 2,
          "rounding": 0,
          "status": 1,
          "is_base_currency": true
        },
        "voucher": {
          "merchant": {
            "merchant_info": {
              "external_merchant_id": "x"
            }
          }
        }
      }
    ],
    "cot_prizes": [
      {
        "id": 11,
        "promotion_id": null,
        "category": "1",
        "asset_name": "https://img.icons8.com/?size=128&id=69655&format=png",
        "numeric_value": 30,
        "display_value": "Orange $5 Prize",
        "item_rank": "1",
        "branding_theme": "3",
        "background_color": "2",
        "theme_index": 1,
        "theme_color_1": "144894",
        "theme_color_2": "F05323",
        "icon_text_1": "$5 Prize",
        "icon_text_2": "Text2",
        "expiry_date": null,
        "enabled": 1,
        "created_at": "2024-03-17 00:00:56",
        "updated_at": "2024-03-17 00:00:56",
        "brand_name": "PartyCityTest",
        "image_url": "https://www.dropbox.com/scl/fi/8wrugczfsrmaiat5kwf5v/bannerhoriz1.png?rlkey=8n84tg08avbrsqwncsyuv8s4y&raw=1"
      }
    ]
  }
}

This endpoint provides users with a full list of received gifts including vouchers, coupons, promotions, and prizes through the City Of Treasture (COT) in a paged format. For each gift type, associated information, such as merchant details, balance, validity, and images are included for the user’s convenience.

Request Body

page (integer): Indicates the page number to display when more than one page of results is possible.

Response

coupons (array): An array containing details of any coupons the user has received.
promotions (array): An array detailing any promotions the user has been awarded.
vouchers (array): An array with the data related to any vouchers the user has received.
- For each voucher, the data includes details such as the voucher ID, description, original and available balance, expiry date, etc.
cot_prizes (array): An array listing any prizes the user has won through City Of Treasture (COT).
- For each prize, data such as the prize ID, numeric value, expiry date, image URL, etc., is included.

Query parameters

api_tokenstringOptional

Response

Get All Gift Received

messagestringOptional

apistringOptional

statusstringOptional

dataobjectOptional