NAnavipartner
coupon > Coupon

Redeem Coupon

Changed on

Redeems a coupon by reference number against a specific transaction. Consumes one unit of the coupon's remaining quantity and removes the caller's reservation if one exists.

post/{tenant}/{environment}/{company}/coupon/redeem

Request

  • Base URL
    https://api.npretail.app
  • Auth
    API key in header x-np-api-key

Path parameters

tenantstring required

Your Entra Tenant ID. More details.

environmentstring required

Your Business Central Environment. More details.

companystring required

Your Business Central Company. More details.

Headers

x-api-versionstring date

Used for API versioning. More details.

Request body

referenceNostring required

The reference number identifying the coupon to redeem.

documentNostring required

The external document number that links the redemption to a specific transaction.

Response

Response with status 200

Changes

  • 48cacf22ffcdRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter x-np-api-key

    • info

      the endpoint scheme security NPApiKeyAuthScheme was added to the API

    • info

      added the required property to the response with the status

  • 407697660280Revision changes
    • info

      api operation id redeem-coupon removed and replaced with coupon_serviceCoupon_redeemCoupon