Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CDK Global Service Booking API

The Service Booking API from CDK Global — 6 operation(s) for service booking.

CDK Global Service Booking API is one of 13 APIs that CDK Global publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Service Booking. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 10 operations across 6 paths, and defines 12 schemas. It is described by OpenAPI 2.0, at version 3.0.0.

Requests are made against the base URL https://api.fortellis.io.

10 operations 6 paths 12 schemas 1 DELETE5 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.0.0
Base URL
https://api.fortellis.io
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

CDK Global Service Booking API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (permission-model) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Service Booking 10
POST
/booking-sessions
Create a bookingSession
createBookingSession 5 params → 201400403
POST
/booking-sessions/{bookingSessionId}/items
Adds a requested service item to the Booking Session
addBookingSessionItem 6 params → 201400
GET
/booking-sessions/{bookingSessionId}/items
Queries the service items of the Booking Session
queryBookingSessionItems 4 params → 200400403404410
POST
/booking-sessions/{bookingSessionId}/items/{itemId}
Updates a requested service item to the Booking Session
updateBookingSessionItem 7 params → 200400403404
GET
/booking-sessions/{bookingSessionId}/items/{itemId}
Queries a requested service item by identifier
queryRequestedServiceItemById 5 params → 200400403404410
DELETE
/booking-sessions/{bookingSessionId}/items/{itemId}
Removes a service item from the Booking Session
removeBookingSessionItem 6 params → 200400403404
GET
/booking-sessions/{bookingSessionId}/available-stores
Queries the store availability for appointments for booking
queryBookingSessionStoreAvailability 4 params → 200400403404410
GET
/booking-sessions/{bookingSessionId}/available-stores/{storeId}/slots
Queries the available appointment slots by store
queryBookingSessionsAvailableStoreSlots 5 params → 200400403404410
GET
/booking-sessions/{bookingSessionId}/available-stores/{storeId}/slots/{slotId}
Queries an available appointment slot
queryBookingSessionsAvailableSlot 6 params → 200400403404410
POST
/booking-sessions/{bookingSessionId}/available-stores/{storeId}/slots/{slotId}
Books an appointment slot. This is the final step in the appointment booking process.
bookAppointmentSlot 7 params → 201400403404410

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are BookingSession (10 properties), CreateBookingSessionPayload (7 properties), LinksObject (6 properties), Item (6 properties). Each schema is shown below with its type and property counts.

AddItemPayload
object
This describes the item that was added to the payload.
4 properties 4 required
AvailableStore
object
This shows when the store has available slots.
3 properties 3 required
CreateBookingSessionPayload
object
This is the booking session payload.
7 properties 4 required
TransportationOption
object
This indicates the option of transportation that the customer selected.
2 properties 2 required
Cost
object
This is the description of the cost.
2 properties 2 required
TransportationOffer
object
This is the offer to provide transportation.
3 properties 3 required
Error
object
This is the description of the error that you are getting.
2 properties 2 required
Ok
object
This describes a successful POST to update an item.
2 properties 2 required
Slot
object
This field indicates the time slot that the store selects a time slot to offer the transportation.
5 properties 5 required
BookingSession
object
This confirms the booking session when you have booked something.
10 properties 10 required
Item
object
This give the service package that the store would like to offer to the consumer.
6 properties 6 required
LinksObject
object
This is the common links object across all API calls.
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cdk-global-service-booking-api-openapi.yml Raw ↑

Other APIs CDK Global publishes across the network.

Fortellis Platform
Fortellis Event Relay Data Plane Proxy (AsyncAPI)
Fortellis AsyncAPI Hello World Reference
CDK Global adopt API
CDK Global adopt delete API
CDK Global adopt update API
CDK Global cancel API
CDK Global create API
CDK Global events API
CDK Global manage API
CDK Global query API
CDK Global update API