openapi: 3.0.3
info:
title: 'Gift Voucher Brilliance API'
description: 'API for Gift Voucher Brilliance'
version: 1.0.0
servers:
-
url: 'https://admin.giftvoucherbrilliance.co.uk'
paths:
/api/orders:
get:
summary: 'Return details about the latest orders.'
description: ''
parameters:
-
in: query
name: page
description: 'The page number to return.'
example: 14
required: false
schema:
type: integer
description: 'The page number to return.'
example: 14
-
in: query
name: expanded
description: 'Expand related values to full objects e.g return all orders with customer details.'
example: false
required: false
schema:
type: boolean
description: 'Expand related values to full objects e.g return all orders with customer details.'
example: false
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_TOKEN}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
orderNumber: 5
discountCode: enim
discountTotal: '0'
total: 74.47
shippingCost: 3.14
orderDate: null
numVouchers: 1
customer: 5156
properties:
data:
type: object
example:
orderNumber: 5
discountCode: enim
discountTotal: '0'
total: 74.47
shippingCost: 3.14
orderDate: null
numVouchers: 1
customer: 5156
tags:
- Order
'/api/orders/{order_number}':
get:
summary: 'Return details about a single order.'
description: ''
parameters:
-
in: query
name: $order
description: 'The order ID of the order to return.'
example: magni
required: true
schema:
type: string
description: 'The order ID of the order to return.'
example: magni
-
in: query
name: expanded
description: 'Expand related values to full objects e.g return the order with voucher and customer details.'
example: true
required: false
schema:
type: boolean
description: 'Expand related values to full objects e.g return the order with voucher and customer details.'
example: true
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_TOKEN}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
orderNumber: 6
discountCode: nam
discountTotal: '0'
total: 52.91
shippingCost: 74.81
orderDate: null
numVouchers: 1
customer: 5157
properties:
data:
type: object
example:
orderNumber: 6
discountCode: nam
discountTotal: '0'
total: 52.91
shippingCost: 74.81
orderDate: null
numVouchers: 1
customer: 5157
tags:
- Order
parameters:
-
in: path
name: order_number
description: ''
example: eveniet
required: true
schema:
type: string
/api/shop:
get:
summary: 'Return details about the current authenicated shop'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_TOKEN}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
title: Clockwork
url: 'https://clockwork.giftvoucherbrilliance.co.uk'
properties:
data:
type: object
example:
title: Clockwork
url: 'https://clockwork.giftvoucherbrilliance.co.uk'
tags:
- Shop
/api/vouchers-sold:
get:
summary: 'Return details about the latest vouchers issued.'
description: ''
parameters:
-
in: query
name: page
description: 'The page number to return.'
example: 9
required: false
schema:
type: integer
description: 'The page number to return.'
example: 9
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_TOKEN}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
code: hmi-000245-000593
description: 'Afternoon Tea
for One'
issuedDate: '2025-07-11 08:25:50'
validFromDate: '2025-07-11 08:25:50'
expiryDate: '2028-01-24 00:00:00'
personalisation:
to: sunt
message: 'Dolor voluptate distinctio quibusdam sed animi sed voluptatem hic. Voluptatem eaque quas corporis aut est est.'
total: 80.03
paid: 80.03
balance: 84.52
status: Unredeemed
customerName: 'Dominic Parker'
partRedeemable: false
delivery:
method: Email
cost: 54.87
email: null
properties:
data:
type: object
example:
code: hmi-000245-000593
description: 'Afternoon Tea
for One'
issuedDate: '2025-07-11 08:25:50'
validFromDate: '2025-07-11 08:25:50'
expiryDate: '2028-01-24 00:00:00'
personalisation:
to: sunt
message: 'Dolor voluptate distinctio quibusdam sed animi sed voluptatem hic. Voluptatem eaque quas corporis aut est est.'
total: 80.03
paid: 80.03
balance: 84.52
status: Unredeemed
customerName: 'Dominic Parker'
partRedeemable: false
delivery:
method: Email
cost: 54.87
email: null
tags:
- Voucher
'/api/vouchers-sold/{code_voucher_id}':
get:
summary: 'Return details about a single voucher.'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_TOKEN}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
code: qpm-000307-000072
description: 'Mud Rasul
2 people (45 mins) '
issuedDate: '2025-03-25 22:28:32'
validFromDate: '2025-03-25 22:28:32'
expiryDate: '2026-08-22 00:00:00'
personalisation:
to: est
message: 'Dolore numquam et labore placeat. Sint qui eligendi accusamus ad asperiores voluptate. Et libero deleniti ipsum vel rerum nobis. Eius ipsa porro nam ducimus et dignissimos.'
total: 20.56
paid: 20.56
balance: 52.97
status: Redeemed
customerName: 'Callum Hunt'
partRedeemable: false
delivery:
method: Email
cost: 46.17
email: null
properties:
data:
type: object
example:
code: qpm-000307-000072
description: 'Mud Rasul
2 people (45 mins) '
issuedDate: '2025-03-25 22:28:32'
validFromDate: '2025-03-25 22:28:32'
expiryDate: '2026-08-22 00:00:00'
personalisation:
to: est
message: 'Dolore numquam et labore placeat. Sint qui eligendi accusamus ad asperiores voluptate. Et libero deleniti ipsum vel rerum nobis. Eius ipsa porro nam ducimus et dignissimos.'
total: 20.56
paid: 20.56
balance: 52.97
status: Redeemed
customerName: 'Callum Hunt'
partRedeemable: false
delivery:
method: Email
cost: 46.17
email: null
tags:
- Voucher
parameters:
-
in: path
name: code_voucher_id
description: 'The ID of the code voucher.'
example: ut
required: true
schema:
type: string
-
in: path
name: code
description: 'The code of the voucher to return.'
example: et
required: true
schema:
type: string
'/api/voucher/{code_voucher_id}/redeem':
post:
summary: 'Redeem a voucher.'
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_TOKEN}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: '0'
content:
application/json:
schema:
type: object
example:
data:
code: rja-000495-000112
description: '2 Night stay with Breakfast'
issuedDate: '2026-01-16 00:01:13'
validFromDate: '2026-01-16 00:01:13'
expiryDate: '2026-09-11 00:00:00'
personalisation:
to: id
message: 'Excepturi rerum possimus reprehenderit deserunt delectus sit sapiente. Quam labore hic rerum qui nesciunt voluptas adipisci. Perferendis sed nihil quos amet ab consectetur sed.'
total: 91.3
paid: 91.3
balance: 46.25
status: Unredeemed
customerName: 'Samantha Phillips'
partRedeemable: false
delivery:
method: Email
cost: 64.41
email: null
properties:
data:
type: object
example:
code: rja-000495-000112
description: '2 Night stay with Breakfast'
issuedDate: '2026-01-16 00:01:13'
validFromDate: '2026-01-16 00:01:13'
expiryDate: '2026-09-11 00:00:00'
personalisation:
to: id
message: 'Excepturi rerum possimus reprehenderit deserunt delectus sit sapiente. Quam labore hic rerum qui nesciunt voluptas adipisci. Perferendis sed nihil quos amet ab consectetur sed.'
total: 91.3
paid: 91.3
balance: 46.25
status: Unredeemed
customerName: 'Samantha Phillips'
partRedeemable: false
delivery:
method: Email
cost: 64.41
email: null
tags:
- Voucher
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
amount:
type: integer
description: 'If the voucher has partRedeemable set to true then you can pass this value. It should be an amount equal or less than the balance of the voucher. The value provided must be of smallest monetary unit of the currency used (integer) e.g £10.43 => 1043.'
example: 3
parameters:
-
in: path
name: code_voucher_id
description: 'The ID of the code voucher.'
example: tempora
required: true
schema:
type: string
-
in: path
name: code
description: 'The code of the voucher to be redeemed.'
example: autem
required: true
schema:
type: string
tags:
-
name: Order
description: ''
-
name: Shop
description: "\nEndpoints for getting information about the current shop which is decided via the API Token used."
-
name: Voucher
description: ''
components:
securitySchemes:
default:
type: http
scheme: bearer
description: ''
security:
-
default: []