{"_id":"56cc5823f1ee861500685f0f","user":"56caca84245b841300806def","editedParams2":true,"parentDoc":null,"version":{"_id":"56cacb1cc675f50b00a4b61c","project":"56cacb1bc675f50b00a4b619","__v":14,"createdAt":"2016-02-22T08:47:24.528Z","releaseDate":"2016-02-22T08:47:24.528Z","categories":["56cacb1dc675f50b00a4b61d","56cc10aaca43550b0028125a","56cc10b7b4cbcf0b004a5df9","56cc1bb2272aa4130002ccd2","56cc5834b4cbcf0b004a5f8b","56cda18bface161300dae13b","56d51f2873dcd20b00fb87bb","56fbe0610023171700b96105","57658310c176520e00ea9076","5772bdd48c48e00e00503638","577c1dfe87acf617003c3fcd","579525172979790e00771a15","582b4661cdfdc125000c8684","586365cedfe6cc3700a7be63"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"project":"56cacb1bc675f50b00a4b619","category":{"_id":"56cc10aaca43550b0028125a","pages":["56cc1533ca43550b0028125d","56cc52f08fa8b01b00b81e8b","56cc55b994c8f00b00b83dda","56cc5664fcf2d013008474e1","56cc56f2b4cbcf0b004a5f88","56cc5823f1ee861500685f0f"],"project":"56cacb1bc675f50b00a4b619","__v":6,"version":"56cacb1cc675f50b00a4b61c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-23T07:56:26.898Z","from_sync":false,"order":6,"slug":"rest-api","title":"Loyalty REST API"},"editedParams":true,"__v":2,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-23T13:01:23.299Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"delete","results":{"codes":[{"name":"","code":"{\n\t\"code\": 200,\n\t\"results\": points_redeemed_on_loyalty_layer\n}","language":"json","status":200},{"code":"{\n\t\"code\": -3,\n \"status\": \"fail\",\n \"results\": error_message\n}","language":"json","status":400,"name":""}]},"settings":"","auth":"required","params":[{"_id":"56cc52f08fa8b01b00b81e90","ref":"","in":"body","required":true,"desc":"Customer identifier to whom loyalty points are being added. This is for your reference so make sure you use a ID that makes sense to you.","default":"","type":"string","name":"customer_id"},{"_id":"56d29da339b27113009d008f","ref":"","in":"body","required":true,"desc":"Transaction ID","default":"","type":"string","name":"transaction_id"},{"_id":"56cc5823f1ee861500685f10","ref":"","in":"body","required":true,"desc":"Transaction value for which the Redemptions needs to carried","default":"","type":"int","name":"transaction"},{"_id":"56cc52f08fa8b01b00b81e8f","ref":"","in":"body","required":true,"desc":"Value to be redeemed","default":"","type":"int","name":"value"},{"_id":"56cc52f08fa8b01b00b81e8d","ref":"","in":"body","required":false,"desc":"Platform ID you would have configured in the Codemojo dashboard.","default":"","type":"string","name":"platform"},{"_id":"56cc52f08fa8b01b00b81e8c","ref":"","in":"body","required":false,"desc":"Service ID you would have configured in the Codemojo dashboard","default":"","type":"string","name":"service"},{"_id":"56d29dec1d915a0b00a043a9","ref":"","in":"body","required":false,"desc":"Meta info to be associated with this transaction","default":"","type":"string","name":"meta"},{"_id":"56d29dec1d915a0b00a043a8","ref":"","in":"body","required":false,"desc":"Tag for this transaction","default":"","type":"string","name":"tag"}],"url":"/v:version/services/loyalty"},"isReference":true,"order":4,"body":"","excerpt":"Redeem points","slug":"redeem-points","type":"endpoint","title":"Redeem points"}
deleteRedeem points
Redeem points
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Body Params
customer_id:
required
string
Customer identifier to whom loyalty points are being added. This is for your reference so make sure you use a ID that makes sense to you.
transaction_id:
required
string
Transaction ID
transaction:
required
integer
Transaction value for which the Redemptions needs to carried
value:
required
integer
Value to be redeemed
platform:
string
Platform ID you would have configured in the Codemojo dashboard.
service:
string
Service ID you would have configured in the Codemojo dashboard
meta:
string
Meta info to be associated with this transaction
tag:
string
Tag for this transaction