---
title: "Voucher"
url: "https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c/schemas/Voucher"
---

> Full API specification: https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c.md

# Voucher

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Retail Express API
  version: v2.1
servers:
  - url: https://api.retailexpress.com.au/v2.1
components:
  schemas:
    VoucherTypeLimited:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Voucher type Id.
          format: int32
          nullable: true
        name:
          type: string
          description: Voucher name
          nullable: true
      additionalProperties: false
    OrderLimited:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Order Id.
          format: int32
          nullable: true
        customer:
          $ref: "#/components/schemas/CustomerLimited"
        order_number:
          type: string
          description: The Order identifier in Retail Express.
          nullable: true
        original_order_id:
          type: integer
          description: Original Order Id.
          format: int32
          nullable: true
        created_on:
          type: string
          description: Created on
          format: date-time
        vouchers:
          type: array
          items:
            $ref: "#/components/schemas/OrderVoucher"
          description: Vouchers.
          nullable: true
      additionalProperties: false
    CustomerLimited:
      title: ""
      type: object
      properties:
        customer_number:
          type: string
          description: Customer number
          nullable: true
        email:
          type: string
          description: Email
          nullable: true
        first_name:
          type: string
          description: First name
          nullable: true
        id:
          type: integer
          description: Identifier
          format: int32
        last_name:
          type: string
          description: Last name
          nullable: true
        custom_reference:
          type: string
          description: Custom reference
          nullable: true
      additionalProperties: false
    OrderVoucher:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Voucher Id.
          format: int32
          nullable: true
        code:
          type: string
          description: Voucher code
          nullable: true
        type:
          $ref: "#/components/schemas/VoucherVoucherType"
        initial_value:
          type: number
          description: Initial value
          format: double
          nullable: true
        balance:
          type: number
          description: Balance
          format: double
          nullable: true
        created_on:
          type: string
          description: Created on
          format: date-time
        expires_on:
          type: string
          description: Modified on
          format: date-time
          nullable: true
      additionalProperties: false
    VoucherVoucherType:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Voucher type Id.
          format: int32
          nullable: true
        name:
          type: string
          description: Voucher type code
          nullable: true
      additionalProperties: false
    Voucher:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Voucher Id.
          format: int32
          nullable: true
        code:
          type: string
          description: Voucher code
          nullable: true
        type:
          $ref: "#/components/schemas/VoucherTypeLimited"
        initial_value:
          type: number
          description: Initial value
          format: double
          nullable: true
        balance:
          type: number
          description: Balance
          format: double
          nullable: true
        created_on:
          type: string
          description: Created on
          format: date-time
        expires_on:
          type: string
          description: Modified on
          format: date-time
          nullable: true
        order:
          $ref: "#/components/schemas/OrderLimited"
      additionalProperties: false
```