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: 9 required: false schema: type: integer description: 'The page number to return.' example: 9 - 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: est discountTotal: '0' total: 47.79 shippingCost: 74.04 orderDate: null numVouchers: 1 customer: 5247 properties: data: type: object example: orderNumber: 5 discountCode: est discountTotal: '0' total: 47.79 shippingCost: 74.04 orderDate: null numVouchers: 1 customer: 5247 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: est required: true schema: type: string description: 'The order ID of the order to return.' example: est - in: query name: expanded description: 'Expand related values to full objects e.g return the order with voucher and customer details.' example: false required: false schema: type: boolean description: 'Expand related values to full objects e.g return the order with voucher and 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: 6 discountCode: quae discountTotal: '0' total: 25.59 shippingCost: 25.28 orderDate: null numVouchers: 1 customer: 5248 properties: data: type: object example: orderNumber: 6 discountCode: quae discountTotal: '0' total: 25.59 shippingCost: 25.28 orderDate: null numVouchers: 1 customer: 5248 tags: - Order parameters: - in: path name: order_number description: '' example: aliquid 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: 14 required: false schema: type: integer description: 'The page number to return.' example: 14 - 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: bey-000693-000154 description: 'Monetary Vouchers
To the value of £40.00' issuedDate: '2025-11-15 12:24:35' validFromDate: '2025-11-15 12:24:35' expiryDate: '2026-03-11 00:00:00' personalisation: to: ratione message: 'Aut necessitatibus sit deleniti. Suscipit nulla earum magni. Dolorem beatae animi autem. Illo ratione rerum impedit vel. Et tempore in aut expedita.' total: 65.53 paid: 65.53 balance: 52.84 status: Unredeemed customerName: 'Daniel Murphy' partRedeemable: false delivery: method: Post type: 'Vouchers will be sent via email' cost: 55.3 properties: data: type: object example: code: bey-000693-000154 description: 'Monetary Vouchers
To the value of £40.00' issuedDate: '2025-11-15 12:24:35' validFromDate: '2025-11-15 12:24:35' expiryDate: '2026-03-11 00:00:00' personalisation: to: ratione message: 'Aut necessitatibus sit deleniti. Suscipit nulla earum magni. Dolorem beatae animi autem. Illo ratione rerum impedit vel. Et tempore in aut expedita.' total: 65.53 paid: 65.53 balance: 52.84 status: Unredeemed customerName: 'Daniel Murphy' partRedeemable: false delivery: method: Post type: 'Vouchers will be sent via email' cost: 55.3 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: wiq-000369-000524 description: 'Ultimate Spa Treatment
For Two ' issuedDate: '2025-05-30 18:14:45' validFromDate: '2025-05-30 18:14:45' expiryDate: '2027-06-02 00:00:00' personalisation: to: aut message: 'Est suscipit consectetur repellat deserunt. Occaecati aut vel commodi asperiores qui error dicta. Perspiciatis omnis fugiat non aperiam tempore. Molestias nesciunt qui commodi iusto.' total: 89.96 paid: 89.96 balance: 17.62 status: Unredeemed customerName: 'Nick Bell' partRedeemable: false delivery: method: Email cost: 51.86 email: null properties: data: type: object example: code: wiq-000369-000524 description: 'Ultimate Spa Treatment
For Two ' issuedDate: '2025-05-30 18:14:45' validFromDate: '2025-05-30 18:14:45' expiryDate: '2027-06-02 00:00:00' personalisation: to: aut message: 'Est suscipit consectetur repellat deserunt. Occaecati aut vel commodi asperiores qui error dicta. Perspiciatis omnis fugiat non aperiam tempore. Molestias nesciunt qui commodi iusto.' total: 89.96 paid: 89.96 balance: 17.62 status: Unredeemed customerName: 'Nick Bell' partRedeemable: false delivery: method: Email cost: 51.86 email: null tags: - Voucher parameters: - in: path name: code_voucher_id description: 'The ID of the code voucher.' example: minima required: true schema: type: string - in: path name: code description: 'The code of the voucher to return.' example: doloribus 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: ytf-000313-000190 description: 'Mud Rasul
2 people (45 mins)  ' issuedDate: '2025-04-13 02:52:00' validFromDate: '2025-04-13 02:52:00' expiryDate: '2027-03-14 00:00:00' personalisation: to: nesciunt message: 'Possimus velit tempore minus eius sequi. Aut voluptatem enim velit accusantium et impedit dolore. Veritatis ab ut placeat nisi qui.' total: 59.72 paid: 59.72 balance: 39.57 status: Redeemed customerName: 'Dave Brown' partRedeemable: false delivery: method: Email cost: 60.08 email: null properties: data: type: object example: code: ytf-000313-000190 description: 'Mud Rasul
2 people (45 mins)  ' issuedDate: '2025-04-13 02:52:00' validFromDate: '2025-04-13 02:52:00' expiryDate: '2027-03-14 00:00:00' personalisation: to: nesciunt message: 'Possimus velit tempore minus eius sequi. Aut voluptatem enim velit accusantium et impedit dolore. Veritatis ab ut placeat nisi qui.' total: 59.72 paid: 59.72 balance: 39.57 status: Redeemed customerName: 'Dave Brown' partRedeemable: false delivery: method: Email cost: 60.08 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: 11 parameters: - in: path name: code_voucher_id description: 'The ID of the code voucher.' example: odio required: true schema: type: string - in: path name: code description: 'The code of the voucher to be redeemed.' example: nihil 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: []