Tally Platform API
member-promotion
Get Member Promotions
1 min
code examples curl location globoff 'https //api b preview\ loyaltyservices io/api/v3/members/{memberidentifier}/promotions?includecoupondetails=boolean' \\ \ header 'accept application/json' \\ \ header 'content type application/json'require "uri" require "json" require "net/http" url = uri("https //api b preview\ loyaltyservices io/api/v3/members/{memberidentifier}/promotions?includecoupondetails=boolean") https = net http new(url host, url port) https use ssl = true request = net http get new(url) request\["accept"] = "application/json" request\["content type"] = "application/json" response = https request(request) puts response read body import requests import json url = "https //api b preview\ loyaltyservices io/api/v3/members/{memberidentifier}/promotions?includecoupondetails=boolean" payload = {} headers = { 'accept' 'application/json', 'content type' 'application/json' } response = requests request("get", url, headers=headers, data=payload) print(response text) okhttpclient client = new okhttpclient() newbuilder() build(); mediatype mediatype = mediatype parse("application/json"); requestbody body = requestbody create(mediatype, ""); request request = new request builder() url("https //api b preview\ loyaltyservices io/api/v3/members/{memberidentifier}/promotions?includecoupondetails=boolean") method("get", body) addheader("accept", "application/json") addheader("content type", "application/json") build(); response response = client newcall(request) execute(); responses // success \[ { "memberpromotionid" "", "qualifydatetime" "", "lastupdatedby" "", "registeredby" "", "promotion" { "promotionid" "", "promotioncode" "", "promotionname" "", "promotiondescription" "", "promotiontypecode" "", "promotionsubtypecode" "", "registerstartdatetime" "", "registerenddatetime" "", "registrationchannelcodes" \[ "" ], "autoregister" false, "startdate" "", "enddate" "", "accrualtypecode" "", "callcenteronly" false, "displayonline" false, "displayonlineuntildatetime" "", "customdata" { "ace01" "", "ace01description" "", "ace02" "", "ace02description" "", "ace03" "", "ace03description" "", "ace04" "", "ace04description" "", "ace05" "", "ace05description" "", "ace06" "", "ace06description" "", "ace07" "", "ace07description" "", "ace08" "", "ace08description" "", "ace09" "", "ace09description" "", "ace10" "", "ace10description" "", "ace11" "", "ace11description" "", "ace12" "", "ace12description" "", "ace13" "", "ace13description" "", "ace14" "", "ace14description" "", "ace15" "", "ace15description" "", "ace01smartgroupid" "", "ace02smartgroupid" "", "ace03smartgroupid" "", "ace04smartgroupid" "", "ace05smartgroupid" "", "ace06smartgroupid" "", "ace07smartgroupid" "", "ace08smartgroupid" "", "ace09smartgroupid" "", "ace10smartgroupid" "", "ace11smartgroupid" "", "ace12smartgroupid" "", "ace13smartgroupid" "", "ace14smartgroupid" "", "ace15smartgroupid" "" }, "genericitem" { "contentcode" "bonus100", "contenttypecode" "header", "name" "bonus 100 points", "shortdescription" "award 100 points", "description" "award 100 points on 100th stay", "alternatedescription" "award 100 points on 100th stay", "termsandconditions" "terms and conditions for this promotion", "title" "award 100 points", "label" "100 points awarded", "logokey" "100 points png", "displaytypekey" "100 points", "startdate" "", "enddate" "", "url" "/loyaltyprogram/bonus/100 points", "tiercode" "b", "displayforall" true, "descriptorcode" "limited time" }, "gracelimit" "", "hasminuserroletoregister" false, "includesunday" false, "includemonday" false, "includetuesday" false, "includewednesday" false, "includethursday" false, "includefriday" false, "includesaturday" false, "minimumaccrualamount" 0, "occurrencelimit" "", "partnerprogramcode" "", "currencycategorycode" "", "processretroaccruals" false, "restrict" false, "memberlistid" "", "slidingqualificationperiod" "", "tiercode" "", "trackregistrationsource" false, "prequalificationcounters" \[ { "countertypecode" "", "target" 0, "result" \[ { "type" "", "value" "", "valuetype" "", "description" "", "resultawardid" "", "resultawardcode" "", "bonusbyactivity" false, "displayname" "" } ] } ], "counters" \[ { "countertypecode" "", "target" 0, "result" \[ { "type" "", "value" "", "valuetype" "", "description" "", "resultawardid" "", "resultawardcode" "", "bonusbyactivity" false, "displayname" "" } ] } ], "resultcommunication" false, "resultcommunicationid" "", "resultcurrency" false, "resultcurrencyamount" 0, "resultcurrencycategorycode" "", "resultcurrencytierqualifier" false, "resultexternal" false, "resultexternalcode" "", "resultpromotion" false, "resultpromotionid" "", "resulttier" false, "resulttiercode" "", "resulttierexpiredatetime" "", "rewardthresholds" false, "results" \[ { "type" "", "value" "", "valuetype" "", "description" "", "resultawardid" "", "resultawardcode" "", "bonusbyactivity" false, "displayname" "" } ], "statuscode" "", "renewablecounters" false }, "registered" false, "registerdatetime" "", "registerchannelcode" "", "createdatetime" "", "enddatetime" "", "timesawarded" "", "nextawardthreshold" 0, "promotionregistrationsource" "", "prequalificationcounters" \[ { "countertypecode" "", "target" 0, "progress" 0, "percentage" 0, "result" \[ { "type" "", "value" "", "valuetype" "", "description" "", "resultawardid" "", "resultawardcode" "", "bonusbyactivity" false, "displayname" "", "membercoupons" \[ { "membercouponid" 147258369, "memberidentifier" "", "coupon" { "couponid" 147258369, "offer" { "offerid" 147258369, "offertypecode" "discount", "code" "alon2020", "name" "free night", "description" "award double points", "featureversion" 2, "statuscode" "enabled", "startdatetime" "", "enddatetime" "", "offerattributes" \[ { "" "" } ] }, "code" "zpvwtarow2oq", "statuscode" "activated", "startdate" "", "enddate" "", "usetypecode" "single", "uselimit" 1, "currentuse" 1, "couponuses" \[ { "usedatetime" "", "statuscode" "used", "channelcode" "system", "alias" "", "usecount" 1, "couponuseattributes" \[ { "" "" } ] } ], "couponattributes" \[ { "couponattributeid" 147258369, "attribute" { "" "" }, "value" "2021 12 31t12 00 00", "requireonuse" true, "requireonhold" false } ] }, "sourcetypecode" "promotion", "sourcereferencerulecode" "staybonus", "sourcereferenceid" 147258369, "aggregatestatuscode" "active", "statuscode" "active", "transferable" false, "previouslytransferred" false } ] } ] } ], "counters" \[ { "countertypecode" "", "target" 0, "progress" 0, "percentage" 0, "result" \[ { "type" "", "value" "", "valuetype" "", "description" "", "resultawardid" "", "resultawardcode" "", "bonusbyactivity" false, "displayname" "", "membercoupons" \[ { "membercouponid" 147258369, "memberidentifier" "", "coupon" { "couponid" 147258369, "offer" { "offerid" 147258369, "offertypecode" "discount", "code" "alon2020", "name" "free night", "description" "award double points", "featureversion" 2, "statuscode" "enabled", "startdatetime" "", "enddatetime" "", "offerattributes" \[ { "" "" } ] }, "code" "zpvwtarow2oq", "statuscode" "activated", "startdate" "", "enddate" "", "usetypecode" "single", "uselimit" 1, "currentuse" 1, "couponuses" \[ { "usedatetime" "", "statuscode" "used", "channelcode" "system", "alias" "", "usecount" 1, "couponuseattributes" \[ { "" "" } ] } ], "couponattributes" \[ { "couponattributeid" 147258369, "attribute" { "" "" }, "value" "2021 12 31t12 00 00", "requireonuse" true, "requireonhold" false } ] }, "sourcetypecode" "promotion", "sourcereferencerulecode" "staybonus", "sourcereferenceid" 147258369, "aggregatestatuscode" "active", "statuscode" "active", "transferable" false, "previouslytransferred" false } ] } ] } ], "details" \[ { "accrualdatetime" "", "description" "", "customdata" { "ace01" "", "ace01description" "", "ace02" "", "ace02description" "", "ace03" "", "ace03description" "", "ace04" "", "ace04description" "", "ace05" "", "ace05description" "", "ace06" "", "ace06description" "", "ace07" "", "ace07description" "", "ace08" "", "ace08description" "", "ace09" "", "ace09description" "", "ace10" "", "ace10description" "", "ace11" "", "ace11description" "", "ace12" "", "ace12description" "", "ace13" "", "ace13description" "", "ace14" "", "ace14description" "", "ace15" "", "ace15description" "" }, "cycle" "", "contributedtoprequalification" false, "slidingqualificationawarded" false, "checkindate" "", "checkoutdate" "", "reservationnumber" "", "counters" \[ { "countertypecode" "", "countervalue" 0 } ] } ], "results" \[ { "type" "", "value" "", "valuetype" "", "description" "", "resultawardid" "", "resultawardcode" "", "bonusbyactivity" false, "displayname" "", "membercoupons" \[ { "membercouponid" 147258369, "memberidentifier" "", "coupon" { "couponid" 147258369, "offer" { "offerid" 147258369, "offertypecode" "discount", "code" "alon2020", "name" "free night", "description" "award double points", "featureversion" 2, "statuscode" "enabled", "startdatetime" "", "enddatetime" "", "offerattributes" \[ { "offerattributeid" 147258369, "attribute" { "" "" }, "defaultvalue" "standard", "requireonuse" true, "requireonhold" true, "includeonresponse" false, "attributetypecode" "validation", "operatorcode" "eq", "operand" "gi", "smartgroupid" 147258369 } ] }, "code" "zpvwtarow2oq", "statuscode" "activated", "startdate" "", "enddate" "", "usetypecode" "single", "uselimit" 1, "currentuse" 1, "couponuses" \[ { "usedatetime" "", "statuscode" "used", "channelcode" "system", "alias" "", "usecount" 1, "couponuseattributes" \[ { "couponuseattributeid" 147258369, "attribute" { "" "" }, "value" "standard" } ] } ], "couponattributes" \[ { "couponattributeid" 147258369, "attribute" { "attributeid" 147258369, "typecode" "validation", "statuscode" "enabled", "name" "accountnumber", "description" "account number", "datatypecode" "open" }, "value" "2021 12 31t12 00 00", "requireonuse" true, "requireonhold" false } ] }, "sourcetypecode" "promotion", "sourcereferencerulecode" "staybonus", "sourcereferenceid" 147258369, "aggregatestatuscode" "active", "statuscode" "active", "transferable" false, "previouslytransferred" false } ] } ], "relatedpromotions" \[ { "" "" } ] } ]// bad request { "errors" \[ { "code" "", "fieldname" "", "message" "", "messageparameters" \[ {} ] } ] }// unauthorized // forbidden // internal error