CouponCoupon

Check Coupon

Beta
Checks coupon availability.

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.

couponIdUUIDRequired
The unique system identifier for the coupon.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Response

This endpoint returns an object.
couponIdstring
The unique identifier of the coupon..
documentNostring
The external document number that originally issued the coupon. Empty for coupons issued via the API.
referenceNostring

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

couponTypestring
The type of coupon, which carries the setup in NP Retail.
descriptionstring
A short description of the coupon and its intended use..
openboolean
Indicates whether the coupon is currently active and available for use.
maxUsePerSaleinteger
The maximum number of times this coupon can be applied in a single sale or transaction.
remainingQuantitydouble
The number of uses left for this coupon.
inUseQuantityinteger
The number of times the coupon is currently being used in active transactions.
stateenum
The runtime state of the coupon as evaluated against current reservations and validity windows.
reservedByDocumentNoslist of strings
The external document numbers that currently hold a reservation on this coupon. Empty when no reservations exist.
startingDatedatetime
The date and time when the coupon becomes valid. Absent when no starting date is set.
endingDatedatetime
The date and time when the coupon expires. Absent when no ending date is set.