ETERA API Documentation

Authentication

AuthorizationBearer

JWT token from @etera-ai/auth package (auth.etera.dev) - Format: Bearer <token>

Path parameters

bookingIdstringRequired

Unique identifier for the booking

Query parameters

reason"TICKETS_NOT_RECEIVED" or "CHANGE_OF_TRAVEL_PLANS" or "MODIFY_EXISTING_RESERVATION" or "FOUND_CHEAPER_OPTION_ELSEWHERE" or "OTHER" or stringOptional

Cancellation reason (can also be provided in request body). Can be an enum value or free text.

other_reasonstringOptional

Additional details when reason is ‘OTHER’ (can also be provided in request body).

Request

This endpoint expects an object.

reason"TICKETS_NOT_RECEIVED" or "CHANGE_OF_TRAVEL_PLANS" or "MODIFY_EXISTING_RESERVATION" or "FOUND_CHEAPER_OPTION_ELSEWHERE" or "OTHER" or stringOptional

Cancellation reason (can also be provided as query parameter). Can be an enum value (TICKETS_NOT_RECEIVED, CHANGE_OF_TRAVEL_PLANS, MODIFY_EXISTING_RESERVATION, FOUND_CHEAPER_OPTION_ELSEWHERE, OTHER) or free text. If OTHER is used, provide other_reason for details.

other_reasonstringOptional

Additional details when reason is ‘OTHER’ (can also be provided as query parameter). Recommended when using ‘OTHER’ enum value.

Response

This endpoint returns an object.

successboolean

dataany

messagestring

errorstring

timestampstring

1	const url = 'https://api.etera.dev/experience/booking/booking_abc123/cancel';
2	const options = {
3	method: 'POST',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"success": true,
3	"message": "string",
4	"error": "string",
5	"timestamp": "string"
6	}