Storyous Public APIs
  1. Loyalty api
Storyous Public APIs
  • Introduction
  • Merchants API
    • Get merchant and all its places
  • Menu API
    • Get a menu tree
    • Get time-based menu
    • Get Remaining amounts of time-based menu
  • Bills API
    • Get list of payment bills
    • Get detail of a payment bill
  • Delivery API
    • Create an order through delivery API
    • Get status of delivery order
  • Deskview API
    • Get list of desks
    • Get list of sections
    • Get desk view of a place
  • Features API
    • Get list of merchants/places with a feature
  • Hotel accounts integration API
    • Provide list of accounts
    • Write consumed items to hotel account
  • Stocks API
    • Get list of stocks
    • Get list of items
    • Get list of stock ups
    • Get detail of stock up
    • Create new stock up
    • Modify stock up
    • Delete stock up
    • Get list of stock takings
    • Get detail of stock taking
    • Create new stock taking
    • Modify stock taking
    • Delete stock taking
    • Get suppliers
  • Loyalty API
    • Introduction
    • Get benefit offer
    • Report offer validation error
    • Report benefit usage
    • Get loyalty benefit usages
    • Mark benefit usages as synchronized
  • DataSync
    • Webhook receiving endpoint
      • Receive new or updated records
    • Data domains
      • Stock management
        • Stocks domain
        • StockItemCategories domain
        • StockItems domain
        • StockMovements domain
      • Sales and costs
        • Bills domain
        • BillCosts domain
        • TerminalTransactions domain
        • PaymentTypes domain
        • Loyalty domain
      • Desks
        • DeskSections domain
        • Desks domain
      • Menu
        • ItemCategories domain
        • Items domain
        • PlaceITems domain
      • Merchants
        • Merchants domain
        • Places domain
        • Persons domain
  • Schemas
    • Schemas
      • Loyalty api
        • BalanceBenefitOfferRequest
        • ThirdPartyLoyaltyOfferRequest
        • LoyaltyOfferValidationError
        • LoyaltyBenefitUsagesPayload
        • BenefitInput
        • PaidItem
        • Applied Benefits
        • PaymentByBalance
        • UsedBalance
        • LoyaltyOfferResponse
        • MenuProductDefinition
        • UsedGeneralDiscount
      • Desk
      • Section
  1. Loyalty api

LoyaltyOfferResponse

{
    "loyaltyOfferId": "string",
    "customer": {
        "loyaltyStatus": "string",
        "fullName": "string",
        "customerId": "string"
    },
    "benefitInputs": [
        {
            "inputCode": "string",
            "posTitle": "string",
            "applicable": true,
            "reasonCode": "string"
        }
    ],
    "generalDiscounts": [
        {
            "generalDiscountId": "string",
            "posTitle": "string",
            "isItemSpecific": true,
            "billTitle": "string",
            "valueToUse": 0
        }
    ],
    "balances": [
        {
            "balanceId": "string",
            "publicIdentifier": "string",
            "type": "multiPurposePrepaidVoucher",
            "posTitle": "string",
            "billTitle": "string",
            "rejectedByPOS": false,
            "isItemSpecific": true,
            "valueToUseCanBeControlled": true,
            "possibleToTopUpByPrepayment": true,
            "currentBalance": 0,
            "nonControllableValueToUse": 0,
            "controllableValueToUse": 0,
            "maxControllableValueToUse": 0,
            "minStep": 1,
            "valueToUseInCurrency": 0,
            "valueToPrepay": 0,
            "valueToEarn": 0,
            "balanceAfterTransaction": 0
        }
    ],
    "itemBenefitsToApply": [
        {
            "checkItemId": "string",
            "benefits": [
                {
                    "sourceType": "balance",
                    "appliedFromBalanceId": "string",
                    "appliedFromGeneralDiscountId": "string",
                    "absoluteTotalValue": 0
                }
            ]
        }
    ],
    "posMessages": [
        "string"
    ],
    "billMessages": [
        "string"
    ],
    "metadata": "string"
}
Built with