Inactives the given coupon on the bonifiq system.

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

{
  "Items": [
    {
      "CouponCode": "<string>",
      "CreatedDate": "2023-11-07T05:31:56Z",
      "IsUsed": true,
      "CouponValue": 123,
      "CustomerId": 123,
      "ValidDateStart": "2023-11-07T05:31:56Z",
      "ValidDateEnd": "2023-11-07T05:31:56Z",
      "CouponType": 0
    }
  ],
  "TotalItemCount": 123,
  "PageSize": 123,
  "PageNumber": 123,
  "HasNextPage": true,
  "HasError": true,
  "ErrorMessages": [
    "<string>"
  ]
}

POST

pvt

Coupons

{code}

inactive

Inactives the given coupon on the bonifiq system.

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

{
  "Items": [
    {
      "CouponCode": "<string>",
      "CreatedDate": "2023-11-07T05:31:56Z",
      "IsUsed": true,
      "CouponValue": 123,
      "CustomerId": 123,
      "ValidDateStart": "2023-11-07T05:31:56Z",
      "ValidDateEnd": "2023-11-07T05:31:56Z",
      "CouponType": 0
    }
  ],
  "TotalItemCount": 123,
  "PageSize": 123,
  "PageNumber": 123,
  "HasNextPage": true,
  "HasError": true,
  "ErrorMessages": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Use API Basic Auth Keys

Path Parameters

code

string

required

Response

200 - application/json

Base List response model methods

Items

object[] | null

Collection with the found entities on the bonifiq DB.

Show child attributes

Items.CouponCode

string

Coupon Code

Items.CreatedDate

string<date-time>

Create Date

Items.IsUsed

boolean | null

if true the coupon was already bein use or inactivated.

Items.CouponValue

number<decimal>

Discount value for the coupon

Items.CustomerId

integer<int32>

the customer that the coupon is being given.

Items.ValidDateStart

string<date-time> | null

Date the coupon is start to being enable for rewards

Items.ValidDateEnd

string<date-time> | null

Date the coupon will not be able for rewards anymore.

Items.CouponType

enum<integer>

What type of coupons is this. 0: Cash value Coupon (such as R$10,00). 1: Percent discount (such as 10%). 4: Imported Coupoun

Available options:

0,

1,

2,

3,

4

TotalItemCount

integer<int32>

Total of rewards Configurations founds.

PageSize

integer<int32>

Pagination size

PageNumber

integer<int32>

Actual Page Number

HasNextPage

boolean

true if there is another page to be load.

HasError

boolean

If true the request had an error.

ErrorMessages

string[]

List with the error messages

Creates a coupon for the given customer.Retrieves the promotion rules and details associated with a specific coupon code.

⌘I

API Privada

API Pública

Endpoint Examples

Inactives the given coupon on the bonifiq system.

Authorizations

Path Parameters

Response