---
title: "Check if coupon is Redeemable"
method: GET
path: "/coupon/is_redeemable"
---

# Check if coupon is Redeemable

`GET /coupon/is_redeemable`

Lets you check whether a set of coupons can be redeemed or not.

## Query parameters

- `mobile` string
- `details` 'true' | 'extended'
- `email` string
- `externalId` string
- `cardnumber` string
- `cardExternalId` string
- `id` integer
- `code` string[], required

## Response `200`

200

- union
  - object
    - `redemption` object[]
      - `currencyInput` boolean
      - `localToBaseCurrencyExchangeRate` integer
      - `isRedeemable` boolean
      - `warnings` unknown[]
        - unknown
      - `appendedErrorMessage` string
      - `code` string
      - `couponseries` object
        - `description` string
        - `discountCode` string
        - `validTillDate` string
        - `isValidWithDiscountedItem` boolean
        - `isUpdateProductData` boolean
        - `info` string
        - `discountUpto` integer
        - `discountValue` integer
        - `maxRedemptionsInSeriesPerUser` integer
        - `issueToLoyalty` boolean
        - `brands` unknown[]
          - unknown
        - `products` unknown[]
          - unknown
        - `categories` unknown[]
          - unknown
        - `discountOn` string
        - `discountType` string
        - `updateProductData` boolean
        - `validTilldateFormat` string
        - `entityLevelRedemptionConfigsValues` unknown[]
          - unknown
      - `isAbsolute` boolean
      - `redemptionsLeft` integer
      - `numberOfRedemptionsByUser` integer
      - `discountType` string
      - `discountValue` integer
      - `discountUpto` integer
    - `redemptionStatus` object
      - `status` boolean
      - `code` integer
      - `message` string
    - `customer` object
      - `id` integer
      - `profiles` object[]
        - `firstName` string
        - `lastName` string
        - `fields` object
        - `allFields` object
        - `identifiers` object[]
          - `type` string
          - `value` string
        - `commChannels` unknown[]
          - unknown
        - `userId` integer
        - `accountId` string
        - `autoUpdateTime` string
        - `identifiersAll` object[]
          - `type` string
          - `value` string
    - `warnings` unknown[]
      - unknown
  - object
    - `redemption` object[]
      - `currencyInput` boolean
      - `localToBaseCurrencyExchangeRate` integer
      - `isRedeemable` boolean
      - `warnings` unknown[]
        - unknown
      - `appendedErrorMessage` string
      - `code` string
      - `couponseries` object
        - `description` string
        - `discountCode` string
        - `validTillDate` string
        - `isValidWithDiscountedItem` boolean
        - `isUpdateProductData` boolean
        - `info` string
        - `discountUpto` integer
        - `discountValue` integer
        - `maxRedemptionsInSeriesPerUser` integer
        - `issueToLoyalty` boolean
        - `brands` unknown[]
          - unknown
        - `products` unknown[]
          - unknown
        - `categories` unknown[]
          - unknown
        - `discountOn` string
        - `discountType` string
        - `updateProductData` boolean
        - `validTilldateFormat` string
        - `entityLevelRedemptionConfigsValues` unknown[]
          - unknown
      - `isAbsolute` boolean
      - `redemptionsLeft` integer
      - `numberOfRedemptionsByUser` integer
      - `discountType` string
      - `discountValue` integer
      - `discountUpto` integer
    - `redemptionStatus` object
      - `status` boolean
      - `code` integer
      - `message` string
    - `customer` object
      - `id` integer
      - `profiles` object[]
        - `firstName` string
        - `lastName` string
        - `fields` object
        - `allFields` object
        - `identifiers` object[]
          - `type` string
          - `value` string
        - `commChannels` unknown[]
          - unknown
        - `userId` integer
        - `accountId` string
        - `autoUpdateTime` string
        - `identifiersAll` object[]
          - `type` string
          - `value` string
    - `warnings` unknown[]
      - unknown
  - object
    - `redemption` object[]
      - `currencyInput` boolean
      - `localToBaseCurrencyExchangeRate` integer
      - `isRedeemable` boolean
      - `warnings` unknown[]
        - unknown
      - `appendedErrorMessage` string
      - `code` string
      - `couponseries` object
        - `description` string
        - `discountCode` string
        - `validTillDate` string
        - `isValidWithDiscountedItem` boolean
        - `isUpdateProductData` boolean
        - `info` string
        - `discountUpto` integer
        - `discountValue` integer
        - `maxRedemptionsInSeriesPerUser` integer
        - `issueToLoyalty` boolean
        - `brands` unknown[]
          - unknown
        - `products` unknown[]
          - unknown
        - `categories` unknown[]
          - unknown
        - `discountOn` string
        - `discountType` string
        - `updateProductData` boolean
        - `validTilldateFormat` string
        - `entityLevelRedemptionConfigsValues` unknown[]
          - unknown
      - `isAbsolute` boolean
      - `redemptionsLeft` integer
      - `numberOfRedemptionsByUser` integer
      - `discountType` string
      - `discountValue` integer
      - `discountUpto` integer
    - `redemptionStatus` object
      - `status` boolean
      - `code` integer
      - `message` string
    - `customer` object
      - `id` integer
      - `profiles` object[]
        - `firstName` string
        - `lastName` string
        - `fields` object
        - `allFields` object
        - `identifiers` object[]
          - `type` string
          - `value` string
        - `commChannels` unknown[]
          - unknown
        - `userId` integer
        - `accountId` string
        - `autoUpdateTime` string
        - `identifiersAll` object[]
          - `type` string
          - `value` string
    - `warnings` unknown[]
      - unknown

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/versions/de241f2ed9b3/schema)