Interact for Transaction

post

/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_interact

This action modifies Transaction attribute values, and optionally triggers auto-update rules without committing or retrieving the latest data from the database. Since this action does not save the Transaction to the database, it does not affect how other users see the Transaction.

Request

Path Parameters
  • The variable name of the main document, the first letter must be capitalized
  • The variable name of the Commerce process, the first letter must be capitalized
  • Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.
Body ()
Root Schema : commerceTransaction-_interactRequest
Type: object
Show Source
  • Title: Cache Instance Id
    The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
  • Query Definition
    Title: Query Definition
    Captures the query definition for the current resource request.
  • Title: Delta
    When the delta parameter is enabled and an action is invoked, only the data and state properties that have changed from the cache image are included in the response. Delta data is only calculated for the requested criteria.
  • commerceTransaction
  • Title: Refresh Cache
    The cache refresh parameter makes the 'cacheInstanceID' parameter of interact service optional, and allows users to invoke the interact service without prior initiation of a cache instance on the server. Additionally, administrators can pass a new parameter, 'refreshCache' = true, to reload the current cache and discard the changes.
  • Title: Trigger Attribute Variable Name
    In addition to 'cacheInstanceId', the 'triggerAttrVarName' parameter can be used to run rules based on the trigger attribute. If omitted, no new rules will run. The triggering attribute value is the transaction or transaction line attribute variable name.
Nested Schema : Query Definition
Type: object
Title: Query Definition
Captures the query definition for the current resource request.
Show Source
Nested Schema : commerceTransaction
Type: object
Show Source
Nested Schema : actions
Type: array
Array of actions names, whose state is requested in the state object response.
Show Source
Nested Schema : childDefs
Type: array
Show Source
Nested Schema : excludeFieldTypes
Type: array
Array of field names that you want to exclude in the response.
Show Source
Nested Schema : expand
Type: array
Array of child resource names that you want to expand so that the contents return with the parent in the same request.
Show Source
Nested Schema : expandedDomains
Type: array
Array of field names, whose expanded domains are requested in the state object response.
Show Source
Nested Schema : fields
Type: array
Array of field names that you wanted returned in a request.
Show Source
Nested Schema : groups
Type: array
Array of group names, whose state is requested in the state object response.
Show Source
Nested Schema : nodesExceptionList
Type: array
Array of document_number, recording the nodes that violate current expandNodes flag
Show Source
Nested Schema : orderBy
Type: array
Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
Show Source
Nested Schema : Child query criteria.
Type: object
Title: Child query criteria.
Captures the query criteria for the child resource.
Show Source
Nested Schema :
Type: object
Title:
Show Source
Nested Schema : Customer Country
Type: object
Title: Customer Country
Name of the country associated with the customer address.
Show Source
Nested Schema : Customer State
Type: object
Title: Customer State
Name of the state associated with the customer address.
Show Source
Nested Schema : eSignature File Attachment[eSignature Attribute Set]
Type: object
Title: eSignature File Attachment[eSignature Attribute Set]
The File Attachment attribute holds the documents to be sent to the eSignature Vendor
Nested Schema : eSignature Status (eSignature Attribute Set)
Type: object
Title: eSignature Status (eSignature Attribute Set)
The Status field contains the current status of this document
Show Source
Nested Schema : Invoice To Country
Type: object
Title: Invoice To Country
Name of the country on the invoice address.
Show Source
Nested Schema : Invoice To State
Type: object
Title: Invoice To State
Name of the state on the invoice address.
Show Source
Nested Schema : Ship To Country
Type: object
Title: Ship To Country
Name of the country associated with the shipping address.
Show Source
Nested Schema : Ship To State
Type: object
Title: Ship To State
Name of the state associated with the shipping address.
Show Source
Nested Schema : Sold To Country
Type: object
Title: Sold To Country
Name of the country associated with the Sold To party.
Show Source
Nested Schema : Sold To State
Type: object
Title: Sold To State
Name of the state associated with the Sold To party.
Show Source
Nested Schema : state
Type: object
Title: state
Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.
Show Source
  • Actions
    Title: Actions
    Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
  • Attributes
    Title: Attributes
    Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
  • Title: Deletable
    Boolean value that specifies whether the row can be deleted.
  • Groups
    Title: Groups
    Captures the current state of each group whose state was requested. The object contains one property per group, where the property name is the expression string that uniquely identifies the group.
  • Title: Has Error
    Boolean value that specifies whether any error that occurred has been assigned to the row itself.
  • Title: Has Warning
    Boolean value that specifies whether any warning that was issued has been assigned to the row itself.
  • Title: Hidden
    Boolean value that specifies whether the row can be hidden.
  • Messages
    Title: Messages
    Array of messages that have been generated for a specific object.
  • Title: Updatable
    Boolean value that specifies whether the row can be updated.
Nested Schema : Transaction Total
Type: object
Title: Transaction Total
The Transaction Total. The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract. Synonymous with the Total Contract Value.
Show Source
Nested Schema : My Approval[Submit]
Type: object
Title: My Approval[Submit]
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Nested Schema : Cancel Reason
Type: object
Title: Cancel Reason
The reason expressed by the customer for canceling this order.
Show Source
Nested Schema : Currency
Type: object
Title: Currency
The currency used to price and invoice this transaction.
Show Source
Nested Schema : Fulfillment Status
Type: object
Title: Fulfillment Status
This is the most advanced fulfillment status for any line on the transaction. The value for this attribute is derived from that supplied for each line by the fulfillment system after the transaction is submitted as a sales order.
Show Source
Nested Schema : Payment Terms
Type: object
Title: Payment Terms
The payment terms the customer will receive on their invoice.
Show Source
Nested Schema : Reject Reason
Type: object
Title: Reject Reason
The reason expressed by customer for rejecting this deal.
Show Source
Nested Schema : Sales Channel
Type: object
Title: Sales Channel
The channel that originated the transaction.
Show Source
Nested Schema : Status
Type: object
Title: Status
The most advanced milestone reached by lines of this transaction.
Show Source
Nested Schema : Tax Exempt Reason
Type: object
Title: Tax Exempt Reason
The reason why this transaction is exempt from sales tax. For example, in the U.S. goods purchased for re-sale are not taxed. This value defaults to the line items where it can be overridden.
Show Source
Nested Schema : Annual Contract Discount
Type: object
Title: Annual Contract Discount
The total value each year of the discounts on recurring charges for the transaction.
Show Source
Nested Schema : Annual Contract Value
Type: object
Title: Annual Contract Value
The total value of recurring charges each year.
Show Source
Nested Schema : Total Contract Discount
Type: object
Title: Total Contract Discount
The total discount on this transaction including discounts on all one-time, recurring and shipping charges for the duration of the contract.
Show Source
Nested Schema : Total Contract Value
Type: object
Title: Total Contract Value
The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract.
Show Source
Nested Schema : Total Discount Per Month
Type: object
Title: Total Discount Per Month
The total of discounts off monthly recurring charges.
Show Source
Nested Schema : Total (List) Per Month
Type: object
Title: Total (List) Per Month
The total of all monthly list amounts on the lines.
Show Source
Nested Schema : Total (Net) Per Month
Type: object
Title: Total (Net) Per Month
The total of all monthly net amounts on the lines.
Show Source
Nested Schema : Total Discount
Type: object
Title: Total Discount
The total of all extended discount amounts for one time pricing/charges.
Show Source
Nested Schema : Total (List)
Type: object
Title: Total (List)
The total of all one-time charges on the lines.
Show Source
Nested Schema : Total (Net)
Type: object
Title: Total (Net)
The total one time net charge.
Show Source
Nested Schema : Actions
Type: object
Title: Actions
Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
Nested Schema : Attributes
Type: object
Title: Attributes
Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
Nested Schema : Groups
Type: object
Title: Groups
Captures the current state of each group whose state was requested. The object contains one property per group, where the property name is the expression string that uniquely identifies the group.
Nested Schema : Messages
Type: array
Title: Messages
Array of messages that have been generated for a specific object.
Show Source
Back to Top

Response

Default Response

Body ()
Root Schema : commerceTransaction-_interactResponse
Type: object
Show Source
Nested Schema : commerceTransaction
Type: object
Show Source
Nested Schema :
Type: object
Title:
Show Source
Nested Schema : Customer Country
Type: object
Title: Customer Country
Name of the country associated with the customer address.
Show Source
Nested Schema : Customer State
Type: object
Title: Customer State
Name of the state associated with the customer address.
Show Source
Nested Schema : eSignature File Attachment[eSignature Attribute Set]
Type: object
Title: eSignature File Attachment[eSignature Attribute Set]
The File Attachment attribute holds the documents to be sent to the eSignature Vendor
Nested Schema : eSignature Status (eSignature Attribute Set)
Type: object
Title: eSignature Status (eSignature Attribute Set)
The Status field contains the current status of this document
Show Source
Nested Schema : Invoice To Country
Type: object
Title: Invoice To Country
Name of the country on the invoice address.
Show Source
Nested Schema : Invoice To State
Type: object
Title: Invoice To State
Name of the state on the invoice address.
Show Source
Nested Schema : Ship To Country
Type: object
Title: Ship To Country
Name of the country associated with the shipping address.
Show Source
Nested Schema : Ship To State
Type: object
Title: Ship To State
Name of the state associated with the shipping address.
Show Source
Nested Schema : Sold To Country
Type: object
Title: Sold To Country
Name of the country associated with the Sold To party.
Show Source
Nested Schema : Sold To State
Type: object
Title: Sold To State
Name of the state associated with the Sold To party.
Show Source
Nested Schema : state
Type: object
Title: state
Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.
Show Source
  • Actions
    Title: Actions
    Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
  • Attributes
    Title: Attributes
    Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
  • Title: Deletable
    Boolean value that specifies whether the row can be deleted.
  • Groups
    Title: Groups
    Captures the current state of each group whose state was requested. The object contains one property per group, where the property name is the expression string that uniquely identifies the group.
  • Title: Has Error
    Boolean value that specifies whether any error that occurred has been assigned to the row itself.
  • Title: Has Warning
    Boolean value that specifies whether any warning that was issued has been assigned to the row itself.
  • Title: Hidden
    Boolean value that specifies whether the row can be hidden.
  • Messages
    Title: Messages
    Array of messages that have been generated for a specific object.
  • Title: Updatable
    Boolean value that specifies whether the row can be updated.
Nested Schema : Transaction Total
Type: object
Title: Transaction Total
The Transaction Total. The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract. Synonymous with the Total Contract Value.
Show Source
Nested Schema : My Approval[Submit]
Type: object
Title: My Approval[Submit]
This attribute lists all approval currently pending for current logged in user. This is not available as rule input.
Nested Schema : Cancel Reason
Type: object
Title: Cancel Reason
The reason expressed by the customer for canceling this order.
Show Source
Nested Schema : Currency
Type: object
Title: Currency
The currency used to price and invoice this transaction.
Show Source
Nested Schema : Fulfillment Status
Type: object
Title: Fulfillment Status
This is the most advanced fulfillment status for any line on the transaction. The value for this attribute is derived from that supplied for each line by the fulfillment system after the transaction is submitted as a sales order.
Show Source
Nested Schema : Payment Terms
Type: object
Title: Payment Terms
The payment terms the customer will receive on their invoice.
Show Source
Nested Schema : Reject Reason
Type: object
Title: Reject Reason
The reason expressed by customer for rejecting this deal.
Show Source
Nested Schema : Sales Channel
Type: object
Title: Sales Channel
The channel that originated the transaction.
Show Source
Nested Schema : Status
Type: object
Title: Status
The most advanced milestone reached by lines of this transaction.
Show Source
Nested Schema : Tax Exempt Reason
Type: object
Title: Tax Exempt Reason
The reason why this transaction is exempt from sales tax. For example, in the U.S. goods purchased for re-sale are not taxed. This value defaults to the line items where it can be overridden.
Show Source
Nested Schema : Annual Contract Discount
Type: object
Title: Annual Contract Discount
The total value each year of the discounts on recurring charges for the transaction.
Show Source
Nested Schema : Annual Contract Value
Type: object
Title: Annual Contract Value
The total value of recurring charges each year.
Show Source
Nested Schema : Total Contract Discount
Type: object
Title: Total Contract Discount
The total discount on this transaction including discounts on all one-time, recurring and shipping charges for the duration of the contract.
Show Source
Nested Schema : Total Contract Value
Type: object
Title: Total Contract Value
The total value of this transaction including all one-time, recurring and shipping charges over the duration of the contract.
Show Source
Nested Schema : Total Discount Per Month
Type: object
Title: Total Discount Per Month
The total of discounts off monthly recurring charges.
Show Source
Nested Schema : Total (List) Per Month
Type: object
Title: Total (List) Per Month
The total of all monthly list amounts on the lines.
Show Source
Nested Schema : Total (Net) Per Month
Type: object
Title: Total (Net) Per Month
The total of all monthly net amounts on the lines.
Show Source
Nested Schema : Total Discount
Type: object
Title: Total Discount
The total of all extended discount amounts for one time pricing/charges.
Show Source
Nested Schema : Total (List)
Type: object
Title: Total (List)
The total of all one-time charges on the lines.
Show Source
Nested Schema : Total (Net)
Type: object
Title: Total (Net)
The total one time net charge.
Show Source
Nested Schema : Actions
Type: object
Title: Actions
Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
Nested Schema : Attributes
Type: object
Title: Attributes
Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
Nested Schema : Groups
Type: object
Title: Groups
Captures the current state of each group whose state was requested. The object contains one property per group, where the property name is the expression string that uniquely identifies the group.
Nested Schema : Messages
Type: array
Title: Messages
Array of messages that have been generated for a specific object.
Show Source
Back to Top

Examples

The following example shows how to re-sequence Transaction Lines via the interact action by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v7/commerceDocumentsOraclecpqoTransaction/18016533/actions/_interact

Request Body Sample

{
   "cacheInstanceId": "3VSdeAMI1mjG0EHV72FfsvaMSXFhEiN7NIIYPt8qc0qXSuHOMypodFVi0vomLJ7d",
   "documents": {
      "sub": {
         "items": [{
               "_sequence_number": "5",
               "_document_number": "2"
            }
         ]
      }
   },
   "criteria": {
      "state": false,
      "fields": ["_id"],
      "childDefs": [{
            "name": "sub",
            "queryDef": {
               "state": false,
               "limit": 10,
               "offset": 0,
               "totalResults": true,
               "enableHierarchy": true,
               "expandNodes": true,
               "nodesExceptionList": [],
               "orderby": ["_sequence_number:ASC"],
               "fields": ["_sequence_number", "_part_number", "_document_number"]
            }
         }
      ],
      "expandedDomains": []
   }
}
         

Response: The re-sequenced Transaction Lines for the requested cached transaction are returned.

Back to Top