Create a voucher (Deprecated)
post
/crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberVouchers
Request
Path Parameters
-
MemberNumber(required): string
The member number. This attribute is an alternative identifier for a member and is displayed in the UI. 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.
-
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
The following table describes the body parameters in the request for this task.
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 : loyaltyMembers-MemberVouchers-item-response
Type:
Show Source
object
-
CurrencyAmount: number
Title:
Currency Amount
Read Only:true
The voucher currency amount for the member voucher. This attribute is dependent on the VoucherDiscountType attribute. If Voucher Discount Type is an absolute value, then the CurrencyAmount attribute displays the absolute value of the voucher. There is no default value. CurrencyAmount is dependent on Voucher Discount Type. There is no limitation associated with this attribute. -
DiscntPct: number
Title:
Discount Percentage
Read Only:true
The voucher discount percent. This attribute is required if the DiscountType attribute is set to Percentage and depends on the DiscountType attribute setting which is input by the user when creating a voucher. There is no default value or limitation associated with this attribute. -
ExpirationDt: string
(date-time)
Title:
Expiration Date
Read Only:true
The date when the member voucher expires. Oracle Loyalty Cloud sets this value while creating a voucher record. 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
Read Only:true
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
Read Only:true
The Identity of the member for the assigned voucher. Oracle Loyalty Cloud assigns this attribute value when it assigns a voucher action or is 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. -
ProdId: integer
(int64)
Read Only:
true
The identity 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 in use. There is no default value, dependency, or limitation associated with this attribute. -
Quantity: number
Title:
Quantity
Read Only:true
The quantity of vouchers 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 a read-only child of the Member 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. -
VchrEffStartDt: string
(date)
Title:
Voucher Effective Start Date
Read Only:true
The date when the voucher is in effect. This date is set 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
Read Only:true
Maximum Length:30
The alternative way to identify a voucher. The UI shows the voucher number. There is no default value, dependency, or limitation associated with this attribute. -
voucherStatus: string
Read Only:
true
The text that defines the voucher status. This is a read-only value that shows the meaning of the Voucher Status Code LOV values such as Available, Used, Cancelled and Expired. There is no default value, dependency, or limitation associated with this attribute. -
VoucherType: string
Read Only:
true
The loyalty product description for the voucher. 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.