Jump to

• Request
• Response

Update a voucher (Deprecated)

patch

/crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberVouchers/{LoyMemVchrId}

Request

Path Parameters

• LoyMemVchrId(required): integer(int64)
  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.
• 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.

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

{
    "type":"object",
    "properties":{
    }
}

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 : loyaltyMembers-MemberVouchers-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpirationDt":{
            "title":"Expiration Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VoucherNumber":{
            "title":"Voucher Number",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyAmount":{
            "title":"Currency Amount",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DiscntPct":{
            "title":"Discount Percentage",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":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 a read-only child of the Member Vouchers resource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "voucherStatus":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VchrEffStartDt":{
            "title":"Voucher Effective Start Date",
            "type":"string",
            "description":"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 \nresource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VoucherType":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top