Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
version: 3.0.0
title: appointments Cancel API
description: '## Fortellis - Service - Appointments
A service appointment is a booking of a vehicle into the service department for work that needs to be carried out on the vehicle.'
contact:
name: Developer Evangelists
url: https://example.com
email: support@fortellis.io
servers:
- url: https://fortellis.io/sales/notification/v3
security:
- permission-model:
- anonymous
tags:
- name: Cancel
paths:
/{appointmentId}:
delete:
summary: Cancel an appointment
description: Cancels an appointment. This method does not guarantee that resource reservations associated with the appointment (advisors, transports, reserved equipment/parts) will be released. It is suggested that the service-scheduling API be used for this purpose.
operationId: cancelAppointment
tags:
- Cancel
parameters:
- $ref: '#/components/parameters/header.Accept'
- $ref: '#/components/parameters/header.Accept-Charset'
- $ref: '#/components/parameters/header.Accept-Language'
- $ref: '#/components/parameters/header.If-Match'
- $ref: '#/components/parameters/header.If-None-Match'
- $ref: '#/components/parameters/header.Prefer'
- $ref: '#/components/parameters/header.Request-Id'
- $ref: '#/components/parameters/header.Subscription-Id'
- $ref: '#/components/parameters/header.Authorization'
- $ref: '#/components/parameters/path.appointmentId'
- $ref: '#/components/parameters/body.CancelRequest'
responses:
'204':
$ref: '#/components/responses/Success'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
components:
schemas:
CancelRequest:
description: This fields describes why a customer requested to cancel.
type: object
properties:
reason:
type: string
description: Free-form comments that explain why the appointment was cancelled
required:
- reason
example:
reason: Rescheduled for the following week
ErrorResponse:
description: This is a generic error schema.
type: object
properties:
code:
type: integer
format: int32
message:
type: string
required:
- code
- message
example:
code: 24
message: Error Message used for debugging
parameters:
header.Request-Id:
name: Request-Id
in: header
required: true
description: You must include the Request-Id in every call to track the same call across systems.
schema:
type: string
format: guid
header.Subscription-Id:
name: Subscription-Id
in: header
required: true
description: The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'.
schema:
type: string
format: guid
body.CancelRequest:
name: CancelRequest
in: body
required: true
description: An appointment cancellation request
schema:
$ref: '#/components/schemas/CancelRequest'
path.appointmentId:
name: appointmentId
in: path
required: true
description: The appointment identifier
schema:
type: string
header.Accept:
description: This header describes the characters that the API will accept.
name: Accept
in: header
schema:
type: string
enum:
- application/json
header.Prefer:
description: This header describes the preferences of the client calling the API.
name: Prefer
in: header
schema:
type: string
enum:
- return=representation
- return=minimal
header.If-Match:
name: If-Match
in: header
description: Specifies a conditional request to only return the resource when it does match one of the included ETag values
schema:
type: string
header.Accept-Charset:
description: This header describes the characters that the client will accept.
name: Accept-Charset
in: header
schema:
type: string
enum:
- utf-8
header.Authorization:
name: Authorization
in: header
required: true
description: Provides authorization to access Fortellis APIs. For calling a Fortellis Provider, this must be an OAuth 2.0 token issued by the Fortellis authorization server, but you may call the simulator platform with Basic Authorization using your API key and secret.
schema:
type: string
format: guid
header.Accept-Language:
description: This header describes the languages that the client accepts.
name: Accept-Language
in: header
schema:
type: string
header.If-None-Match:
name: If-None-Match
in: header
description: Specifies a conditional request to only return the resource when it doesn't match one of the included ETag values
schema:
type: string
responses:
BadRequest:
description: 400 - Bad Request
headers:
Content-Language:
schema:
type: string
Content-Type:
schema:
type: string
Request-Id:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
Success:
description: 204 - Non Content
headers:
Content-Language:
schema:
type: string
Content-Type:
schema:
type: string
Request-Id:
schema:
type: string
Unauthorized:
description: 401 - Unauthorized
headers:
Content-Language:
schema:
type: string
Content-Type:
schema:
type: string
Request-Id:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
NotFound:
description: 404 - Not Found
headers:
Content-Language:
schema:
type: string
Content-Type:
schema:
type: string
Request-Id:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
Forbidden:
description: 403 - Forbidden
headers:
Content-Language:
schema:
type: string
Content-Type:
schema:
type: string
Request-Id:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
securitySchemes:
permission-model:
type: oauth2
flows:
implicit:
scopes:
anonymous: Create, Query, Update, and Delete appointments
authorizationUrl: https://identity.fortellis.io/oauth2/
x-provenance:
method: harvested
publisher: CDK Global
source: https://raw.githubusercontent.com/fortellis/example-spec/HEAD/Rest-API-Specs/appointments-v3.0.0.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)