---
title: "Get all redemption details"
method: GET
path: "/redemptions"
tags: ["Redemptions"]
---

# Get all redemption details

`GET /redemptions`

## Request

- Base URL: `https://api.fabric.inc/v3`
- URL: `https://api.fabric.inc/v3/redemptions`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/fabric/apis/offers-redemptions/docs/redemptions/get.ts> (a function with typed inputs; its response is checked against the schema)

Use this endpoint to retrieve a list of redemption records. You can filter the records using parameters, such as `couponCode`, `userId`, `email`, `orderId`, or `storeId`.

## Query parameters

- `size` integer
- `startCursor` string
- `promotionId` string
- `couponCode` string
- `userId` string
- `email` string
- `orderId` string
- `storeId` string
- `status` 'ACTIVE' | 'INACTIVE'
- `redeemedFrom` string
- `redeemedTo` string
- `updatedFrom` string
- `updatedTo` string
- `additionalAttributes` string
- `promotionAdditionalAttributes` string
- `promotionName` string
- `isImplicit` boolean
- `singleMultiUse` 'SINGLE_USE' | 'MULTI_USE'

## Headers

- `x-fabric-tenant-id` string, required
- `x-fabric-channel-id` string
- `x-client-id` string
- `x-fabric-request-id` string

## Response `200`

OK

- GetRedemptionsResponse: Redemption information
  - `query` CursorQuery: The pagination details.
    - `size` integer: The maximum number of records per page.
    - `nextCursor` string, nullable: Reference point to start the search for records in the next data set
  - `data` Redemption[]: Redemptions list
    - `id` string, required: System-generated redemption ID
    - `promotionId` string, required: ID of the promotion to which the coupon code belongs
    - `couponCode` string: Redeemed coupon code
    - `orderId` string, required: Purchase order ID associated with the redemption
    - `userId` string, nullable: ID of the user who redeems the coupon
    - `email` string, nullable: Email address of the user who redeems the coupon
    - `storeId` string: ID of the store where the coupon is redeemed
    - `redeemedAt` string, date-time: The timestamp in UTC format for when the coupon was redeemed.
    - `status` 'INACTIVE' | 'ACTIVE': The following are redemption statuses: - `ACTIVE`: Represents created redemption records. - `INACTIVE`: Represents redemption records that were created but became inactive due to order cancellation.
    - `additionalAttributes` object[]: Merchant-specified attributes associated with the redemption
      - `name` string, required: Merchant-specified attribute `name` associated with the redemption
      - `values` union, required
        - string: Merchant-specified attribute `value` associated with the redemption
        - string[]: Merchant-specified attribute `values` associated with the redemption.
    - `promotionAdditionalAttributes` object[]: Merchant-specified attributes associated with the related promotion. This value is automatically populated according to the attributes of the related promotion.
      - `name` string, required: Merchant-specified attribute `name` associated with the related promotion.
      - `values` union, required
        - string: Merchant-specified attribute `value` associated with the related promotion.
        - string[]: Merchant-specified attribute `values` associated with the related promotion.
    - `promotionName` string: Promotion name by which you want to filter the redemption records
    - `createdAt` string, date-time, required: The timestamp in UTC format of when the coupon redemption was created.
    - `updatedAt` string, date-time, required: The timestamp in UTC format of when the coupon redemption was last updated.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `500`: Internal server error

---

[API](https://skmtc.dev/fabric/apis/offers-redemptions.md) - [All operations](https://skmtc.dev/fabric/apis/offers-redemptions/llms.txt) - [OpenAPI document](https://skmtc.dev/fabric/apis/offers-redemptions/revisions/1ecebae0c30d?raw)