openapi: 3.2.0
info:
title: Amex Gbt bookings v2 API
version: '1.0'
description: 'Operations tagged bookings v2 across 2 of this provider''s published API definitions: amex-gbt-booking-api-openapi.json, amex-gbt-service-openconnect-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://apis.egencia.com/openconnect/api
description: Generated server url
tags:
- name: bookings v2
paths:
/v2/bookings/{bookingId}/items/{itemId}/receipts:
get:
description: "
Fetch all receipts for a booking item as a zip file
\nRequest Parameters
\n\n
\n \n \n | \n Attribute\n | \n \n Type\n | \n \n Description\n | \n
\n \n \n \n | bookingId | \n String | \n Id corresponding to the trips summary for which you want to fetch all booking item receipts | \n
\n \n | itemId | \n String | \n Id corresponding to the booking item for which we want to fetch receipts | \n
\n \n
\n
\nResponse Parameters in case of successful response
\nIn case of successful response, receipts zip file will be sent to the partner with 200 OK status
\nResponse Parameters in case of failure response
\n\n
\n \n \n | \n Attribute\n | \n \n Type\n | \n \n Description\n | \n
\n \n \n \n | code | \n String | \n Error code in case of failure | \n
\n \n | message | \n String | \n Error message in case of failure | \n
\n \n
\n
\nBelow response with 404 Not Found Error HttpStatus
\n\n
\n \n {\n \"error\": {\n \"code\": \"EGE-ER-OS-4010\",\n \"message\": \"Receipt is unavailable for this booking item.\"\n }\n }\n \n
\n
\n"
operationId: getReceiptsAsZip
parameters:
- description: Booking id
in: path
name: bookingId
required: true
schema:
type: string
- description: Trip item id
in: path
name: itemId
required: true
schema:
type: string
- description: Locale
in: query
name: locale
required: false
schema:
type: string
responses:
'200':
description: OK.
'400':
description: 'Bad Request : Invalid input or request'
'401':
description: 'Unauthorized : authentication token empty, invalid or expired.'
'403':
description: 'Forbidden : User not Validated for operation.'
'404':
description: 'Not Found : You are trying to access an invalid or non existent resource.'
'422':
description: 'Invalid input : invalid or missing required input.'
'500':
description: 'Internal Server Error : unable to process request'
security:
- OAuth2: []
summary: Fetch all receipts for a booking item as a zip file
tags:
- bookings v2
servers:
- url: https://apis.egencia.com/openconnect/api
description: Generated server url
/v2/bookings/{bookingId}/items/{itemId}/receipts/{receiptId}:
get:
description: "Fetch receipt for a booking item by receipt id
\nRequest Parameters
\n\n
\n \n \n | \n Attribute\n | \n \n Type\n | \n \n Description\n | \n
\n \n \n \n | bookingId | \n String | \n Id corresponding to the trips summary for which you want to fetch each booking item receipts | \n
\n \n | itemId | \n String | \n Id corresponding to the booking item for which we want to fetch receipt | \n
\n \n | receiptId | \n String | \n Id corresponding to the receipt we want to fetch | \n
\n \n
\n
\nResponse Parameters in case of successful response
\nIn case of successful response, receipt pdf will be sent to the partner with 200 OK status
\nResponse Parameters in case of failure response
\n\n
\n \n \n | \n Attribute\n | \n \n Type\n | \n \n Description\n | \n
\n \n \n \n | code | \n String | \n Error code in case of failure | \n
\n \n | message | \n String | \n Error message in case of failure | \n
\n \n
\n
\nBelow response with 404 Not Found Error HttpStatus
\n\n
\n \n {\n \"error\": {\n \"code\": \"EGE-ER-OS-4010\",\n \"message\": \"Receipt is unavailable for this booking item.\"\n }\n }\n \n
\n
\n"
operationId: getReceipt
parameters:
- description: Booking id
in: path
name: bookingId
required: true
schema:
type: string
- description: Trip item id
in: path
name: itemId
required: true
schema:
type: string
- description: Receipt id
in: path
name: receiptId
required: true
schema:
type: string
- description: Locale
in: query
name: locale
required: false
schema:
type: string
- description: Id of the traveler to whom invoice/receipt is issued
in: query
name: traveler_id
required: false
schema:
type: string
responses:
'200':
description: OK.
'400':
description: 'Bad Request : Invalid input or request'
'401':
description: 'Unauthorized : authentication token empty, invalid or expired.'
'403':
description: 'Forbidden : User not Validated for operation.'
'404':
description: 'Not Found : You are trying to access an invalid or non existent resource.'
'422':
description: 'Invalid input : invalid or missing required input.'
'500':
description: 'Internal Server Error : unable to process request'
security:
- OAuth2: []
summary: Fetch receipt for a booking item by receipt id
tags:
- bookings v2
servers:
- url: https://apis.egencia.com/openconnect/api
description: Generated server url
components:
securitySchemes:
OAuth2:
flows:
clientCredentials:
tokenUrl: https://apis.egencia.com/auth/v1/token
type: oauth2
x-refined-from:
- amex-gbt-booking-api-openapi.json
- amex-gbt-service-openconnect-openapi.json