---
title: "Retrieves the promotion rules and details associated with a specific coupon code."
method: GET
path: "/v1/pvt/Coupons/{couponCode}/rules"
tags: ["Coupons"]
---

# Retrieves the promotion rules and details associated with a specific coupon code.

`GET /v1/pvt/Coupons/{couponCode}/rules`

## Request

- Base URL: `https://api.bonifiq.com.br`
- URL: `https://api.bonifiq.com.br/v1/pvt/Coupons/{couponCode}/rules`
- Auth: HTTP basic

This endpoint returns the promotion information linked to the provided coupon code, including type, value, requirements, and validity period.
            
### How to use
Provide the desired coupon code in the URL. The response will contain the promotion details if available.
            
- The `type` field indicates the type of discount (e.g., value, percentage, shipping).
- The `requirements` field describes the conditions for using the coupon.
- The `value` field contains the discount value.
- The `beginDate` and `endDate` fields indicate the promotion's validity period.
- The `isActive` and `isCumulative` fields indicate if the promotion is active and if it can be combined with others.

## Path parameters

- `couponCode` string, required

## Response `200`

Promotion details associated with the coupon.

- BaseExternalApiResponseOfApiCouponPromotionModel: Standard response envelope used by the External API.
  - `ErrorMessage` string, nullable: Error message returned when the request fails validation or processing. For warnings and successful responses, consumers should usually inspect `Result`, `Code` and `Severity` first.
  - `ErrorCode` integer, nullable: Legacy numeric error code derived from internal API errors when available. This field is relevant only for error flows that use `ApiResponseErrorDescription`.
  - `Result` ApiCouponPromotionModel
    - `IsCumulative` boolean
    - `Value` number
    - `Type` 0 | 1 | 2 | 3 | 4 | 5: 0 = PercentDiscountCoupon 1 = ValueDiscountCoupon 2 = FreightDiscountCoupon 3 = PointToCashback 4 = Customized 5 = ProductDiscount
    - `Requirements` string
    - `BeginDate` string
    - `EndDate` string
    - `Title` string
    - `IsActive` boolean
    - `MinValue` number
  - `Code` string, nullable: Endpoint-specific business code formatted as a two-digit string, such as `03` or `07`. This field is available for success, warning and error outcomes.
  - `CodeName` string, nullable: Symbolic enum name associated with `Code`, such as `CheckoutNotFound`.
  - `Severity` 0 | 1 | 2: 0 = Success 1 = Warning 2 = Error
  - `HasWarning` boolean: Convenience flag that is `true` when `Severity` is `Warning`. Warnings are valid `200 OK` business outcomes and should not be handled as transport or validation errors.
  - `HasError` boolean: Indicates whether the request failed and should be handled as an error response. This flag is reserved for real API errors; warnings must keep this property as `false`.

## Changes

- **2026-10-21** `0c4b2427903c`: 1 warning
  - added the new `5.00` enum value to the `Result/oneOf[#/components/schemas/ApiCouponPromotionModel]/Type/oneOf[#/components/schemas/RewardType]/` response property for the response status `200`

[Operation history](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/changes/v1/pvt/Coupons/:couponCode/rules/get.md)

---

[API](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis.md) - [All operations](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/bonifiq/apis/bonifiq-private-apis/revisions/bac0977b23d5?raw)