For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
    • Introduction
    • URL Structure
    • API Key
    • Errors
    • Versioning
    • Pagination
    • Replication
    • Rate Limits
    • Webhooks
  • System Services
    • Companies
    • Hello World
  • Accounts
  • Ticketing
    • Getting started
    • Catalog
    • Availability
    • Tickets
    • Reservations
  • Memberships
    • Catalog
    • Membership
    • Member
    • Card
    • Payment Method
    • Lifecycle
    • Miscellaneous
    • Points
  • Speedgate
  • Attraction Wallet
  • OTA Channel Manager
    • Getting started
    • Orders
  • POS
    • POS Sale
    • POS Entry
    • POS Unit
    • POS Store
    • Salesperson
    • External POS Sale
    • Global POS Entry
  • Restaurant
  • Inventory
    • Barcodes
    • Items
    • Item Ledger Entries
    • Item Categories
    • Item Variants
    • Item Translations
  • Coupon
      • GETFind Coupons
      • GETGet Coupon
      • POSTCreate Coupon
      • DELVoid Coupon
      • POSTApply Coupon Discount
      • POSTCheck Coupon
      • POSTReserve Coupon
      • POSTCancel Coupon Reservation
      • POSTRedeem Coupon
  • Vouchers
    • Vouchers
  • Sales Documents
    • Ecommerce
  • Finance
    • General Ledger Account
    • General Ledger Entries
    • General Ledger Journal
  • Customers
    • Customers
    • GDPR
  • Retail Print
    • Print Price Labels
  • PDF Designer
LogoLogo
CouponCoupon

Redeem Coupon

Beta
POST
https://api.npretail.app/:tenant/:environment/:company/coupon/redeem
POST
/:tenant/:environment/:company/coupon/redeem
$curl -X POST https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./coupon/redeem \
>     -H "x-np-api-key: <NaviPartner API Key>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "referenceNo": "C100009-TC",
>  "documentNo": "EXT-WEB-01"
>}'
200Redeem coupon by reference number.
1{
2  "redemption": {
3    "couponId": "77a1b3c2-d5e6-f7a8-b9c0-d1e2f3a4b5c6",
4    "referenceNo": "C100009-TC",
5    "documentNo": "EXT-WEB-01",
6    "couponType": "20%OFF"
7  }
8}
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.
Was this page helpful?
Previous

Introduction to Vouchers

Next
Built with

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.
referenceNostringRequired
The reference number identifying the coupon to redeem.
documentNostringRequired
The external document number that links the redemption to a specific transaction.

Response

This endpoint returns an object.
redemptionobject