Returns if found a coupon based on the given coupon code.

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

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "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
  },
  "HasError": true
}

GET

pvt

Coupons

{code}

Returns if found a coupon based on the given coupon code.

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

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "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
  },
  "HasError": true
}

Authorizations

Authorization

string

header

required

Use API Basic Auth Keys

Path Parameters

code

string

required

Response

200 - application/json

ErrorMessage

string | null

Error message or description

ErrorCode

integer<int32> | null

Optional error code, if available

Result

object

Create Coupon Response Model

Show child attributes

Result.CouponCode

string

Coupon Code

Result.CreatedDate

string<date-time>

Create Date

Result.IsUsed

boolean | null

if true the coupon was already bein use or inactivated.

Result.CouponValue

number<decimal>

Discount value for the coupon

Result.CustomerId

integer<int32>

the customer that the coupon is being given.

Result.ValidDateStart

string<date-time> | null

Date the coupon is start to being enable for rewards

Result.ValidDateEnd

string<date-time> | null

Date the coupon will not be able for rewards anymore.

Result.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

HasError

boolean

If true the request had an error.

Turn a customer into Affiliate, Change cupom and if necessary, create a customer Creates a coupon for the given customer.

⌘I

API Privada

API Pública

Endpoint Examples

Returns if found a coupon based on the given coupon code.

Authorizations

Path Parameters

Response