Civitatis API (1.0.0)

Download OpenAPI specification:

Civitatis Standard Documentation for Connected APIs.

🛒 product

Everything about Civitatis products requirements.

Retrives all integration products.

Retrives all integration products.

header Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "id": "1",
  • "internalName": "Product One"
}

Retrives an integration product.

Retrives an integration product by identificator.

path Parameters
id
required
string

Product identificator

header Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "id": "1",
  • "internalName": "Product One",
  • "options": [
    ],
  • "availableCurrencies": [
    ],
  • "defaultCurrency": "EUR",
  • "deliveryFormats": [
    ]
}

🗓️ calendar

Civitatis products requirements availability.

Checks availability in the provider's system.

Sends a request to check availability for a specific product, option, and date range.

query Parameters
currency
string

The currency ID to use for the request.

header Parameters
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)

Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "productId": "string",
  • "optionId": "string",
  • "localDateStart": "2019-08-24",
  • "localDateEnd": "2019-08-24",
  • "units": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

🎟️ booking

Operations about making orders.

Create a reservation.

Creates a new reservation using the provided details.

header Parameters
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)

Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "productId": "string",
  • "optionId": "string",
  • "availabilityId": "string",
  • "unitItems": [
    ],
  • "pickupRequested": true,
  • "pickupPointId": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "utcCreatedAt": "2019-08-24T14:15:22Z",
  • "utcExpiresAt": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "cancellable": true
}

Confirm a booking.

Confirms a booking using the provided reservation details.

path Parameters
uuid
required
string

Unique identifier for the booking.

header Parameters
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)

Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "resellerReference": "string",
  • "contact": {
    },
  • "notes": "string",
  • "pickupRequested": true,
  • "pickupPointId": "string"
}

Response samples

Content type
application/json
{
  • "supplierReference": "string",
  • "status": "ON_HOLD",
  • "deliveryMethods": [
    ],
  • "voucher": {
    },
  • "unitItems": [
    ]
}

Retrieve booking details.

Fetches the details of a booking using the provided UUID.

path Parameters
uuid
required
string

The unique identifier of the booking.

header Parameters
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)

Responses

Response samples

Content type
application/json
{
  • "supplierReference": "string",
  • "status": "ON_HOLD",
  • "deliveryMethods": [
    ],
  • "voucher": {
    },
  • "unitItems": [
    ]
}

Cancel a booking.

Cancels a booking using the provided UUID.

path Parameters
uuid
required
string

The unique identifier of the booking to be canceled.

header Parameters
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)

Responses

🩺️ health

Checks health of provider system.

Checks health of provider system.

Checks health of provider system.

Responses