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: 2 required: false schema: type: integer description: 'The page number to return.' example: 2 - 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: aut discountTotal: '0' total: 25.35 shippingCost: 20.29 orderDate: null numVouchers: 1 customer: 4440 properties: data: type: object example: orderNumber: 5 discountCode: aut discountTotal: '0' total: 25.35 shippingCost: 20.29 orderDate: null numVouchers: 1 customer: 4440 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: dolores required: true schema: type: string description: 'The order ID of the order to return.' example: dolores - 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: 43.77 shippingCost: 30.44 orderDate: null numVouchers: 1 customer: 4441 properties: data: type: object example: orderNumber: 6 discountCode: et discountTotal: '0' total: 43.77 shippingCost: 30.44 orderDate: null numVouchers: 1 customer: 4441 tags: - Order parameters: - in: path name: order_number description: '' example: enim 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: 11 required: false schema: type: integer description: 'The page number to return.' example: 11 - 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: idm-000801-000180 description: 'Afternoon Tea
for Two' issuedDate: '2024-12-19 19:51:01' validFromDate: '2024-12-19 19:51:01' expiryDate: '2025-06-19 00:00:00' personalisation: to: molestiae message: 'Autem vel consequuntur blanditiis neque vitae. Quia non quod minus nihil. Ipsum illo eligendi expedita animi tempore. Asperiores voluptates ut expedita hic sed culpa repudiandae quia.' total: 47.66 paid: 47.66 balance: 64.62 status: Unredeemed customerName: 'Duncan Palmer' partRedeemable: false delivery: method: Email cost: 80.61 email: null properties: data: type: object example: code: idm-000801-000180 description: 'Afternoon Tea
for Two' issuedDate: '2024-12-19 19:51:01' validFromDate: '2024-12-19 19:51:01' expiryDate: '2025-06-19 00:00:00' personalisation: to: molestiae message: 'Autem vel consequuntur blanditiis neque vitae. Quia non quod minus nihil. Ipsum illo eligendi expedita animi tempore. Asperiores voluptates ut expedita hic sed culpa repudiandae quia.' total: 47.66 paid: 47.66 balance: 64.62 status: Unredeemed customerName: 'Duncan Palmer' partRedeemable: false delivery: method: Email cost: 80.61 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: xlx-000184-000684 description: 'Afternoon Tea
for Two' issuedDate: '2024-07-20 09:44:58' validFromDate: '2024-07-20 09:44:58' expiryDate: '2025-07-25 00:00:00' personalisation: to: enim message: 'Et qui est minus. Et et architecto dolor ratione. Iusto odit modi sit error consequatur qui culpa.' total: 24.76 paid: 24.76 balance: 35.14 status: Redeemed customerName: 'Patricia Thomas' partRedeemable: false delivery: method: Post type: 'Gift Box Signed 1st class ' cost: 11.64 properties: data: type: object example: code: xlx-000184-000684 description: 'Afternoon Tea
for Two' issuedDate: '2024-07-20 09:44:58' validFromDate: '2024-07-20 09:44:58' expiryDate: '2025-07-25 00:00:00' personalisation: to: enim message: 'Et qui est minus. Et et architecto dolor ratione. Iusto odit modi sit error consequatur qui culpa.' total: 24.76 paid: 24.76 balance: 35.14 status: Redeemed customerName: 'Patricia Thomas' partRedeemable: false delivery: method: Post type: 'Gift Box Signed 1st class ' cost: 11.64 tags: - Voucher parameters: - in: path name: code_voucher_id description: 'The ID of the code voucher.' example: quo required: true schema: type: string - in: path name: code description: 'The code of the voucher to return.' example: necessitatibus 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: tld-000577-000968 description: 'Monetary Vouchers
To the value of £100.00' issuedDate: '2024-12-26 02:46:08' validFromDate: '2024-12-26 02:46:08' expiryDate: '2026-10-12 00:00:00' personalisation: to: vero message: 'Qui ea voluptatum rem harum culpa. Minima delectus repudiandae laborum adipisci.' total: 4.95 paid: 4.95 balance: 89.37 status: Unredeemed customerName: 'Yvonne Moore' partRedeemable: false delivery: method: Email cost: 0.42 email: null properties: data: type: object example: code: tld-000577-000968 description: 'Monetary Vouchers
To the value of £100.00' issuedDate: '2024-12-26 02:46:08' validFromDate: '2024-12-26 02:46:08' expiryDate: '2026-10-12 00:00:00' personalisation: to: vero message: 'Qui ea voluptatum rem harum culpa. Minima delectus repudiandae laborum adipisci.' total: 4.95 paid: 4.95 balance: 89.37 status: Unredeemed customerName: 'Yvonne Moore' partRedeemable: false delivery: method: Email cost: 0.42 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: libero required: true schema: type: string - in: path name: code description: 'The code of the voucher to be redeemed.' example: assumenda 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: []