CouponCoupon

Create Coupon

Beta
Creates a new coupon.

Authentication

x-np-api-keystring
API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Request

This endpoint expects an object.
couponTypestringRequired
The type of coupon, which links to a template defining its behavior.
customerNostringOptional
Optionally assign the coupon to a specific customer.

Response

This endpoint returns an object.
idUUID
The unique system identifier for the coupon.
nostring
The internal coupon number from the number series.
couponTypestring
The type of coupon, which carries the setup in NP Retail.
descriptionstring
A short description of the coupon.
referenceNostring

A unique, human-readable reference number, often used for barcodes.

statusenum
The current status of the coupon.
discountTypeenum
The type of discount the coupon provides.
maxUsesPerSaleinteger
The maximum number of times this coupon can be used in a single sale.
issueDatedate
The date the coupon was first issued.
discountAmountdoubleOptional
The fixed discount amount, if applicable.
discountPercentdoubleOptional
The discount as a percentage, if applicable.
maxDiscountAmountdoubleOptional
The maximum discount amount that can be applied.
validFromdatetimeOptional
The date and time from which the coupon is valid.
validUntildatetimeOptional
The date and time when the coupon expires.
customerNostringOptional
The customer number this coupon is assigned to, if any.
remainingQuantitydoubleOptional
The remaining times the coupon can be used, if applicable.