REST API for Oracle Loyalty Cloud

Update a voucher

patch

/crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/vouchers/{VoucherNumber}

Request

Path Parameters

MemberNumber(required): string

The member number. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute.
VoucherNumber(required): string

The alternative way to identify a voucher. The UI shows the voucher number but the VoucherNumber attribute is used in the URI to update a voucher record using the resource. The VoucherNumber attribute can also be used as a parameter for the validateVoucherFinder finder. There is no default value, dependency, or limitation associated with this attribute.

Header Parameters

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

application/json

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

ActionNote: string

Title: Action Note

Maximum Length: 1000

The attribute indicates additional information pertaining to a voucher action for which the voucher was created. There is no default value or limitation associated with this attribute.
ActivityDate: string

The date used by Oracle Loyalty Cloud to fetch a valid voucher for a given activity date. The ActivityDate attribute is a parameter used in the availableVoucherFinder and the validateVoucherFinder finders. There is no default value, dependency, or limitation associated with this attribute.
BasisCode: string

Title: Voucher Basis

Maximum Length: 30

This is a FND lookup value. To get the possible input values, the user needs to first invoke corresponding lovResourcepath URL: ../crmRestApi/resources/11.12.0.0/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_BASIS There is no default value, dependency, or limitation associated with this attribute.
CurcyExchDt: string (date)

Title: Currency Exchange Date

The currency exchange date associated with the voucher. There is no default value, dependency, or limitation associated with this attribute.
CurrencyAmount: number

Title: Voucher Discount Value

The currency amount which signifies the value of the voucher based on currency. There is no default value, dependency, nor limitation associated with this attribute.
CurrencyCode: string

Title: Currency Code

Maximum Length: 15

The currency code associated with the voucher. There is no default value, dependency, or limitation associated with this attribute.
ExpirationDt: string (date-time)

Title: Expiration Date

The expiration date of the voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or the attribute value can be provided as an input when creating a voucher using the resource. There is no default value, dependency, or limitation associated with this attribute.
InvOrgId: integer (int64)

Title: Inventory Organization ID

The unique identifier of the organization that provides the inventory when the user is redeeming the vouchers. There is no default value, dependency, or limitation associated with this attribute.
LoyMemVchrId: integer (int64)

Title: Voucher ID

The primary key identifier which signifies unique value for a generated voucher record. There is no default value, dependency, nor limitation associated with this attribute.
MemberId: integer (int64)

Title: Member ID

The primary key of the member to whom the voucher is assigned. There is no default value, dependency, or limitation associated with this attribute.
MemberNumber: string

Title: Member Number

The member number of the loyaltyMember attribute to whom the voucher is assigned. The MemberNumber attribute is used when assigning a voucher or creating a voucher using the resource. The MemberNumber attribute is also used as a parameter in the availableVoucherFinder finder. There is no default value or dependency associated with this attribute.
OrganizationCode: string

Title: Organization Code

Maximum Length: 18

The organization code associated with the member voucher. There is no default value, dependency, or limitation associated with this attribute.
ProductNumber: string

Title: Product Number

The identifier of the product for an existing voucher, that is used for specifying product information. There is no default value, dependency, or limitation associated with this attribute.
Quantity: number

Title: Quantity

Default Value: 1

The voucher quantity which shows how many vouchers are assigned by the transaction processing. There is no default value or limitation associated with this attribute.
StatusCode: string

Title: Status

Maximum Length: 30

Default Value: ORA_VOUC_STATUS_AVLBL

The attribute indicates the status of the voucher. The accepted values can be obtained by invoking fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_STATUS. The StatusCode attribute can be changed from ORA_VOUC_STATUS_AVLBL to ORA_VOUC_STATUS_USED only through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.
TxnItemId: integer (int64)

Title: Transaction Item ID

The transaction item identifier which signifies the transaction identifier assigned while processing the transaction. There is no default value, dependency, nor limitation associated with this attribute.
UsedDt: string (date-time)

Title: Used Date

The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.
validFlag: boolean

The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.
VchrBasisCode: string

Title: Discount Type

Maximum Length: 30

The attribute indicates the discount type that the voucher offers. Accepted values are ORA_VOUC_BASIS_ABSOLUTE or ORA_VOUC_BASIS_PERCENTAGE. It is provided as input from a user when creating the voucher. There is no default value, dependency, or limitation associated with this attribute.
VoucherDiscountValue: number

Title: Voucher Discount Value

The voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, then the value of discount must be a positive integer. This value is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute.
VoucherEffectiveStartDt: string (date)

Title: Start Date

The date when the voucher is in effect. This date is assigned during an Assign Voucher action or when the voucher is created using the resource. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "UsedDt":{
            "title":"Used Date",
            "type":"string",
            "description":"The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true
        },
        "InvOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the organization that provides the inventory when the user is redeeming the vouchers. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LoyMemVchrId":{
            "title":"Voucher ID",
            "type":"integer",
            "description":"The primary key identifier which signifies unique value for a generated voucher record. There is no default value, dependency, nor limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ActivityDate":{
            "type":"string",
            "description":"The date used by Oracle Loyalty Cloud to fetch a valid voucher for a given activity date. The ActivityDate attribute is a parameter used in the availableVoucherFinder and the validateVoucherFinder finders. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "validFlag":{
            "type":"boolean",
            "description":"The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "ExpirationDt":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or the attribute value can be provided as an input when creating a voucher using the resource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The voucher quantity which shows how many vouchers are assigned by the transaction processing. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "default":1
        },
        "TxnItemId":{
            "title":"Transaction Item ID",
            "type":"integer",
            "description":"The transaction item identifier which signifies the transaction identifier assigned while processing the transaction. There is no default value, dependency, nor limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProductNumber":{
            "title":"Product Number",
            "type":"string",
            "description":"The identifier of the product for an existing voucher, that is used for specifying product information. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VchrBasisCode":{
            "title":"Discount Type",
            "maxLength":30,
            "type":"string",
            "description":"The attribute indicates the discount type that the voucher offers. Accepted values are ORA_VOUC_BASIS_ABSOLUTE or ORA_VOUC_BASIS_PERCENTAGE. It is provided as input from a user when creating the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VoucherEffectiveStartDt":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the voucher is in effect. This date is assigned during an Assign Voucher action or when the voucher is created using the resource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The attribute indicates the status of the voucher. The accepted values can be obtained by invoking fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_STATUS. The StatusCode attribute can be \nchanged from ORA_VOUC_STATUS_AVLBL to ORA_VOUC_STATUS_USED only through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":"ORA_VOUC_STATUS_AVLBL",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurcyExchDt":{
            "title":"Currency Exchange Date",
            "type":"string",
            "description":"The currency exchange date associated with the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true
        },
        "CurrencyAmount":{
            "title":"Voucher Discount Value",
            "type":"number",
            "description":"The currency amount which signifies the value of the voucher based on currency. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":true
        },
        "BasisCode":{
            "title":"Voucher Basis",
            "maxLength":30,
            "type":"string",
            "description":"This is a FND lookup value. To get the possible input values, the user needs to first invoke corresponding lovResourcepath URL: ../crmRestApi/resources/11.12.0.0/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_BASIS\nThere is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The primary key of the member to whom the voucher is assigned. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MemberNumber":{
            "title":"Member Number",
            "type":"string",
            "description":"The member number of the loyaltyMember attribute to whom the voucher is assigned. The MemberNumber attribute is used when assigning a voucher or creating a voucher using the resource. The MemberNumber attribute is also used as a parameter in the availableVoucherFinder finder. There is no default value or dependency associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActionNote":{
            "title":"Action Note",
            "maxLength":1000,
            "type":"string",
            "description":"The attribute indicates additional information pertaining to a voucher action for which the voucher was created. There is no default value or limitation associated with this attribute.",
            "nullable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "maxLength":18,
            "type":"string",
            "description":"The organization code associated with the member voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VoucherDiscountValue":{
            "title":"Voucher Discount Value",
            "type":"number",
            "description":"The voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, then the value of discount must be a positive integer. This value is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute.",
            "nullable":true
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context(required):

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : loyMembers-vouchers-item-response

Type: object

Show Source

ActionNote: string

Title: Action Note

Maximum Length: 1000

The attribute indicates additional information pertaining to a voucher action for which the voucher was created. There is no default value or limitation associated with this attribute.
ActivityDate: string

The date used by Oracle Loyalty Cloud to fetch a valid voucher for a given activity date. The ActivityDate attribute is a parameter used in the availableVoucherFinder and the validateVoucherFinder finders. There is no default value, dependency, or limitation associated with this attribute.
Basis: string

Title: Voucher Basis Meaning

Read Only: true

Maximum Length: 80

The list of value meaning for the Basis code. There is no default value or limitation associated with this attribute.
BasisCode: string

Title: Voucher Basis

Maximum Length: 30

This is a FND lookup value. To get the possible input values, the user needs to first invoke corresponding lovResourcepath URL: ../crmRestApi/resources/11.12.0.0/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_BASIS There is no default value, dependency, or limitation associated with this attribute.
ConsumedTransactionNumber: string

Title: Redeemed Transaction Number

Maximum Length: 30

The transaction number that used this voucher. There is no default value, dependency, or limitation associated with this attribute.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The details of who created the voucher. Oracle Loyalty Cloud generates this attribute value during the creation of a new voucher. There is no default value, dependency, or limitation associated with this attribute.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date when the voucher was created. Oracle Loyalty Cloud generates this attribute value during the creation of a new voucher. There is no default value, dependency, or limitation associated with this attribute.
CurcyExchDt: string (date)

Title: Currency Exchange Date

The currency exchange date associated with the voucher. There is no default value, dependency, or limitation associated with this attribute.
CurrencyAmount: number

Title: Voucher Discount Value

The currency amount which signifies the value of the voucher based on currency. There is no default value, dependency, nor limitation associated with this attribute.
CurrencyCode: string

Title: Currency Code

Maximum Length: 15

The currency code associated with the voucher. There is no default value, dependency, or limitation associated with this attribute.
Description: string

Title: Type

Read Only: true

Maximum Length: 240

The product description for the voucher. The user enters the description of product as the VoucherType, which is displayed as the product description on the Loyalty Voucher UI page. Oracle Loyalty Cloud assigns the ProdId attribute value with the identifier of the product when the user inputs the product description. There is no default value, dependency, or limitation associated with this attribute.
DiscountValue: string

Read Only: true

The voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, then the value of discount must be a positive integer. This value is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute.
ExpirationDt: string (date-time)

Title: Expiration Date

The expiration date of the voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or the attribute value can be provided as an input when creating a voucher using the resource. There is no default value, dependency, or limitation associated with this attribute.
InvOrgId: integer (int64)

Title: Inventory Organization ID

The unique identifier of the organization that provides the inventory when the user is redeeming the vouchers. There is no default value, dependency, or limitation associated with this attribute.
LastUpdateDate: string (date-time)

Title: Change Date

Read Only: true

The date when the voucher was last updated. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the voucher. There is no default value, dependency, or limitation associated with this attribute.
LastUpdatedBy: string

Title: Changed By

Read Only: true

Maximum Length: 64

The user who last updated the voucher. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the voucher. There is no default value, dependency, or limitation associated with this attribute.
links: array Links

Title: Links

The link relations associated with the resource instance.
LoyMemVchrId: integer (int64)

Title: Voucher ID

The primary key identifier which signifies unique value for a generated voucher record. There is no default value, dependency, nor limitation associated with this attribute.
MemberId: integer (int64)

Title: Member ID

The primary key of the member to whom the voucher is assigned. There is no default value, dependency, or limitation associated with this attribute.
MemberNumber: string

Title: Member Number

The member number of the loyaltyMember attribute to whom the voucher is assigned. The MemberNumber attribute is used when assigning a voucher or creating a voucher using the resource. The MemberNumber attribute is also used as a parameter in the availableVoucherFinder finder. There is no default value or dependency associated with this attribute.
Name: string

Title: Promotion

Read Only: true

Maximum Length: 50

The attribute indicates the name of the promotion for which the voucher was created. There is no default value, dependency, or limitation associated with this attribute.
OrganizationCode: string

Title: Organization Code

Maximum Length: 18

The organization code associated with the member voucher. There is no default value, dependency, or limitation associated with this attribute.
OriginalVoucherNumber: string

Title: Original Voucher Number

Maximum Length: 30

The original voucher number associated with the voucher. There is no default value, dependency, or limitation associated with this attribute.
PrConId: integer (int64)

Title: Primary Contact ID

Read Only: true

The attribute indicates the primary contact identifier of the member for whom the voucher was created. There is no default value, dependency, or limitation associated with this attribute.
ProductNumber: string

Title: Product Number

The identifier of the product for an existing voucher, that is used for specifying product information. There is no default value, dependency, or limitation associated with this attribute.
PromotionNumber: string

Title: Promotion Number

Maximum Length: 30

The promotion number that was applied to the transaction during transaction processing and that created this voucher.There is no default value, dependency, or limitation associated with this attribute.
Quantity: number

Title: Quantity

Default Value: 1

The voucher quantity which shows how many vouchers are assigned by the transaction processing. There is no default value or limitation associated with this attribute.
StatusCode: string

Title: Status

Maximum Length: 30

Default Value: ORA_VOUC_STATUS_AVLBL

The attribute indicates the status of the voucher. The accepted values can be obtained by invoking fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_STATUS. The StatusCode attribute can be changed from ORA_VOUC_STATUS_AVLBL to ORA_VOUC_STATUS_USED only through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.
StatusMeaning: string

Title: Voucher Status Meaning

Read Only: true

Maximum Length: 80

The voucher status meaning which shows the voucher status as follows: Available, Expired, Used, and so on. There is no default value, dependency, nor limitation associated with this attribute.
TxnId: integer (int64)

Title: Transaction ID

Read Only: true

The transaction Identifier which led to the assignment of loyalty vouchers due to transaction processing. There is no default value or limitation associated with this attribute.
TxnItemId: integer (int64)

Title: Transaction Item ID

The transaction item identifier which signifies the transaction identifier assigned while processing the transaction. There is no default value, dependency, nor limitation associated with this attribute.
TxnNum: string

Title: Transaction Number

Read Only: true

Maximum Length: 30

The transaction number that shows the transaction processing that has assigned this voucher to member. There is no default value or limitation associated with this attribute.
UsedDt: string (date-time)

Title: Used Date

The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.
validFlag: boolean

The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.
VchrBasis: string

Title: Discount Type Meaning

Read Only: true

Maximum Length: 80

The list of value meaning for the voucher basis code, which signifies whether the voucher is absolute or percentage based. There is no default value, dependency, nor limitation associated with this attribute.
VchrBasisCode: string

Title: Discount Type

Maximum Length: 30

The attribute indicates the discount type that the voucher offers. Accepted values are ORA_VOUC_BASIS_ABSOLUTE or ORA_VOUC_BASIS_PERCENTAGE. It is provided as input from a user when creating the voucher. There is no default value, dependency, or limitation associated with this attribute.
VoucherDiscountValue: number

Title: Voucher Discount Value

The voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, then the value of discount must be a positive integer. This value is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute.
VoucherEffectiveStartDt: string (date)

Title: Start Date

The date when the voucher is in effect. This date is assigned during an Assign Voucher action or when the voucher is created using the resource. There is no default value, dependency, or limitation associated with this attribute.
VoucherNumber: string

Title: Voucher Number

Maximum Length: 30

The alternative way to identify a voucher. The UI shows the voucher number but the VoucherNumber attribute is used in the URI to update a voucher record using the resource. The VoucherNumber attribute can also be used as a parameter for the validateVoucherFinder finder. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the voucher was created. Oracle Loyalty Cloud generates this attribute value during the creation of a new voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumedTransactionNumber":{
            "title":"Redeemed Transaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The transaction number that used this voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "UsedDt":{
            "title":"Used Date",
            "type":"string",
            "description":"The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Type",
            "maxLength":240,
            "type":"string",
            "description":"The product description for the voucher. The user enters the description of product as the VoucherType, which is displayed as the product description on the Loyalty Voucher UI page. Oracle Loyalty Cloud assigns the ProdId attribute value with the identifier of the product when the user inputs the product description. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InvOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the organization that provides the inventory when the user is redeeming the vouchers. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "validFlag":{
            "type":"boolean",
            "description":"The date when a valid voucher that is available is changed to the Used status. This date gets assigned when the voucher status is changed from Available to Used status through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "ExpirationDt":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or the attribute value can be provided as an input when creating a voucher using the resource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "VoucherEffectiveStartDt":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the voucher is in effect. This date is assigned during an Assign Voucher action or when the voucher is created using the resource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The attribute indicates the status of the voucher. The accepted values can be obtained by invoking fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_STATUS. The StatusCode attribute can be \nchanged from ORA_VOUC_STATUS_AVLBL to ORA_VOUC_STATUS_USED only through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":"ORA_VOUC_STATUS_AVLBL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Promotion",
            "maxLength":50,
            "type":"string",
            "description":"The attribute indicates the name of the promotion for which the voucher was created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Basis":{
            "title":"Voucher Basis Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The list of value meaning for the Basis code. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The primary key of the member to whom the voucher is assigned. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TxnId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The transaction Identifier which led to the assignment of loyalty vouchers due to transaction processing. There is no default value or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VchrBasis":{
            "title":"Discount Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The list of value meaning for the voucher basis code, which signifies whether the voucher is absolute or percentage based. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberNumber":{
            "title":"Member Number",
            "type":"string",
            "description":"The member number of the loyaltyMember attribute to whom the voucher is assigned. The MemberNumber attribute is used when assigning a voucher or creating a voucher using the resource. The MemberNumber attribute is also used as a parameter in the availableVoucherFinder finder. There is no default value or dependency associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActionNote":{
            "title":"Action Note",
            "maxLength":1000,
            "type":"string",
            "description":"The attribute indicates additional information pertaining to a voucher action for which the voucher was created. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "maxLength":18,
            "type":"string",
            "description":"The organization code associated with the member voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VoucherDiscountValue":{
            "title":"Voucher Discount Value",
            "type":"number",
            "description":"The voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, then the value of discount must be a positive integer. This value is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Changed By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the voucher. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalVoucherNumber":{
            "title":"Original Voucher Number",
            "maxLength":30,
            "type":"string",
            "description":"The original voucher number associated with the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The details of who created the voucher. Oracle Loyalty Cloud generates this attribute value during the creation of a new voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrConId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The attribute indicates the primary contact identifier of the member for whom the voucher was created. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LoyMemVchrId":{
            "title":"Voucher ID",
            "type":"integer",
            "description":"The primary key identifier which signifies unique value for a generated voucher record. There is no default value, dependency, nor limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActivityDate":{
            "type":"string",
            "description":"The date used by Oracle Loyalty Cloud to fetch a valid voucher for a given activity date. The ActivityDate attribute is a parameter used in the availableVoucherFinder and the validateVoucherFinder finders. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "VoucherNumber":{
            "title":"Voucher Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternative way to identify a voucher. The UI shows the voucher number but the VoucherNumber attribute is used in the URI to update a voucher record using the resource. The VoucherNumber attribute can also be used as a parameter for the validateVoucherFinder finder. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The voucher quantity which shows how many vouchers are assigned by the transaction processing. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "default":1,
            "x-queryable":true
        },
        "TxnItemId":{
            "title":"Transaction Item ID",
            "type":"integer",
            "description":"The transaction item identifier which signifies the transaction identifier assigned while processing the transaction. There is no default value, dependency, nor limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "title":"Product Number",
            "type":"string",
            "description":"The identifier of the product for an existing voucher, that is used for specifying product information. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VchrBasisCode":{
            "title":"Discount Type",
            "maxLength":30,
            "type":"string",
            "description":"The attribute indicates the discount type that the voucher offers. Accepted values are ORA_VOUC_BASIS_ABSOLUTE or ORA_VOUC_BASIS_PERCENTAGE. It is provided as input from a user when creating the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurcyExchDt":{
            "title":"Currency Exchange Date",
            "type":"string",
            "description":"The currency exchange date associated with the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyAmount":{
            "title":"Voucher Discount Value",
            "type":"number",
            "description":"The currency amount which signifies the value of the voucher based on currency. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "BasisCode":{
            "title":"Voucher Basis",
            "maxLength":30,
            "type":"string",
            "description":"This is a FND lookup value. To get the possible input values, the user needs to first invoke corresponding lovResourcepath URL: ../crmRestApi/resources/11.12.0.0/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_BASIS\nThere is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Voucher Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The voucher status meaning which shows the voucher status as follows: Available, Expired, Used, and so on. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionNumber":{
            "title":"Promotion Number",
            "maxLength":30,
            "type":"string",
            "description":"The promotion number that was applied to the transaction during transaction processing and that created this voucher.There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "TxnNum":{
            "title":"Transaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The transaction number that shows the transaction processing that has assigned this voucher to member. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DiscountValue":{
            "type":"string",
            "description":"The voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, then the value of discount must be a positive integer. This value is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Change Date",
            "type":"string",
            "description":"The date when the voucher was last updated. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

Allowed Values: [ "collection", "item", "describe", "other" ]

The kind of the related resource.
name: string

Title: name

The name of the link to the related resource.
properties: object properties
rel: string

Title: relation

Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

BasisCodeLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_BASIS

The list of basis codes for a loyalty voucher.

The following properties are defined on the LOV link relation:

Source Attribute: BasisCode; Target Attribute: LookupCode
Display Attribute: Meaning

MemberVO2

Operation: /crmRestApi/resources/11.13.18.05/loyMembers

Parameters:

finder: MemNumSearch%3BMemberNumber%3D{MemberNumber}

The list of member numbers for a loyalty voucher.

The following properties are defined on the LOV link relation:

Source Attribute: MemberNumber; Target Attribute: MemberNumber
Display Attribute: MemberNumber

SalesCatalogProductProgPVO1

Operation: /crmRestApi/resources/11.13.18.05/products

Parameters:

finder: ProductList

The list of products for a loyalty vouchers.

The following properties are defined on the LOV link relation:

Source Attribute: ProductNumber; Target Attribute: ProductNum
Display Attribute: ProductNum, InventoryItemId, InvOrgId

SatusCodeLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_STATUS%2CBindLookupCode%3D{StatusCode}

The list of statuses for a loyalty voucher.

The following properties are defined on the LOV link relation:

Source Attribute: StatusCode; Target Attribute: LookupCode
Display Attribute: Meaning

VoucherBasisLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_VOUC_DISCOUNT_TYPE%2CBindLookupCode%3D{BasisCode}

The list of voucher basis codes for a loyalty voucher.

The following properties are defined on the LOV link relation:

Source Attribute: VchrBasisCode; Target Attribute: LookupCode
Display Attribute: Meaning