---
title: "Search coupons"
method: GET
path: "/stores/{storeId}/coupons/search/{query}"
tags: ["Coupon"]
---

# Search coupons

`GET /stores/{storeId}/coupons/search/{query}`

## Request

- Base URL: `https://api.komerza.com`
- URL: `https://api.komerza.com/stores/{storeId}/coupons/search/{query}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/komerza/apis/komerza-api/docs/stores/:storeId/coupons/search/:query/get.ts> (a function with typed inputs; its response is checked against the schema)

Searches the coupons in the store by the given query.
Requires the `stores.coupons.view` permission.

## Path parameters

- `storeId` string, uuid, required
- `query` string, required

## Query parameters

- `UsesFrom` integer
- `UsesTo` integer
- `MaximumUsesFrom` integer
- `MaximumUsesTo` integer
- `PercentageFrom` number, double
- `PercentageTo` number, double
- `AmountFrom` number, double
- `AmountTo` number, double
- `IsEnabled` boolean
- `Filters` string
- `Sorts` string
- `Page` integer
- `PageSize` integer

## Response `200`

The object was successfully returned.

- CouponPaginatedResponse: Represents a paginated response returned from API endpoints, which contains the paginated data and metadata about the pagination.
  - `success` boolean, required: Indicates whether the operation was successful
  - `pages` integer, required: The total number of pages available in the paginated response.
  - `data` Coupon[], required: Represents the collection of items within a paginated response
    - `id` string, uuid, required: The unique identifier of the entity
    - `dateCreated` string, date-time, required: The date the entity was created in the database
    - `code` string, required: The case-insensitive code the customer will enter to redeem the coupon (this should be lowercased)
    - `uses` integer, required: The amount of times the coupon code has been used
    - `maximumUses` integer, required: The maximum amount of usages the coupon code has, -1 = infinite
    - `percentageDecrease` number, double, nullable: The percentage that should be subtracted from the total order cost when used
    - `amountDecrease` number, double, nullable: The static amount to be subtracted from the total order cost when used
    - `isEnabled` boolean, required: Whether the coupon code is enabled and can be used in checkout
    - `variantIds` string[], nullable: The list of variant IDs that the coupon is enabled for, null if it is global
    - `expirationDate` string, date-time, nullable: The date and time when the coupon will expire and can no longer be used
    - `storeId` string, uuid, required: The ID of the store the coupon belongs to

## Other responses

- `401`: You are not authorized, check your API key and try again.
- `403`: You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.
- `404`: One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

---

[API](https://skmtc.dev/komerza/apis/komerza-api.md) - [All operations](https://skmtc.dev/komerza/apis/komerza-api/llms.txt) - [OpenAPI document](https://skmtc.dev/komerza/apis/komerza-api/revisions/060e78bc7f80?raw)