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: 17 required: false schema: type: integer description: 'The page number to return.' example: 17 - 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: soluta discountTotal: '0' total: 24.89 shippingCost: 87.04 orderDate: null numVouchers: 1 customer: 5352 properties: data: type: object example: orderNumber: 5 discountCode: soluta discountTotal: '0' total: 24.89 shippingCost: 87.04 orderDate: null numVouchers: 1 customer: 5352 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: consequatur required: true schema: type: string description: 'The order ID of the order to return.' example: consequatur - 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: et discountTotal: '0' total: 62.55 shippingCost: 22.92 orderDate: null numVouchers: 1 customer: 5353 properties: data: type: object example: orderNumber: 6 discountCode: et discountTotal: '0' total: 62.55 shippingCost: 22.92 orderDate: null numVouchers: 1 customer: 5353 tags: - Order parameters: - in: path name: order_number description: '' example: harum 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: 1 required: false schema: type: integer description: 'The page number to return.' example: 1 - 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: pzt-000150-000760 description: 'Prosecco Afternoon Tea
2 people ' issuedDate: '2025-11-20 00:44:42' validFromDate: '2025-11-20 00:44:42' expiryDate: '2027-10-23 00:00:00' personalisation: to: libero message: 'Ut distinctio voluptatem recusandae nisi ipsum. Corrupti explicabo quam expedita est perspiciatis. Nisi dolores est atque velit aut sunt voluptatem. Assumenda distinctio hic et totam.' total: 72 paid: 72 balance: 48.75 status: Redeemed customerName: 'Frank Thompson' partRedeemable: false delivery: method: Email cost: 12.39 email: null properties: data: type: object example: code: pzt-000150-000760 description: 'Prosecco Afternoon Tea
2 people ' issuedDate: '2025-11-20 00:44:42' validFromDate: '2025-11-20 00:44:42' expiryDate: '2027-10-23 00:00:00' personalisation: to: libero message: 'Ut distinctio voluptatem recusandae nisi ipsum. Corrupti explicabo quam expedita est perspiciatis. Nisi dolores est atque velit aut sunt voluptatem. Assumenda distinctio hic et totam.' total: 72 paid: 72 balance: 48.75 status: Redeemed customerName: 'Frank Thompson' partRedeemable: false delivery: method: Email cost: 12.39 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: tzy-000798-000290 description: 'Monetary Vouchers
To the value of £40.00' issuedDate: '2025-09-06 22:28:15' validFromDate: '2025-09-06 22:28:15' expiryDate: '2027-04-10 00:00:00' personalisation: to: suscipit message: 'Earum temporibus maiores voluptates consequatur rerum. Cupiditate enim soluta nobis nihil reprehenderit. Eum iste at non fuga doloribus placeat. Delectus voluptatem quia animi est similique.' total: 45.75 paid: 45.75 balance: 23.01 status: Redeemed customerName: 'Charlie Wright' partRedeemable: false delivery: method: Email cost: 20.81 email: null properties: data: type: object example: code: tzy-000798-000290 description: 'Monetary Vouchers
To the value of £40.00' issuedDate: '2025-09-06 22:28:15' validFromDate: '2025-09-06 22:28:15' expiryDate: '2027-04-10 00:00:00' personalisation: to: suscipit message: 'Earum temporibus maiores voluptates consequatur rerum. Cupiditate enim soluta nobis nihil reprehenderit. Eum iste at non fuga doloribus placeat. Delectus voluptatem quia animi est similique.' total: 45.75 paid: 45.75 balance: 23.01 status: Redeemed customerName: 'Charlie Wright' partRedeemable: false delivery: method: Email cost: 20.81 email: null tags: - Voucher parameters: - in: path name: code_voucher_id description: 'The ID of the code voucher.' example: voluptatum required: true schema: type: string - in: path name: code description: 'The code of the voucher to return.' example: non 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: dze-000926-000860 description: 'Mud Rasul
2 people (45 mins)  ' issuedDate: '2025-10-22 04:20:16' validFromDate: '2025-10-22 04:20:16' expiryDate: '2027-01-03 00:00:00' personalisation: to: consequuntur message: 'Sint quia suscipit eum culpa. Culpa saepe nemo libero quidem voluptas voluptas sequi. Et dolor ad possimus quidem maiores nihil.' total: 17.33 paid: 17.33 balance: 30.12 status: Redeemed customerName: 'Ashley Reid' partRedeemable: false delivery: method: Post type: 'Vouchers will be sent via email' cost: 9.87 properties: data: type: object example: code: dze-000926-000860 description: 'Mud Rasul
2 people (45 mins)  ' issuedDate: '2025-10-22 04:20:16' validFromDate: '2025-10-22 04:20:16' expiryDate: '2027-01-03 00:00:00' personalisation: to: consequuntur message: 'Sint quia suscipit eum culpa. Culpa saepe nemo libero quidem voluptas voluptas sequi. Et dolor ad possimus quidem maiores nihil.' total: 17.33 paid: 17.33 balance: 30.12 status: Redeemed customerName: 'Ashley Reid' partRedeemable: false delivery: method: Post type: 'Vouchers will be sent via email' cost: 9.87 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: 13 parameters: - in: path name: code_voucher_id description: 'The ID of the code voucher.' example: nam required: true schema: type: string - in: path name: code description: 'The code of the voucher to be redeemed.' example: molestiae 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: []