---
title: "Creates a coupon for the given customer."
method: POST
path: "/v1/pvt/Coupons"
tags: ["Coupons"]
---

# Creates a coupon for the given customer.

`POST /v1/pvt/Coupons`

## Request

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

## Request body

- CreateCouponRequest: Create Coupon Request model
  - `OriginalId` string: Id from the client store.
  - `CouponCode` string: Coupon Code.
  - `CreatedDate` string, date-time: Date of creation of this coupon.
  - `CouponType` 0 | 1 | 2 | 3 | 4: 0 = FixedValue 1 = Percent 2 = FreeShipping 3 = DiscountShipping 4 = Others
  - `IsUsed` boolean: If true, the coupon was already being used in a purchase.
  - `CouponValue` number: Coupon Discount Value
  - `ValidDateStart` string, date-time: Coupon validity start date
  - `ValidDateEnd` string, date-time: Coupon expiration date
  - `CustomerId` string: Id for the customer that this coupon is being given.
  - `Customer` ExternalCreateCustomerRequest: Creater Customer body Request
    - `OriginalId` string: This is the Id in the client store.
    - `Name` string: Customer name.
    - `Email` string, nullable: Customer email.
    - `Phone` string, nullable: Customer Contact Phone.
    - `BirthdayDate` string, date-time, nullable: Customer Birthdate.
    - `SignupDate` string, date-time, nullable: Date when the customer made the register on client store.
    - `Document` string, nullable: Some document number from the customer, accepts any string.
    - `IsEnrolled` boolean: If true the customer is participating on the points plan from the store.
    - `EnrolledDate` string, date-time, nullable: Date when the customer made entered into the program. Use the OrderPlacementDate if not informed.

## Response `200`

- BaseExternalApiListResponseOfCreateCouponResponse: Base List response model methods
  - `Items` object[], nullable: Collection with the found entities on the bonifiq DB.
    - `CouponCode` string: Coupon Code
    - `CreatedDate` string, date-time: Create Date
    - `IsUsed` boolean, nullable: if true the coupon was already bein use or inactivated.
    - `CouponValue` number: Discount value for the coupon
    - `CustomerId` integer: the customer that the coupon is being given.
    - `ValidDateStart` string, date-time, nullable: Date the coupon is start to being enable for rewards
    - `ValidDateEnd` string, date-time, nullable: Date the coupon will not be able for rewards anymore.
    - `CouponType` 0 | 1 | 2 | 3 | 4: 0 = FixedValue 1 = Percent 2 = FreeShipping 3 = DiscountShipping 4 = Others
  - `TotalItemCount` integer: Total of rewards Configurations founds.
  - `PageSize` integer: Pagination size
  - `PageNumber` integer: 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

---

[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)