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: 5 required: false schema: type: integer description: 'The page number to return.' example: 5 - 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: doloribus discountTotal: '0' total: 31.07 shippingCost: 82 orderDate: null numVouchers: 1 customer: 5343 properties: data: type: object example: orderNumber: 5 discountCode: doloribus discountTotal: '0' total: 31.07 shippingCost: 82 orderDate: null numVouchers: 1 customer: 5343 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: aperiam required: true schema: type: string description: 'The order ID of the order to return.' example: aperiam - 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: et discountTotal: '0' total: 4.11 shippingCost: 4.8 orderDate: null numVouchers: 1 customer: 5344 properties: data: type: object example: orderNumber: 6 discountCode: et discountTotal: '0' total: 4.11 shippingCost: 4.8 orderDate: null numVouchers: 1 customer: 5344 tags: - Order parameters: - in: path name: order_number description: '' example: quia 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: 13 required: false schema: type: integer description: 'The page number to return.' example: 13 - 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: jnm-000825-000591 description: 'Afternoon Tea
for One' issuedDate: '2025-07-01 02:05:36' validFromDate: '2025-07-01 02:05:36' expiryDate: '2026-08-08 00:00:00' personalisation: to: quidem message: 'Quo asperiores rem alias ipsam. Voluptatem recusandae aliquam tempora nihil aut. Id perferendis libero aut quas accusamus. Quo et excepturi doloremque assumenda ullam aut incidunt.' total: 85.22 paid: 85.22 balance: 29.22 status: Redeemed customerName: 'Muhammad Marshall' partRedeemable: false delivery: method: Email cost: 92.2 email: null properties: data: type: object example: code: jnm-000825-000591 description: 'Afternoon Tea
for One' issuedDate: '2025-07-01 02:05:36' validFromDate: '2025-07-01 02:05:36' expiryDate: '2026-08-08 00:00:00' personalisation: to: quidem message: 'Quo asperiores rem alias ipsam. Voluptatem recusandae aliquam tempora nihil aut. Id perferendis libero aut quas accusamus. Quo et excepturi doloremque assumenda ullam aut incidunt.' total: 85.22 paid: 85.22 balance: 29.22 status: Redeemed customerName: 'Muhammad Marshall' partRedeemable: false delivery: method: Email cost: 92.2 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: iti-000221-000326 description: 'Ultimate Spa Treatment
For Two ' issuedDate: '2025-12-29 14:30:56' validFromDate: '2025-12-29 14:30:56' expiryDate: '2026-04-17 00:00:00' personalisation: to: et message: 'Et accusantium dolorem aut facere odio eveniet harum quo. Et mollitia sit aliquid quia accusamus aliquam. Optio rerum et quis velit praesentium laborum.' total: 41.17 paid: 41.17 balance: 51.5 status: Redeemed customerName: 'Sabrina Mason' partRedeemable: false delivery: method: Email cost: 95.03 email: null properties: data: type: object example: code: iti-000221-000326 description: 'Ultimate Spa Treatment
For Two ' issuedDate: '2025-12-29 14:30:56' validFromDate: '2025-12-29 14:30:56' expiryDate: '2026-04-17 00:00:00' personalisation: to: et message: 'Et accusantium dolorem aut facere odio eveniet harum quo. Et mollitia sit aliquid quia accusamus aliquam. Optio rerum et quis velit praesentium laborum.' total: 41.17 paid: 41.17 balance: 51.5 status: Redeemed customerName: 'Sabrina Mason' partRedeemable: false delivery: method: Email cost: 95.03 email: null tags: - Voucher parameters: - in: path name: code_voucher_id description: 'The ID of the code voucher.' example: id required: true schema: type: string - in: path name: code description: 'The code of the voucher to return.' example: dolore 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: jlw-000792-000705 description: 'Back, Face & Scalp Massage ' issuedDate: '2025-04-17 14:35:45' validFromDate: '2025-04-17 14:35:45' expiryDate: '2028-03-16 00:00:00' personalisation: to: harum message: 'Repudiandae voluptates ab aut rem perspiciatis. Aut excepturi quibusdam temporibus quod modi quis blanditiis. Aliquam pariatur eos est maxime quasi et perspiciatis unde.' total: 19.34 paid: 19.34 balance: 52.88 status: Redeemed customerName: 'Teagan Richards' partRedeemable: false delivery: method: Post type: 'Gift Box Signed 1st class ' cost: 40.78 properties: data: type: object example: code: jlw-000792-000705 description: 'Back, Face & Scalp Massage ' issuedDate: '2025-04-17 14:35:45' validFromDate: '2025-04-17 14:35:45' expiryDate: '2028-03-16 00:00:00' personalisation: to: harum message: 'Repudiandae voluptates ab aut rem perspiciatis. Aut excepturi quibusdam temporibus quod modi quis blanditiis. Aliquam pariatur eos est maxime quasi et perspiciatis unde.' total: 19.34 paid: 19.34 balance: 52.88 status: Redeemed customerName: 'Teagan Richards' partRedeemable: false delivery: method: Post type: 'Gift Box Signed 1st class ' cost: 40.78 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: necessitatibus required: true schema: type: string - in: path name: code description: 'The code of the voucher to be redeemed.' example: architecto 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: []