Jump to

• Request
• Response

Update a transaction (Deprecated)

patch

/crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberTransactions/{LoyTransactionId}

Request

Path Parameters

• LoyTransactionId(required): integer(int64)
  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 Members resource. 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-MemberTransactions-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyTransactionId: 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 Members resource. There is no default value, dependency, or limitation associated with this attribute.
• MemberId: integer (int64)
  Title: Member ID

  Read Only: true

  The member reference identifier for the current transaction child records, which provides information about the current parent member transactions. There is no default value, dependency, or limitation associated with this attribute.
• PartnerId: integer (int64)
  Title: Partner ID

  Read Only: true

  The partner identifier of the transaction, which is shown for the partner transaction data. This attribute is shown and used in mobile UIs and other integrations. There is no default value, dependency, or limitation associated with this attribute.
• ProdId: integer (int64)
  Title: Product ID

  Read Only: true

  The product identifier of the transaction, which is used in mobile UIs or other integrations that are build on the Oracle Loyalty Cloud resources. There is no default value, dependency, or limitation associated with this attribute.
• StatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  The status code of the transaction. The transaction status shown in a finder lookup code value. There is no default value, dependency, or limitation associated with this attribute.
• SubTypeCode: string
  Title: Subtype Code

  Read Only: true

  Maximum Length: 30

  The subtype code of the transaction shown as a finder lookup code. This is dependent on the TypeCode attribute. There is no default value or limitation associated with this attribute.
• TransactionDate: string (date-time)
  Title: Transaction Date

  Read Only: true

  The transaction date when the transaction occurs. In the child MemberTransactions child resource under the loyaltyMembers resource, the TransactionDate shows the date when the loyalty transaction is performed by the particular parent member. 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 transactions, and is displayed in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.
• TypeCode: string
  Title: Type Code

  Read Only: true

  Maximum Length: 30

  The type code of the transaction. The transaction type code is shown in a finder lookup code value. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The member reference identifier for the current transaction child records, which provides information about the current parent member transactions. 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
        },
        "TransactionNumber":{
            "title":"Transaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The transaction number of the transaction. This is an alternative identifier for transactions, and is displayed in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type code of the transaction. The transaction type code is shown in a finder lookup code value. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The partner identifier of the transaction, which is shown for the partner transaction data. This attribute is shown and used in mobile UIs and other integrations. 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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubTypeCode":{
            "title":"Subtype Code",
            "maxLength":30,
            "type":"string",
            "description":"The subtype code of the transaction shown as a finder lookup code. This is dependent on the TypeCode attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdId":{
            "title":"Product ID",
            "type":"integer",
            "description":"The product identifier of the transaction, which is used in mobile UIs or other integrations that are build on the Oracle Loyalty Cloud resources. 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
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the transaction. The transaction status shown in a finder lookup code value. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The transaction date when the transaction occurs. In the child MemberTransactions child resource under the loyaltyMembers resource, the TransactionDate shows the date when the loyalty transaction is performed by the particular parent member. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyTransactionId":{
            "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 Members 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
        }
    }
}

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