Title: Validate Coupon Code - response schema Provides details for the requested coupon code. Version 1.0 : 2016-04-02. Initial schema creation. The Name of the API service action The Id of the API service action The message text. The code associated with the message. Flag indicating whether the process completed without errors. The coupon name. Where available, the reporting code assigned to the coupon. For Voucher type coupons only, and where 'generateusing' is set to 'IncrementNumberSeries', the name of the number series to be used when generating new codes. For Voucher type coupons only, and where 'generateusing' is set to 'Mask', the mask to be used for generating codes. Masks can contain constants and replacement characters - where replacement characters support the insertion of randomized alphanumeric, numeric or special characters. The number of codes that are defined for the coupon. The number of promotions which may issue a code for the coupon (for Voucher type coupons only). The number of promotions which may redeem a code for the coupon. Flag indicating whether uses for codes of the coupon will be tracked and the code use locked until the transaction is confirmed, or the lock release time is exceeded. Where locks are in use - the time in minutes that a lock for a code will be held since the most recent submission. Where available, the number of times the code has been confirmed as utilized against a basket. Where locks are in use - the count of locks currently active for the code. The coupon code The status of the coupon code. 'CREATED' and 'ISSUED' statuses are only supported for Voucher type coupon codes. The code (for a source code) is ACTIVE The code (for a Voucher) has been CREATED The code (for a Voucher) has been ISSUED The code has been fully utilized and is REDEEMED The code has EXPIRED The code has been WITHDRAWN The code has been RESERVED The date and time from which the coupon code is valid for utilization by promotions. The date and time after which the coupon code is no longer valid for utilization by promotions. Where applicable, the maximum number of times the coupon code may be utilized by promotions. For Voucher type coupon codes, the date and time when the code was issued. For Voucher type coupon codes, the process which issued the code. For Voucher type coupon codes and where available, the id for the basket against which the voucher code was issued. For Voucher type coupon codes and where available, the store attribute value provided with the basket against which the voucher code was issued. Where the code has been withdrawn, the date when the withdrawal took place. Where the code has been withdrawn, the name of the user who withdrew the code. Flag indicating whether the code is available for use with promotions, based on current uses of the code and the current date and time. Where the voucher was issued by a promotion against a basket, the customer reference/id from the basket. The coupon type. The allocated import/export key for the coupon. For Voucher type coupons only, the method used to generate new codes. Voucher code generation type not specified, a GUID will be used Voucher codes will be generated using a GUID Voucher codes will be generated using an incrementing number series Mask For Voucher type coupons only, a flag indicating whether codes can be automatically generated for the coupon, at the point when they are to be issued, where no unissued codes are available. For voucher type campaign/coupons, the maximum uses to be used for new codes when generating. For Voucher type coupons only, a flag indicating whether codes may only be issued but never redeemed. This configuration is typically used for integration with third party systems where those systems will redeem the codes. For Voucher type coupons only, the validity period type to be used for codes at the point when they are issued. Issued codes for this voucher do not have a validity period, they will always be valid Issued codes for this voucher will always be valid Issued codes for this voucher will be valid between the dates specified Codes for this voucher will be valid for the specified number of hours from the time of issue Codes for this voucher will be valid for the specified number of days from the time of issue Codes for this voucher will be valid for the specified number of weeks from the time of issue Codes for this voucher will be valid for the specified number of months from the time of issue Codes for this voucher will be valid for the specified number of years from the time of issue Codes for this voucher will be valid until the end of the day of issue Codes for this voucher will be valid until the end of the week in which they were issued Codes for this voucher will be valid until the end of the month in which they were issued Codes for this voucher will be valid until the end of the year in which they were issued For Voucher type coupons only, where applicable the value to be used for the period type for codes at the point when they are issued. For Voucher type coupons only, where applicable the valid from date and time of codes to be assigned at the point when they are issued. For Voucher type coupons only, where applicable the valid to date and time of codes to be assigned at the point when they are issued.