This documentation page reflects the internal terminology used in YouTap systems. With external integrations, some of the terms will inevitably be different.
\nHere are two of the most notable comparisons:
\n\"Coupons\" are also called \"offers\"
\n\"Customers\" are also \"wallets\"
\nThe aim of \"Loyalty and Promotion\" is to reward customers in as many ways as possible - to encourage loyalty, in response to loyalty, and to guide them towards desirable behaviour.
\nThe primary way to set up rewards for customers is with campaigns - sets of rules that define the requirements to qualify for a certain reward, a description of the campaign for the customer to see, and parameters for when the campaign is active.
\nWhile a campaign runs virtual coupons will be created and allocated to customers who meet the criteria, and the value of the coupons that have been accrued, as well as the balance history and the descriptions of the campaigns that they are eligible for but have not yet met the requirements to be awarded a coupon from.
\nNote: For ELIGIBLE, ASSIGNED, and ELIGIBLE_AS_ASSIGNED it is possible for the customer's to regress to a previous status if the customer takes certain actions such as changing to a changing to a cheaper plan, thereby changing their metadata scores so they don't match the criteria for that campaign any more.
\nELIGIBLE: The customer has matched the eligibility criteria, but not the assignment criteria for this campaign.
\nASSIGNED: The customer has earned the value of the coupon - it has been added to their usable balance.
\nELIGIBLE_AS_ASSIGNED: A technical distinction between the \"assigned\" usable balance and an amount that the user should see as usable. This is so that backend integrations can ignore highly volatile such as those given for trading in old devices and only see the concrete numbers, while the customer sees the amount that they can probably rely on, but will be adjusted slightly at POS.
\nREDEEMED: The customer has fully redeemed the value of this coupon.
\nEXPIRED: The customer did not redeem the coupon before its expiry date. Its value has been removed from their wallet.
\n401: Missing/expired/invalid authorization header. No response body.
\n403: Authorization header not accepted for this resource. No response body.
\n404: Resource not found. Either no response body, or a Problem.
\nOther HTTP status codes, such as 500, are unexpected, but will usually have \"title\", \"path\", and \"status\" parameters.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15470766","collectionId":"bf6c8795-a81f-427a-b990-18f9c78ea8bc","publishedId":"2s8YzWSgAR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00aeef"},"publishDate":"2023-01-24T21:16:55.000Z"},"item":[{"name":"Additional Documentation","item":[],"id":"171e8abf-03ba-4a04-9573-6f159a6ed81d","description":"APIs for trade in journey
\n","_postman_id":"2ddd1420-0c33-4397-9c7c-2056ea353ec4","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"