> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omneo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Redemptions

<Info>
  Use these endpoints for bulk redemption queries or integration work. When reading redemptions for a specific customer, use [Profile Redemptions](/api-reference/profile-redemption) instead.
</Info>

```json theme={null}
{
   "data":[
      {
         "id":158,
         "profile_id":"92a7996b-axb6-4c9c-a845-938222fab6",
         "type":"redeem",
         "total":10,
         "total_localised":10,
         "meta":null,
         "transaction_id":64,
         "items":[
            {
               "id":159,
               "type":"reward",
               "type_attributes":{
                  "id":7,
                  "profile_id":"92a7996b-axb6-4c9c-a845-938222fab6",
                  "timezone":"Australia/Melbourne",
                  "value_initial":10,
                  "value_remaining":0,
                  "has_notified_issue":null,
                  "has_notified_expiry":null,
                  "expires_at":"2022-02-18 12:59:59",
                  "issued_at":"2021-02-09 13:00:00",
                  "is_expired":false,
                  "is_active":false,
                  "issued_local_at":"2021-02-10 00:00:00",
                  "expires_local_at":"2022-02-18 23:59:59",
                  "notify_issue_at":null,
                  "notify_expiry_at":null,
                  "extended_at":null,
                  "definition":{
                     "id":6,
                     "name":"Birthday Reward",
                     "handle":"birthday-reward",
                     "period":30,
                     "description":"Birthday reward valid for 30 days",
                     "short_description":"It's your birthday! $10 for you!",
                     "long_description":"<p> Another year! enjoy $10 off your purchase </p>",
                     "terms_conditions":"Valid for 30 days",
                     "earn_instructions":"Be a member with us, and receive $10 off on your B'day!",
                     "icon":"https://example.com/icon",
                     "image_url":"https://example.com/image",
                     "issue_target_id":null,
                     "expiry_target_id":null,
                     "notify_issue_offset":null,
                     "notify_expiry_offset":null,
                     "internal_notes":"Available once per year",
                     "type":"birthday",
                     "value":10,
                     "is_extendable":false,
                     "is_assignable":true,
                     "is_reassignable":false,
                     "is_published":true,
                     "tags":[
                        "bday",
                        "anniversary"
                     ],
                     "created_at":"2021-02-09 23:54:29",
                     "updated_at":"2021-02-09 23:54:30"
                  },
                  "meta":null,
                  "created_at":"2021-02-10 00:15:45",
                  "updated_at":"2021-02-10 00:34:39"
               },
               "created_at":"2021-02-10 00:34:39",
               "updated_at":"2021-02-10 00:34:39"
            }
         ],
         "created_at":"2021-02-10 00:34:39",
         "updated_at":"2021-02-10 00:34:39"
      },
      {
         "id":159,
         "profile_id":"92a7996b-axb6-4c9c-a845-938222fab6",
         "type":"redeem",
         "total":0,
         "total_localised":0,
         "meta":null,
         "transaction_id":71,
         "items":[
            {
               "id":160,
               "type":"benefit",
               "type_attributes":{
                  "id":201,
                  "profile_id":"92a7996b-axb6-4c9c-a845-938222fab6",
                  "external_id":null,
                  "expires_at":"2021-03-17 23:59:59",
                  "issued_at":"2021-03-10 06:47:47",
                  "is_expired":false,
                  "is_redeemable":false,
                  "redemptions_remaining":0,
                  "total_global_redemptions_remaining":0,
                  "definition":{
                     "id":"94",
                     "name":"First Spend Discount",
                     "handle":"first-spend",
                     "period":7,
                     "description":"Member first spend 10% discount",
                     "internal_notes":"Only assigned to members with no transactions",
                     "short_description":"Get 10% off your first spend with us!",
                     "long_description":"<p>Get 10% off your first shop. Valid for 7 days </p>",
                     "terms_conditions":"Terms and conditions apply",
                     "earn_instructions":"After signing up, get 10% off your first shop",
                     "redeem_instructions_store":"Can be redeemed in store",
                     "redeem_instructions_online":"Can be redeemed online",
                     "redeem_code_pos":"9913144",
                     "redeem_code_online":"9900131",
                     "icon":"http://example.com/icon",
                     "image_url":"http://example.com/image",
                     "max_redemptions":1,
                     "is_extendable":false,
                     "is_assignable":true,
                     "is_reassignable":false,
                     "is_published":true,
                     "is_archived":false,
                     "tags":[
                        "first-spend",
                        "new-member"
                     ],
                     "is_claimable":false,
                     "max_global_redemptions":null,
                     "claim_period_start_at":null,
                     "claim_period_end_at":null,
                     "claim_condition":null,
                     "is_reclaimable":null,
                     "notify_schedule_offset":null,
                     "notify_issue_offset_days":null,
                     "notify_issue_offset_hour":null,
                     "notify_remind_offset_days":null,
                     "notify_remind_offset_hour":null,
                     "notify_extend_offset_days":null,
                     "notify_extend_offset_hour":null,
                     "remind_target_id":null,
                     "extend_target_id":null,
                     "issue_target_id":null,
                     "end_at":null,
                     "total_allocations":null,
                     "total_allocations_remaining":null,
                     "force_allocation":null,
                     "created_at":"2021-02-10 02:57:02",
                     "updated_at":"2021-02-10 02:57:03"
                  },
                  "timezone":"Australia/Melbourne",
                  "claimed_at":null,
                  "meta":null,
                  "redeem_code_pos":"1313",
                  "redeem_code_online":"1313114",
                  "created_at":"2021-02-10 23:06:27",
                  "updated_at":"2021-02-10 23:06:27"
               },
               "created_at":"2021-02-10 23:21:46",
               "updated_at":"2021-02-10 23:21:46"
            }
         ],
         "created_at":"2021-02-10 23:21:46",
         "updated_at":"2021-02-10 23:21:46"
      }
   ]
}
```

## Redemption properties

| Attributes                          | Descriptions                                                                             |
| ----------------------------------- | ---------------------------------------------------------------------------------------- |
| id `INTEGER`                        | The unique Omneo ID of the redemption                                                    |
| profile\_id `STRING`                | The omneo `profile_id` the redemption is attached to                                     |
| type `STRING`                       | The type of redemption                                                                   |
| total `FLOAT`                       | the total value redeemed by the redemption                                               |
| total\_localised `FLOAT`            | The total value redeemed in the specified `currency`                                     |
| meta `ARRAY`                        | An array of metadata attached to the redemption                                          |
| transaction\_id `INTEGER`           | The attached transaction id of the redemption                                            |
| items `ARRAY`                       | An array of reward, point or benefit instances that were redeemed during this redemption |
| created\_at `DATE-TIME` `READ-ONLY` | The UTC date & time the redemption record was created in ISO 8601 format.                |
| updated\_at `DATE-TIME` `READ-ONLY` | The UTC date & time the redemption record was last updated in ISO 8601 format.           |
