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: 20
required: false
schema:
type: integer
description: 'The page number to return.'
example: 20
-
in: query
name: expanded
description: 'Expand related values to full objects e.g return all orders with customer details.'
example: true
required: false
schema:
type: boolean
description: 'Expand related values to full objects e.g return all orders with 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: 5
discountCode: perspiciatis
discountTotal: '0'
total: 12.39
shippingCost: 12.61
orderDate: null
numVouchers: 1
customer: 5369
properties:
data:
type: object
example:
orderNumber: 5
discountCode: perspiciatis
discountTotal: '0'
total: 12.39
shippingCost: 12.61
orderDate: null
numVouchers: 1
customer: 5369
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: impedit
required: true
schema:
type: string
description: 'The order ID of the order to return.'
example: impedit
-
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: repellendus
discountTotal: '0'
total: 39.42
shippingCost: 71.62
orderDate: null
numVouchers: 1
customer: 5370
properties:
data:
type: object
example:
orderNumber: 6
discountCode: repellendus
discountTotal: '0'
total: 39.42
shippingCost: 71.62
orderDate: null
numVouchers: 1
customer: 5370
tags:
- Order
parameters:
-
in: path
name: order_number
description: ''
example: distinctio
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: 19
required: false
schema:
type: integer
description: 'The page number to return.'
example: 19
-
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: yzs-000414-000196
description: 'Mud Rasul
2 people (45 mins) '
issuedDate: '2025-07-18 19:59:31'
validFromDate: '2025-07-18 19:59:31'
expiryDate: '2026-08-23 00:00:00'
personalisation:
to: molestiae
message: 'Perspiciatis ex fugiat cum atque ipsam excepturi deleniti. Non rerum rem et architecto ut iste accusamus.'
total: 54.59
paid: 54.59
balance: 14.62
status: Unredeemed
customerName: 'Florence Lee'
partRedeemable: false
delivery:
method: Email
cost: 82.09
email: null
properties:
data:
type: object
example:
code: yzs-000414-000196
description: 'Mud Rasul
2 people (45 mins) '
issuedDate: '2025-07-18 19:59:31'
validFromDate: '2025-07-18 19:59:31'
expiryDate: '2026-08-23 00:00:00'
personalisation:
to: molestiae
message: 'Perspiciatis ex fugiat cum atque ipsam excepturi deleniti. Non rerum rem et architecto ut iste accusamus.'
total: 54.59
paid: 54.59
balance: 14.62
status: Unredeemed
customerName: 'Florence Lee'
partRedeemable: false
delivery:
method: Email
cost: 82.09
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: wxp-000924-000782
description: 'Back, Face & Scalp Massage '
issuedDate: '2026-04-04 11:01:15'
validFromDate: '2026-04-04 11:01:15'
expiryDate: '2027-10-13 00:00:00'
personalisation:
to: ipsa
message: 'Ut cupiditate rerum est corporis velit. Sit omnis voluptatem et eos tempore est rerum. Quaerat minus quibusdam est labore. Officia inventore saepe sed. Sed distinctio at officiis sed et nihil ullam.'
total: 10.13
paid: 10.13
balance: 57.26
status: Redeemed
customerName: 'Ruth Fox'
partRedeemable: false
delivery:
method: Post
type: 'Gift Box Signed 1st class '
cost: 66.08
properties:
data:
type: object
example:
code: wxp-000924-000782
description: 'Back, Face & Scalp Massage '
issuedDate: '2026-04-04 11:01:15'
validFromDate: '2026-04-04 11:01:15'
expiryDate: '2027-10-13 00:00:00'
personalisation:
to: ipsa
message: 'Ut cupiditate rerum est corporis velit. Sit omnis voluptatem et eos tempore est rerum. Quaerat minus quibusdam est labore. Officia inventore saepe sed. Sed distinctio at officiis sed et nihil ullam.'
total: 10.13
paid: 10.13
balance: 57.26
status: Redeemed
customerName: 'Ruth Fox'
partRedeemable: false
delivery:
method: Post
type: 'Gift Box Signed 1st class '
cost: 66.08
tags:
- Voucher
parameters:
-
in: path
name: code_voucher_id
description: 'The ID of the code voucher.'
example: qui
required: true
schema:
type: string
-
in: path
name: code
description: 'The code of the voucher to return.'
example: nisi
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: act-000298-000303
description: '2 Night stay with Breakfast'
issuedDate: '2026-05-17 11:45:29'
validFromDate: '2026-05-17 11:45:29'
expiryDate: '2027-08-04 00:00:00'
personalisation:
to: neque
message: 'Corrupti voluptate et qui sit sapiente accusantium. Dicta explicabo natus nihil omnis soluta.'
total: 36.26
paid: 36.26
balance: 67.16
status: Unredeemed
customerName: 'Melissa Thompson'
partRedeemable: false
delivery:
method: Post
type: 'Gift Box Signed 1st class '
cost: 96.32
properties:
data:
type: object
example:
code: act-000298-000303
description: '2 Night stay with Breakfast'
issuedDate: '2026-05-17 11:45:29'
validFromDate: '2026-05-17 11:45:29'
expiryDate: '2027-08-04 00:00:00'
personalisation:
to: neque
message: 'Corrupti voluptate et qui sit sapiente accusantium. Dicta explicabo natus nihil omnis soluta.'
total: 36.26
paid: 36.26
balance: 67.16
status: Unredeemed
customerName: 'Melissa Thompson'
partRedeemable: false
delivery:
method: Post
type: 'Gift Box Signed 1st class '
cost: 96.32
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: 17
parameters:
-
in: path
name: code_voucher_id
description: 'The ID of the code voucher.'
example: eligendi
required: true
schema:
type: string
-
in: path
name: code
description: 'The code of the voucher to be redeemed.'
example: ipsam
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: []