Jump to

• Request
• Response
• Examples

Create a loyalty voucher (Deprecated)

post

/crmRestApi/resources/11.13.18.05/loyaltyVouchers

Request

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.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• 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.
• CurrencyAmount: number
  Title: Currency Amount

  The currency value of the voucher if the DiscountType attribute is set to Absolute Value. This value is provided by the user when creating a voucher and is required if the voucher is of type Absolute Value. This attribute depends up on the DiscountType attribute setting. There is no default value or limitation associated with this attribute.
• DiscountType: string
  Title: Discount Type

  The discount type that the voucher offers. A voucher discount can be set to Percentage or Absolute Value. It is provided as input from a user when creating 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.
• LoyMemVchrId: integer (int64)
  Title: Member Voucher ID

  The primary key to identify a voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action. There is no default value, dependency, or limitation associated with this attribute.
• MemberId: integer (int64)
  Title: Member ID

  The identity of a member for the assigned voucher. Oracle Loyalty Cloud assigns this attribute value when it assigns a voucher action or the attribute value can be set indirectly by deriving MemberId from the MemberNumber attribute which is input when creating voucher using the resource. 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.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The voucher object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
• ProdId: integer (int64)
  The identifier of the product for an existing voucher. Although its not a best practice to expose the identifier of a product, this attribute is used for building mobile UIs and drop downs, and provides information on the product that is in use. This value cannot be set through the Oracle Loyally Cloud UI. To specify product information, use Voucher Type as input while creating the voucher. There is no default value, dependency, or limitation associated with this attribute.
• Quantity: number
  Title: Quantity

  Default Value: 1

  The quantity of vouchers that are assigned to a member. The value is a positive integer. There is no default value, dependency, 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
  This flag returns true if the voucherStatus attribute is set to Available and its ActivityDate attribute falls in between the voucherEffectiveStartDt and ExpirationDt attributes. This is a calculated field which shows the validity of the voucher. There is no default value, dependency, or limitation associated with this attribute.
• VoucherBasis: string
  Title: Voucher Basis

  The voucher assignment based on the transaction type. Oracle Loyalty Cloud sets it to Accrual for accrual type transactions and Redemption for redemption type of transactions. This is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute.
• VoucherDiscountValue: number
  Title: Discount Percentage

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

  The date when the voucher is effective. This date is assigned during an assign voucher action or when voucher is created using the resource.
• VoucherNumber: string
  Title: Voucher Number

  Maximum Length: 30

  The alternative way to identify a voucher. The UI shows 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 parameter for the validateVoucherFinder finder. There is no default value, dependency, or limitation associated with this attribute.
• voucherStatus: string
  Title: Voucher Status

  The text that defines the voucher status. A list of accepted values are Available, Expired or Used. The VoucherStatus attribute can be changed from Available to Used only through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.
• VoucherType: string
  Title: Voucher Type

  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.

{
    "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 \nchanged 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
        },
        "LoyMemVchrId":{
            "title":"Member Voucher ID",
            "type":"integer",
            "description":"The primary key to identify a voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action. There is no default value, dependency, or 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 \nin the availableVoucherFinder and the validateVoucherFinder finders. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true
        },
        "validFlag":{
            "type":"boolean",
            "description":"This flag returns true if the voucherStatus attribute is set to Available and its ActivityDate attribute falls in between the \nvoucherEffectiveStartDt and ExpirationDt attributes. This is a calculated field which shows the validity of the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true
        },
        "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
        },
        "VoucherNumber":{
            "title":"Voucher Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternative way to identify a voucher. The UI shows 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 parameter for the validateVoucherFinder finder. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of vouchers that are assigned to a member. The value is a positive integer. There is no default value, dependency, or \nlimitation associated with this attribute.",
            "nullable":true,
            "default":1
        },
        "ProdId":{
            "type":"integer",
            "description":"The identifier of the product for an existing voucher. Although its not a best practice to expose the identifier of a product, this attribute is used for building mobile UIs and drop downs, and provides information on the product that is in use. This value cannot be set through the Oracle Loyally Cloud UI. To specify product information, use Voucher Type as input while creating the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CurrencyAmount":{
            "title":"Currency Amount",
            "type":"number",
            "description":"The currency value of the voucher if the DiscountType attribute is set to Absolute Value. This value is provided by the user when creating a voucher and is required if the voucher is of type Absolute Value. This attribute depends up on the DiscountType attribute setting. There is no default value or limitation associated with this attribute.",
            "nullable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The identity of a member for the assigned voucher. Oracle Loyalty Cloud assigns this attribute value when it assigns a voucher action or the attribute value can be set indirectly by deriving MemberId from the MemberNumber attribute which is input when creating voucher using the resource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "voucherStatus":{
            "title":"Voucher Status",
            "type":"string",
            "description":"The text that defines the voucher status. A list of accepted values are Available, Expired or Used. The VoucherStatus attribute can be \nchanged from Available to Used only through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The voucher object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "DiscountType":{
            "title":"Discount Type",
            "type":"string",
            "description":"The discount type that the voucher offers. A voucher discount can be set to Percentage or Absolute Value. It is provided as input from a \nuser when creating the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VoucherBasis":{
            "title":"Voucher Basis",
            "type":"string",
            "description":"The voucher assignment based on the transaction type. Oracle Loyalty Cloud sets it to Accrual for accrual type transactions and \nRedemption for redemption type of transactions. This 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":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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 \nassigning 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"
            }
        },
        "VoucherDiscountValue":{
            "title":"Discount Percentage",
            "type":"number",
            "description":"The voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, the value of discount must be a positive \ninteger. This value is provided as input value from a user when creating the voucher. There is no default value or limitation associated with this attribute.",
            "nullable":true
        },
        "voucherEffectiveStartDt":{
            "title":"Voucher Effective Start Date",
            "type":"string",
            "description":"The date when the voucher is effective. This date is assigned during an assign voucher action or when voucher is created using the \nresource.",
            "format":"date",
            "nullable":true
        },
        "VoucherType":{
            "title":"Voucher Type",
            "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,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : loyaltyVouchers-item-response

Type: object

Show Source

• 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.
• CurrencyAmount: number
  Title: Currency Amount

  The currency value of the voucher if the DiscountType attribute is set to Absolute Value. This value is provided by the user when creating a voucher and is required if the voucher is of type Absolute Value. This attribute depends up on the DiscountType attribute setting. There is no default value or limitation associated with this attribute.
• DiscountType: string
  Title: Discount Type

  The discount type that the voucher offers. A voucher discount can be set to Percentage or Absolute Value. It is provided as input from a user when creating 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyMemVchrId: integer (int64)
  Title: Member Voucher ID

  The primary key to identify a voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action. There is no default value, dependency, or limitation associated with this attribute.
• MemberId: integer (int64)
  Title: Member ID

  The identity of a member for the assigned voucher. Oracle Loyalty Cloud assigns this attribute value when it assigns a voucher action or the attribute value can be set indirectly by deriving MemberId from the MemberNumber attribute which is input when creating voucher using the resource. 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.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The voucher object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
• ProdId: integer (int64)
  The identifier of the product for an existing voucher. Although its not a best practice to expose the identifier of a product, this attribute is used for building mobile UIs and drop downs, and provides information on the product that is in use. This value cannot be set through the Oracle Loyally Cloud UI. To specify product information, use Voucher Type as input while creating the voucher. There is no default value, dependency, or limitation associated with this attribute.
• Quantity: number
  Title: Quantity

  Default Value: 1

  The quantity of vouchers that are assigned to a member. The value is a positive integer. There is no default value, dependency, or limitation associated with this attribute.
• TransactionId: integer (int64)
  Title: Loyalty Transaction ID

  Read Only: true

  The transaction identifier of the transaction. This attribute is the primary key identifier for a loyalty transaction. This loyalty transaction is shown as read-only child of the vouchers resource. There is no default value, dependency, or limitation associated with this attribute.
• TransactionNumber: string
  Title: Transaction Number

  Read Only: true

  Maximum Length: 30

  The transaction number of the transaction. This is an alternative identifier for a transaction, and is displayed in the Oracle Loyalty Cloud UI. There is no default value, dependency, 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
  This flag returns true if the voucherStatus attribute is set to Available and its ActivityDate attribute falls in between the voucherEffectiveStartDt and ExpirationDt attributes. This is a calculated field which shows the validity of the voucher. There is no default value, dependency, or limitation associated with this attribute.
• VoucherBasis: string
  Title: Voucher Basis

  The voucher assignment based on the transaction type. Oracle Loyalty Cloud sets it to Accrual for accrual type transactions and Redemption for redemption type of transactions. This is provided as an input value from a user when creating the voucher. There is no default value or limitation associated with this attribute.
• VoucherDiscountValue: number
  Title: Discount Percentage

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

  The date when the voucher is effective. This date is assigned during an assign voucher action or when voucher is created using the resource.
• VoucherNumber: string
  Title: Voucher Number

  Maximum Length: 30

  The alternative way to identify a voucher. The UI shows 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 parameter for the validateVoucherFinder finder. There is no default value, dependency, or limitation associated with this attribute.
• voucherStatus: string
  Title: Voucher Status

  The text that defines the voucher status. A list of accepted values are Available, Expired or Used. The VoucherStatus attribute can be changed from Available to Used only through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.
• VoucherType: string
  Title: Voucher Type

  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.

{
    "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 \nchanged 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
        },
        "TransactionNumber":{
            "title":"Transaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The transaction number of the transaction. This is an alternative identifier for a  transaction, and is displayed in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyMemVchrId":{
            "title":"Member Voucher ID",
            "type":"integer",
            "description":"The primary key to identify a voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action. There is no default value, dependency, or 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 \nin the availableVoucherFinder and the validateVoucherFinder finders. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "validFlag":{
            "type":"boolean",
            "description":"This flag returns true if the voucherStatus attribute is set to Available and its ActivityDate attribute falls in between the \nvoucherEffectiveStartDt and ExpirationDt attributes. This is a calculated field which shows the validity of the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "VoucherNumber":{
            "title":"Voucher Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternative way to identify a voucher. The UI shows 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 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 quantity of vouchers that are assigned to a member. The value is a positive integer. There is no default value, dependency, or \nlimitation associated with this attribute.",
            "nullable":true,
            "default":1,
            "x-queryable":true
        },
        "ProdId":{
            "type":"integer",
            "description":"The identifier of the product for an existing voucher. Although its not a best practice to expose the identifier of a product, this attribute is used for building mobile UIs and drop downs, and provides information on the product that is in use. This value cannot be set through the Oracle Loyally Cloud UI. To specify product information, use Voucher Type as input while creating the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyAmount":{
            "title":"Currency Amount",
            "type":"number",
            "description":"The currency value of the voucher if the DiscountType attribute is set to Absolute Value. This value is provided by the user when creating a voucher and is required if the voucher is of type Absolute Value. This attribute depends up on the DiscountType attribute setting. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Loyalty Transaction ID",
            "type":"integer",
            "description":"The transaction identifier of the transaction. This attribute is the primary key identifier for a loyalty transaction. This loyalty transaction is shown as read-only child of the vouchers resource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The identity of a member for the assigned voucher. Oracle Loyalty Cloud assigns this attribute value when it assigns a voucher action or the attribute value can be set indirectly by deriving MemberId from the MemberNumber attribute which is input when creating voucher using the resource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "voucherStatus":{
            "title":"Voucher Status",
            "type":"string",
            "description":"The text that defines the voucher status. A list of accepted values are Available, Expired or Used. The VoucherStatus attribute can be \nchanged from Available to Used only through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The voucher object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DiscountType":{
            "title":"Discount Type",
            "type":"string",
            "description":"The discount type that the voucher offers. A voucher discount can be set to Percentage or Absolute Value. It is provided as input from a \nuser when creating the voucher. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VoucherBasis":{
            "title":"Voucher Basis",
            "type":"string",
            "description":"The voucher assignment based on the transaction type. Oracle Loyalty Cloud sets it to Accrual for accrual type transactions and \nRedemption for redemption type of transactions. This 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":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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 \nassigning 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"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VoucherDiscountValue":{
            "title":"Discount Percentage",
            "type":"number",
            "description":"The voucher discount value. If the DiscountType attribute of a voucher is set to Percentage, the value of discount must be a positive \ninteger. This value is provided as 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
        },
        "voucherEffectiveStartDt":{
            "title":"Voucher Effective Start Date",
            "type":"string",
            "description":"The date when the voucher is effective. This date is assigned during an assign voucher action or when voucher is created using the \nresource.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "VoucherType":{
            "title":"Voucher Type",
            "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,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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."
        }
    }
}

Back to Top

Examples

The following example shows how to assign a voucher, Supremo Discount Voucher, to a member with member number 300100111350326 .

Use POST with the following URI syntax to assign the voucher:

https://example.com/crmRestApi/resources/11.13.18.05/loyaltyVouchers

Request Body Example

{
"VoucherType" : "Supremo Discount Voucher",
"MemberNumber": 300100111350326,
"ExpirationDt": "2017-12-12",
"voucherStatus" : "Available",
"Quantity" : 1,
"VoucherBasis" : "Redemption"
}

Example of Response Header

cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -686
content-type -application/vnd.oracle.adf.resourceitem+json
date -Wed, 23 Aug 2017 08:22:27 GMT
etag-"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
keep-alive -timeout=61, max=100
link -<https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyVouchers/300100111425917>;rel="self";kind="item";name="loyaltyVouchers"
location -https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyVouchers/300100111425917
rest-framework-version -1
server -Oracle-HTTP-Server-11g
vary -User-Agent
x-oracle-dms-ecid -005LqTdYea6Fw0GLIys1yf0006cp00031Z

Example of Response Body

{
    "ExpirationDt": "2017-12-12T00:00:00+00:00",
    "MemberId": 300100111350325,
    "LoyMemVchrId": 300100111387918,
    "ProdId": 300100111353118,
    "Quantity": 1,
    "UsedDt": null,
    "voucherEffectiveStartDt": null,
    "VoucherNumber": "300100111387918",
    "validFlag": "false",
    "voucherStatus": "Available",
    "ActivityDate": null,
    "VoucherDiscountValue": null,
    "CurrencyAmount": null,
    "VoucherType": "Supremo Discount Voucher",
    "ObjectVersionNumber": 1,
    "MemberNumber": "300100111350326",
    "DiscountType": null,
    "VoucherBasis": "Redemption",
    "links": [
        {
            "rel": "self",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyVouchers/300100111387918",
            "name": "loyaltyVouchers",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyVouchers/300100111387918",
            "name": "loyaltyVouchers",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyVouchers/300100111387918/lov/MemberPVO1",
            "name": "MemberPVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyVouchers/300100111387918/lov/ProductVO1",
            "name": "ProductVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyVouchers/300100111387918/lov/BasisCodeLookupPVO",
            "name": "BasisCodeLookupPVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyVouchers/300100111387918/lov/VoucherBasisLookupPVO",
            "name": "VoucherBasisLookupPVO",
            "kind": "collection"
        }
    ]
}

Back to Top