Download OpenAPI specification:
Civitatis Standard Documentation for Connected APIs.
Retrives all integration products.
| Authorization required | string Bearer token for authentication |
| Capabilities required | string Example: pricing,pickups List of capabilities (pricing or pickups) |
| Env required | string Example: test Environment information (test or live) |
{- "id": "1",
- "internalName": "Product One"
}Retrives an integration product by identificator.
| id required | string Product identificator |
| Authorization required | string Bearer token for authentication |
| Capabilities required | string Example: pricing,pickups List of capabilities (pricing or pickups) |
| Env required | string Example: test Environment information (test or live) |
{- "id": "1",
- "internalName": "Product One",
- "options": [
- {
- "id": "1",
- "internalName": "Product One",
- "pickupAvailable": true,
- "pickupRequired": true,
- "units": [
- {
- "id": "1",
- "internalName": "Unit 1",
- "restrictions": [
- {
- "minQuantity": 1,
- "maxQuantity": 10,
- "paxCount": 5
}
], - "requiredContactFields": [
- [
- "name"
]
]
}
], - "requiredContactFields": [
- [
- "name",
- "surname"
]
]
}
], - "availableCurrencies": [
- [
- "EUR",
- "USD"
]
], - "defaultCurrency": "EUR",
- "deliveryFormats": [
- "PDF_URL"
]
}Sends a request to check availability for a specific product, option, and date range.
| currency | string The currency ID to use for the request. |
| Authorization required | string Bearer token for authentication |
| Capabilities required | string Example: pricing,pickups List of capabilities (pricing or pickups) |
| Env required | string Example: test Environment information (test or live) |
| productId | string The ID of the product. |
| optionId | string The ID of the option. |
| localDateStart | string <date> The start date in ISO-8601 format (yyyy-MM-dd). |
| localDateEnd | string <date> The end date in ISO-8601 format (yyyy-MM-dd). |
Array of objects (AvailabilityUnitRequest) A list of calendar unit requests. |
{- "productId": "string",
- "optionId": "string",
- "localDateStart": "2019-08-24",
- "localDateEnd": "2019-08-24",
- "units": [
- {
- "id": "string",
- "quantity": 0
}
]
}[- {
- "id": "string",
- "localDateTimeStart": "2019-08-24T14:15:22Z",
- "localDateTimeEnd": "2019-08-24T14:15:22Z",
- "allDay": true,
- "status": "FREESALE",
- "available": true,
- "vacancies": 0,
- "capacity": 0,
- "maxUnits": 0,
- "openingHours": [
- {
- "from": "string",
- "to": "string"
}
], - "unitPricing": [
- {
- "id": "string",
- "original": 0.1,
- "retail": 0.1,
- "net": 0.1,
- "currency": "string",
- "currencyPrecision": 0
}
], - "pricing": {
- "id": "string",
- "original": 0.1,
- "retail": 0.1,
- "net": 0.1,
- "currency": "string",
- "currencyPrecision": 0
}, - "pickupAvailable": true,
- "pickupRequired": true,
- "pickupPoints": [
- {
- "id": "string",
- "name": "string"
}
]
}
]Creates a new reservation using the provided details.
| Authorization required | string Bearer token for authentication |
| Capabilities required | string Example: pricing,pickups List of capabilities (pricing or pickups) |
| Env required | string Example: test Environment information (test or live) |
| productId | string Identifier of the product being reserved. |
| optionId | string Identifier of the option being reserved. |
| availabilityId | string Identifier of the availability being reserved. |
Array of objects (CreateReservationUnitItemRequest) List of unit items included in the reservation. | |
| pickupRequested | boolean Indicates if a pickup is requested. |
| pickupPointId | string Identifier of the pickup point. |
| notes | string Additional notes for the reservation. |
{- "productId": "string",
- "optionId": "string",
- "availabilityId": "string",
- "unitItems": [
- {
- "unitId": "string",
- "contact": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "emailAddress": "string",
- "phoneNumber": "string",
- "locales": [
- "string"
], - "country": "string"
}
}
], - "pickupRequested": true,
- "pickupPointId": "string",
- "notes": "string"
}{- "uuid": "string",
- "utcCreatedAt": "2019-08-24T14:15:22Z",
- "utcExpiresAt": "2019-08-24T14:15:22Z",
- "status": "string",
- "cancellable": true
}Confirms a booking using the provided reservation details.
| uuid required | string Unique identifier for the booking. |
| Authorization required | string Bearer token for authentication |
| Capabilities required | string Example: pricing,pickups List of capabilities (pricing or pickups) |
| Env required | string Example: test Environment information (test or live) |
| resellerReference | string Reference provided by the reseller. |
object (ConfirmBookingContactRequest) Represents the contact information for confirming a booking. | |
| notes | string Notes for the booking. |
| pickupRequested | boolean Indicates if a pickup is requested. |
| pickupPointId | string Identifier of the pickup point. |
{- "resellerReference": "string",
- "contact": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "emailAddress": "string",
- "phoneNumber": "string",
- "locales": [
- "string"
], - "country": "string"
}, - "notes": "string",
- "pickupRequested": true,
- "pickupPointId": "string"
}{- "supplierReference": "string",
- "status": "ON_HOLD",
- "deliveryMethods": [
- "TICKET"
], - "voucher": {
- "deliveryOptions": [
- {
- "deliveryFormat": "PDF_URL",
- "deliveryValue": "string"
}
], - "redemptionMethod": "MANIFEST"
}, - "unitItems": [
- {
- "unitId": "string",
- "ticket": {
- "deliveryOptions": [
- {
- "deliveryFormat": "PDF_URL",
- "deliveryValue": "string"
}
], - "redemptionMethod": "MANIFEST"
}, - "contact": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "emailAddress": "string",
- "phoneNumber": "string",
- "locales": [
- "string"
], - "country": "string"
}, - "supplierReference": "string"
}
]
}Fetches the details of a booking using the provided UUID.
| uuid required | string The unique identifier of the booking. |
| Authorization required | string Bearer token for authentication |
| Capabilities required | string Example: pricing,pickups List of capabilities (pricing or pickups) |
| Env required | string Example: test Environment information (test or live) |
{- "supplierReference": "string",
- "status": "ON_HOLD",
- "deliveryMethods": [
- "TICKET"
], - "voucher": {
- "deliveryOptions": [
- {
- "deliveryFormat": "PDF_URL",
- "deliveryValue": "string"
}
], - "redemptionMethod": "MANIFEST"
}, - "unitItems": [
- {
- "unitId": "string",
- "ticket": {
- "deliveryOptions": [
- {
- "deliveryFormat": "PDF_URL",
- "deliveryValue": "string"
}
], - "redemptionMethod": "MANIFEST"
}, - "contact": {
- "fullName": "string",
- "firstName": "string",
- "lastName": "string",
- "emailAddress": "string",
- "phoneNumber": "string",
- "locales": [
- "string"
], - "country": "string"
}, - "supplierReference": "string"
}
]
}Cancels a booking using the provided UUID.
| uuid required | string The unique identifier of the booking to be canceled. |
| Authorization required | string Bearer token for authentication |
| Capabilities required | string Example: pricing,pickups List of capabilities (pricing or pickups) |
| Env required | string Example: test Environment information (test or live) |