Tally Platform API
coupon-compensation
Get Compensation by Coupon Code or Confirmation Number
1 min
code examples curl location 'https //api b preview\ loyaltyservices io/api/v4/compensation' \\ \ 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/v4/compensation") 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/v4/compensation" 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/v4/compensation") method("get", body) addheader("accept", "application/json") addheader("content type", "application/json") build(); response response = client newcall(request) execute(); responses // success { "compensations" \[ { "compensationid" 0, "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" { "attributeid" 147258369, "typecode" "validation", "statuscode" "enabled", "name" "accountnumber", "description" "account number", "datatypecode" "open" }, "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" { "attributeid" 147258369, "typecode" "validation", "statuscode" "enabled", "name" "accountnumber", "description" "account number", "datatypecode" "open" }, "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 } ] }, "accountnumber" "", "confirmationnumber" "", "startdatetime" "", "enddatetime" "", "compensationstatus" "processed", "comment" "", "reason" "", "type" "", "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" "" }, "compensationnights" \[ { "compensationnightid" 0, "compensationdate" "", "compensationnightstatus" "processed", "compensationdetailamounts" \[ { "compensationdetailamountid" 0, "couponuseamount" 0, "category" "", "reason" "" } ] } ] } ] }// bad request { "errors" \[ { "code" "", "fieldname" "", "message" "", "messageparameters" \[ {} ] } ] }// unauthorized // forbidden // internal error