Jump to

• Request
• Response

Get a loyalty transaction voucher assigned during transaction processing (Deprecated)

get

/crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/TransactionVouchers/{LoyMemVchrId}

Request

Path Parameters

• LoyMemVchrId(required): integer(int64)
  The primary key to identify a loyalty voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or the value can be provided as input when creating a voucher using the resource. There is no default value, dependency, or limitation associated with this attribute.
• LoyTransactionId(required): integer(int64)
  The primary key to identify a transaction. Oracle Loyalty Cloud generates this attribute value during the creation of a transaction record. There is no default value, dependency, or limitation associated with this attribute.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : loyaltyTransactions-TransactionVouchers-item-response

Type: object

Show Source

• CurcyAmount: number
  Title: Currency Amount

  Read Only: true

  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.
• DiscntPct: number
  Title: Discount Percentage

  Read Only: true

  The voucher discount percent. This attribute is required if the Discount Type attribute is set to Percentage. This attribute depends on the DiscountType attribute setting which is an input value from 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 expiration date of the voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or it 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

  Read Only: true

  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.
• 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 loyalty voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or the value can be provided as input when creating a voucher using the resource. There is no default value, dependency, or limitation associated with this attribute.
• MemberId: integer (int64)
  Title: Member ID

  Read Only: true

  The primary key of the member to whom the voucher is assigned. 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. There is no default value, dependency, or limitation associated with this attribute.
• Quantity: number
  Title: Quantity

  Read Only: true

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

  Read Only: true

  The primary key from the transaction. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• UsedDt: string (date-time)
  Title: Used Date

  Read Only: true

  The attribute is a date value that is assigned when the voucher status is changed from Available to Used through a PATCH request. 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 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.
• VoucherBasis: string
  Read Only: true

  The voucher assignment based on the transaction type. It is set to Accrual for accrual transactions or Redemption for redemption transactions. This is an input value provided by a user when creating a voucher. There is no default value, dependency, or limitation associated with this attribute.
• VoucherStatus: string
  Read Only: true

  The voucher status. The accepted values are Available, Expired, or Used. 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 ProductId 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 attribute is a date value that is assigned when the voucher status is changed from Available to Used through a PATCH request. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LoyMemVchrId":{
            "title":"Member Voucher ID",
            "type":"integer",
            "description":"The primary key to identify a loyalty voucher. Oracle Loyalty Cloud generates this attribute value when it assigns a voucher action or the value can be provided as input when creating a voucher using the 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
        },
        "CurcyAmount":{
            "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,
            "readOnly":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 it 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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of vouchers that are assigned to a member. The value for this attribute must be 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. 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
        },
        "DiscntPct":{
            "title":"Discount Percentage",
            "type":"number",
            "description":"The voucher discount percent. This attribute is required if the Discount Type attribute is set to Percentage. This attribute depends on the DiscountType attribute setting which is an input value from 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":"Transaction ID",
            "type":"integer",
            "description":"The primary key from the transaction. Oracle Loyalty Cloud generates this attribute value. 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
        },
        "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VoucherStatus":{
            "type":"string",
            "description":"The voucher status. The accepted values are Available, Expired, or Used. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VoucherBasis":{
            "type":"string",
            "description":"The voucher assignment based on the transaction type. It is set to Accrual for accrual transactions or Redemption for redemption transactions. This is an input value provided by a user when creating a voucher. 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 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,
            "readOnly":true,
            "x-queryable":true
        },
        "VoucherType":{
            "type":"string",
            "description":"The loyalty product description for the voucher. Oracle Loyalty Cloud assigns the ProductId 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