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

curl --request GET \
  --url https://api.bonifiq.com.br/v1/pvt/Coupons/{couponCode}/rules \
  --header 'Authorization: Basic <encoded-value>'

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "IsCumulative": true,
    "Value": 123,
    "Type": 0,
    "Requirements": "<string>",
    "BeginDate": "<string>",
    "EndDate": "<string>",
    "Title": "<string>",
    "IsActive": true,
    "MinValue": 123
  },
  "HasError": true
}

Coupons

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

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.

GET

pvt

Coupons

{couponCode}

rules

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

curl --request GET \
  --url https://api.bonifiq.com.br/v1/pvt/Coupons/{couponCode}/rules \
  --header 'Authorization: Basic <encoded-value>'

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "IsCumulative": true,
    "Value": 123,
    "Type": 0,
    "Requirements": "<string>",
    "BeginDate": "<string>",
    "EndDate": "<string>",
    "Title": "<string>",
    "IsActive": true,
    "MinValue": 123
  },
  "HasError": true
}

Authorizations

Authorization

string

header

required

Use API Basic Auth Keys

Path Parameters

couponCode

string

required

The coupon code to retrieve promotion rules for.

Response

200 - application/json

Promotion details associated with the coupon.

ErrorMessage

string | null

Error message or description

ErrorCode

integer<int32> | null

Optional error code, if available

Result

object

Show child attributes

Result.IsCumulative

boolean

Result.Value

number<decimal>

Result.Type

enum<integer>

0 = PercentDiscountCoupon 1 = ValueDiscountCoupon 2 = FreightDiscountCoupon 3 = PointToCashback 4 = Customized

Available options:

0,

1,

2,

3,

4

Result.Requirements

string

Result.BeginDate

string

Result.EndDate

string

Result.Title

string

Result.IsActive

boolean

Result.MinValue

number<decimal>

HasError

boolean

If true the request had an error.

Inactives the given coupon on the bonifiq system.Returns the customizations as configured in the BonifiQ admin panel

⌘I

API Privada

API Pública

Endpoint Examples

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

How to use

Authorizations

Path Parameters

Response