> This page is for Entria 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.

# Exchange an existing ticket for a coupon

POST https://api.entria.app/api/ticket/exchange-for-coupon

Cancels the given ticket and issues a coupon the shopper can redeem toward another purchase. Supply the ticket identifier and, optionally, a coupon type; the response returns the new coupon identifier and its redeemable code.

Reference: https://docs.navipartner.com/entria-api/entria-api-reference/ticketing/post-ticketing-exchange-for-coupon

## Authentication

- `Authorization` header (bearer token, required) — OAuth client token, for a partner backend only. A short-lived access token for endpoints that return personal data about any member. Obtain one from POST /oauth/token (RFC 7523 JWT-bearer), signing the assertion with the private key of the key pair registered for your store. Sent as `Authorization: Bearer <token>`. This is separate from the `x-entria` store header, which is still required.

## Request

### Query parameters

- `ticketId` (string, required) — The identifier of the existing ticket to exchange.
- `couponType` (string, optional) — Optional coupon type to issue; omit to use the default coupon type.

### Headers

- `x-entria` (string, required) — Identifies which store this request is for. Required on every store-scoped route. It is not authentication and not a secret — it grants no privileges and is safe to send from a browser. You receive the value once your Entria backend has been created and configured. Missing header returns 400; an unknown store returns 404.

## Response

### 200

The ticket was exchanged and a coupon was issued

- `couponId` (string, required) — The identifier of the coupon created for the shopper.
- `couponNumber` (string, required) — The coupon code the shopper can redeem toward another purchase.

## Errors

### 400 Bad Request Error

Invalid request

- `error` (string, required)
- `code` (string, optional)
- `details` (list of ErrorResponseDetailsItems, optional) — Per-field validation failures; present when code is VALIDATION_ERROR.
- `success` (boolean, optional, deprecated) — Deprecated. Use code === VALIDATION_ERROR.
- `errors` (list of any, optional, deprecated) — Deprecated. Raw zod issues; use details instead.

### 401 Unauthorized Error

Missing or invalid access token

- `error` (string, required)
- `code` (string, optional)
- `details` (list of ErrorResponseDetailsItems, optional) — Per-field validation failures; present when code is VALIDATION_ERROR.
- `success` (boolean, optional, deprecated) — Deprecated. Use code === VALIDATION_ERROR.
- `errors` (list of any, optional, deprecated) — Deprecated. Raw zod issues; use details instead.

### 403 Forbidden Error

Access token not valid for this store, or API auth not enabled

- `error` (string, required)
- `code` (string, optional)
- `details` (list of ErrorResponseDetailsItems, optional) — Per-field validation failures; present when code is VALIDATION_ERROR.
- `success` (boolean, optional, deprecated) — Deprecated. Use code === VALIDATION_ERROR.
- `errors` (list of any, optional, deprecated) — Deprecated. Raw zod issues; use details instead.

### 503 Service Unavailable Error

API auth is not configured for this store

- `error` (string, required)
- `code` (string, optional)
- `details` (list of ErrorResponseDetailsItems, optional) — Per-field validation failures; present when code is VALIDATION_ERROR.
- `success` (boolean, optional, deprecated) — Deprecated. Use code === VALIDATION_ERROR.
- `errors` (list of any, optional, deprecated) — Deprecated. Raw zod issues; use details instead.

## Types

### ErrorResponseDetailsItems

- `path` (string, required)
- `message` (string, required)

## Examples

**Response**

```json
{
  "couponId": "string",
  "couponNumber": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.entria.app/api/ticket/exchange-for-coupon"

querystring = {"ticketId":"ticketId"}

headers = {
    "x-entria": "x-entria",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.entria.app/api/ticket/exchange-for-coupon?ticketId=ticketId';
const options = {
  method: 'POST',
  headers: {'x-entria': 'x-entria', Authorization: 'Bearer <token>'}
};

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

```go
package main

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

func main() {

	url := "https://api.entria.app/api/ticket/exchange-for-coupon?ticketId=ticketId"

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

	req.Header.Add("x-entria", "x-entria")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

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

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.entria.app/api/ticket/exchange-for-coupon?ticketId=ticketId")

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

request = Net::HTTP::Post.new(url)
request["x-entria"] = 'x-entria'
request["Authorization"] = 'Bearer <token>'

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.entria.app/api/ticket/exchange-for-coupon?ticketId=ticketId")
  .header("x-entria", "x-entria")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.entria.app/api/ticket/exchange-for-coupon?ticketId=ticketId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'x-entria' => 'x-entria',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.entria.app/api/ticket/exchange-for-coupon?ticketId=ticketId");
var request = new RestRequest(Method.POST);
request.AddHeader("x-entria", "x-entria");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-entria": "x-entria",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.entria.app/api/ticket/exchange-for-coupon?ticketId=ticketId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

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()
```