> This page is for API Reference.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.navipartner.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.navipartner.com/_mcp/server.

# Redeem Coupon

POST https://api.npretail.app/{tenant}/{environment}/{company}/coupon/redeem
Content-Type: application/json

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.

Reference: https://docs.navipartner.com/apis/api-reference/coupon/service-coupon/redeem-coupon

## Authentication

- `x-np-api-key` header (required) — API Key authentication via header

## Request

### Path parameters

- `tenant` (string, required) — Your Entra Tenant ID. [More details.](/paths#1-tenant)
- `environment` (string, required) — Your Business Central Environment. [More details.](/paths#2-environment)
- `company` (string, required) — Your Business Central Company. [More details.](/paths#3-company)

### Body (application/json)

This endpoint expects a RedeemCouponRequest.

- `referenceNo` (string, required) — The reference number identifying the coupon to redeem.
- `documentNo` (string, required) — The external document number that links the redemption to a specific transaction.

## Response

### 200

- `redemption` (redeemCouponDTO, required)

## Types

### redeemCouponDTO

- `couponId` (string, required) — The unique identifier of the redeemed coupon.
- `referenceNo` (string, required) — The reference number of the redeemed coupon.
- `documentNo` (string, required) — The external document number the redemption was recorded against.
- `couponType` (string, required) — The type of coupon that was redeemed.

## Examples

**Request**

```json
{
  "referenceNo": "C100009-TC",
  "documentNo": "EXT-WEB-01"
}
```

**Response**

```json
{
  "redemption": {
    "couponId": "77a1b3c2-d5e6-f7a8-b9c0-d1e2f3a4b5c6",
    "referenceNo": "C100009-TC",
    "documentNo": "EXT-WEB-01",
    "couponType": "20%OFF"
  }
}
```

**SDK Code**

```python Redeem coupon by reference number.
import requests

url = "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./coupon/redeem"

payload = {
    "referenceNo": "C100009-TC",
    "documentNo": "EXT-WEB-01"
}
headers = {
    "x-np-api-key": "<NaviPartner API Key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Redeem coupon by reference number.
const url = 'https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./coupon/redeem';
const options = {
  method: 'POST',
  headers: {'x-np-api-key': '<NaviPartner API Key>', 'Content-Type': 'application/json'},
  body: '{"referenceNo":"C100009-TC","documentNo":"EXT-WEB-01"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Redeem coupon by reference number.
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./coupon/redeem"

	payload := strings.NewReader("{\n  \"referenceNo\": \"C100009-TC\",\n  \"documentNo\": \"EXT-WEB-01\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-np-api-key", "<NaviPartner API Key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Redeem coupon by reference number.
require 'uri'
require 'net/http'

url = URI("https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./coupon/redeem")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-np-api-key"] = '<NaviPartner API Key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"referenceNo\": \"C100009-TC\",\n  \"documentNo\": \"EXT-WEB-01\"\n}"

response = http.request(request)
puts response.read_body
```

```java Redeem coupon by reference number.
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./coupon/redeem")
  .header("x-np-api-key", "<NaviPartner API Key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"referenceNo\": \"C100009-TC\",\n  \"documentNo\": \"EXT-WEB-01\"\n}")
  .asString();
```

```php Redeem coupon by reference number.
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./coupon/redeem', [
  'body' => '{
  "referenceNo": "C100009-TC",
  "documentNo": "EXT-WEB-01"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-np-api-key' => '<NaviPartner API Key>',
  ],
]);

echo $response->getBody();
```

```csharp Redeem coupon by reference number.
using RestSharp;

var client = new RestClient("https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./coupon/redeem");
var request = new RestRequest(Method.POST);
request.AddHeader("x-np-api-key", "<NaviPartner API Key>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"referenceNo\": \"C100009-TC\",\n  \"documentNo\": \"EXT-WEB-01\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Redeem coupon by reference number.
import Foundation

let headers = [
  "x-np-api-key": "<NaviPartner API Key>",
  "Content-Type": "application/json"
]
let parameters = [
  "referenceNo": "C100009-TC",
  "documentNo": "EXT-WEB-01"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./coupon/redeem")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```