> For the complete documentation index, see [llms.txt](https://help.openloyalty.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.openloyalty.io/api-reference/reward/get-redeemed-rewards-details-1.md).
# Get redeemed reward's details
Integration\
\
This method returns detailed information about a specific redeemed reward.
````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Reward","description":"These endpoints allow you to easily manage rewards."}],"servers":[{"url":"http://openloyalty.localhost"}],"security":[{"Bearer":[]},{"token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Open Loyalty has the JWT authorization.\nTo learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens \n\n### Obtain an access token\n\nSend a request with the parameters username and password\n\n#### Definition\n\n`POST /api/admin/login_check` [Go to definition](#operation/adminLoginCheck)\\\n`POST /api/{storeCode}/member/login_check` [Go to definition](#operation/memberLoginCheck)\n\n#### Example\n\n```bash\ncurl {HOST}/api/admin/login_check\n -H 'Content-Type: application/json;charset=UTF-8'\n -H 'Accept: application/json, text/plain, */*'\n --data-binary '{\"username\":\"admin\",\"password\":\"password\"}'\n```\n\n#### Example Response\n\n```json\n{\n \"token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6...\",\n \"refresh_token\":\"0558f8bb29948c4e54c443f...\"\n}\n```\n\n### Using JSON Web Token\n\nAdd authorization header to each request\\\n`Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...`\\\nYou can now access any API method you want under the /api prefix.\n\n#### Example\n```bash\ncurl {HOST}/api/{storeCode}/analytics/members\n -H 'Accept: application/json'\n -H 'Content-type: application/x-www-form-urlencoded'\n -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'\n```\n\n### Refresh JSON Web Token\nYou can refresh token using refresh_token that was given during login.\\\nThere are two endpoints\\\nTo refresh admin token `POST /api/token/refresh` [Go to definition](#operation/tokenRefresh)\\\nTo refresh member token `POST /api/{storeCode}/token/refresh` [Go to definition](#operation/tokenRefreshMember)\n","bearerFormat":"JWT","scheme":"bearer"},"token":{"type":"apiKey","name":"X-AUTH-TOKEN","in":"header"}},"parameters":{"storeCode":{"name":"storeCode","in":"path","description":"Store code","required":true,"schema":{"type":"string"}},"issuedReward":{"name":"issuedReward","in":"path","description":"IssuedReward ID","required":true,"schema":{"type":"string","format":"uuid"}}},"schemas":{"StaticIssuedReward":{"properties":{"rewardId":{"type":"string","format":"uuid"},"issuedRewardId":{"type":"string","format":"uuid"},"name":{"type":"string"},"tax":{"type":"number","format":"float"},"taxPriceValue":{"type":"number","format":"float"},"price":{"type":"number","format":"float"},"customerId":{"type":"string","format":"uuid"},"status":{"type":"string"},"redemptionDate":{"type":"string","format":"date-time"},"issuedCoupon":{"properties":{"code":{"type":"string"},"value":{"type":"number","format":"float"},"activeFrom":{"type":"string","format":"date-time"},"activeTo":{"type":"string","format":"date-time"},"usedAt":{"type":"string","format":"date-time"}},"type":"object"},"customerData":{"properties":{"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"loyaltyCardNumber":{"type":"string"},"address":{"type":"object"}},"type":"object"},"costInPoints":{"type":"number","format":"float"},"token":{"type":"string"},"rewardType":{"type":"string"},"actionCause":{"$ref":"#/components/schemas/ActionCause"},"cancelledAt":{"type":"string","format":"date-time"}},"type":"object"},"ActionCause":{"properties":{"campaignId":{"type":"string","format":"uuid","nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"transactionId":{"type":"string","format":"uuid","nullable":true},"customEventId":{"type":"string","format":"uuid","nullable":true},"internalEventName":{"type":"string","nullable":true},"performedAt":{"description":"The date and time when the event was performed (purchase for transactions, registration for custom events). Equivalent to purchasedAt and eventDate. This value is null if actionCause does not come from a campaign.","type":"string","format":"date-time","nullable":true},"rewardId":{"description":"The reward definition ID when the transfer is related to a reward purchase or to a reward drawn from a Fortune Wheel.","type":"string","format":"uuid","nullable":true},"issuedRewardId":{"description":"The issued reward instance ID when the transfer is related to a reward redemption or to a reward drawn from a Fortune Wheel.","type":"string","format":"uuid","nullable":true}},"type":"object"},"MaterialIssuedReward":{"properties":{"rewardId":{"type":"string","format":"uuid"},"issuedRewardId":{"type":"string","format":"uuid"},"name":{"type":"string"},"customerId":{"type":"string","format":"uuid"},"status":{"type":"string"},"redemptionDate":{"type":"string","format":"date-time"},"customerData":{"properties":{"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"loyaltyCardNumber":{"type":"string"},"address":{"type":"object"}},"type":"object"},"costInPoints":{"type":"number"},"token":{"type":"string"},"rewardType":{"type":"string"},"actionCause":{"$ref":"#/components/schemas/ActionCause"},"cancelledAt":{"type":"string","format":"date-time"}},"type":"object"},"ConversionCouponIssuedReward":{"properties":{"rewardId":{"type":"string","format":"uuid"},"issuedRewardId":{"type":"string","format":"uuid"},"name":{"type":"string"},"tax":{"type":"number","format":"float"},"taxPriceValue":{"type":"number","format":"float"},"price":{"type":"number","format":"float"},"customerId":{"type":"string","format":"uuid"},"status":{"type":"string"},"redemptionDate":{"type":"string","format":"date-time"},"issuedCoupon":{"properties":{"code":{"type":"string"},"value":{"type":"number","format":"float"},"activeFrom":{"type":"string","format":"date-time"},"activeTo":{"type":"string","format":"date-time"},"usedAt":{"type":"string","format":"date-time"}},"type":"object"},"customerData":{"properties":{"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"loyaltyCardNumber":{"type":"string"},"address":{"type":"object"}},"type":"object"},"costInPoints":{"type":"number","format":"float"},"token":{"type":"string"},"rewardType":{"type":"string"},"unitsConversion":{"properties":{"ratio":{"type":"number","format":"float"},"rounding":{"type":"string","enum":["up","down","default"]}},"type":"object"},"actionCause":{"$ref":"#/components/schemas/ActionCause"},"cancelledAt":{"type":"string","format":"date-time"}},"type":"object"},"DynamicIssuedReward":{"properties":{"rewardId":{"type":"string","format":"uuid"},"issuedRewardId":{"type":"string","format":"uuid"},"name":{"type":"string"},"tax":{"type":"number","format":"float"},"taxPriceValue":{"type":"number","format":"float"},"price":{"type":"number","format":"float"},"customerId":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["issued","pending","approved","rejected","canceled","packing","awaiting_shipping","shipped","completed","returned"]},"redemptionDate":{"type":"string","format":"date-time"},"issuedCoupon":{"properties":{"code":{"type":"string"},"value":{"type":"number","format":"float"},"activeFrom":{"type":"string","format":"date-time"},"activeTo":{"type":"string","format":"date-time"},"usedAt":{"type":"string","format":"date-time"}},"type":"object"},"customerData":{"properties":{"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"loyaltyCardNumber":{"type":"string"},"address":{"type":"object"}},"type":"object"},"costInPoints":{"type":"number","format":"float"},"token":{"type":"string"},"rewardType":{"type":"string"},"actionCause":{"$ref":"#/components/schemas/ActionCause"},"cancelledAt":{"type":"string","format":"date-time"}},"type":"object"},"FortuneWheelIssuedReward":{"properties":{"rewardId":{"type":"string","format":"uuid"},"issuedRewardId":{"type":"string","format":"uuid"},"name":{"type":"string"},"customerId":{"type":"string","format":"uuid"},"status":{"type":"string"},"redemptionDate":{"type":"string","format":"date-time"},"customerData":{"properties":{"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phone":{"type":"string"},"loyaltyCardNumber":{"type":"string"},"address":{"type":"object"}},"type":"object"},"costInPoints":{"type":"number"},"token":{"type":"string"},"rewardType":{"type":"string"},"actionCause":{"$ref":"#/components/schemas/ActionCause"},"cancelledAt":{"type":"string","format":"date-time"},"fortuneWheelStatus":{"required":["drawnAt","ruleName","effects"],"properties":{"drawnAt":{"type":"string","format":"date-time"},"ruleName":{"type":"string"},"effects":{"type":"array","items":{"$ref":"#/components/schemas/EffectResponse"}}},"type":"object","additionalProperties":false}},"type":"object"},"EffectResponse":{"oneOf":[{"title":"Unit Effect","required":["type","status"],"properties":{"type":{"type":"string","enum":["unit"]},"status":{"$ref":"#/components/schemas/EffectStatus"},"transfer":{"required":["transferId","walletCode","units"],"properties":{"transferId":{"type":"string","format":"uuid"},"walletCode":{"type":"string"},"units":{"type":"number","format":"float"}},"type":"object","additionalProperties":false}},"type":"object","additionalProperties":false},{"title":"Redemption Effect","required":["type","status"],"properties":{"type":{"type":"string","enum":["redemption"]},"status":{"$ref":"#/components/schemas/EffectStatus"},"redemption":{"required":["issuedRewardId","rewardId"],"properties":{"issuedRewardId":{"type":"string","format":"uuid"},"rewardId":{"type":"string","format":"uuid"},"name":{"type":"string"}},"type":"object","additionalProperties":false}},"type":"object","additionalProperties":false}]},"EffectStatus":{"required":["code"],"properties":{"code":{"type":"string","enum":["success","partial_success","failure"]},"message":{"type":"string"}},"type":"object","additionalProperties":false}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"AccessDenied":{"description":"Forbidden.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"NotFound":{"description":"Not found.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}}},"paths":{"/api/{storeCode}/redemption/{issuedReward}":{"get":{"tags":["Reward"],"summary":"Get redeemed reward's details","description":"
\nThis method returns detailed information about a specific redeemed reward.\n","operationId":"redemptionGet","parameters":[{"$ref":"#/components/parameters/storeCode"},{"$ref":"#/components/parameters/issuedReward"},{"name":"format","in":"query","description":"If set to html, the descriptions will be in HTML format. Omit for raw output.","required":false,"schema":{"type":"string","format":"html|raw"}}],"responses":{"200":{"description":"Returned when successful","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/StaticIssuedReward"},{"$ref":"#/components/schemas/MaterialIssuedReward"},{"$ref":"#/components/schemas/ConversionCouponIssuedReward"},{"$ref":"#/components/schemas/DynamicIssuedReward"},{"$ref":"#/components/schemas/FortuneWheelIssuedReward"}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
````
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://help.openloyalty.io/api-reference/reward/get-redeemed-rewards-details-1.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.