Jump to

• Request
• Response

Back to Quotes List/Transaction Manager

post

/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/actions/back_to_transactionmanager_t

Use this endpoint to navigate back to the specified Quotes List/Transaction Manager page.

Request

Supported Media Types

• application/json

Path Parameters

• MainDocVarName(required): string
  The variable name of the main document, note the first letter must be capitalized.
• ProcessVarName(required): string
  The variable name of the commerce process, note the first letter must be capitalized.
• id(required): integer
  Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.

Body ()

Root Schema : Transaction-BackRequest

Type: object

Show Source

• cacheInstanceId: string
  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.
• revisionId: string
  Title: Revision Id

  The string parameter that contains the revision information.

{
    "type":"object",
    "properties":{
        "revisionId":{
            "type":"string",
            "description":"The string parameter that contains the revision information.",
            "title":"Revision Id"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"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.",
            "title":"Cache Instance Id"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Transaction-BackResponse

Type: object

Show Source

• cacheInstanceId: string
  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.
• destinationURL: string
  Title: Destination URL

  The destination url as defined in destination tab in action definition.
• revisionId: string
  Title: Revision Id

  The string parameter that contains the revision information.
• warnings: object warnings
  Title: warnings

  warning messages

{
    "type":"object",
    "properties":{
        "revisionId":{
            "type":"string",
            "description":"The string parameter that contains the revision information.",
            "title":"Revision Id"
        },
        "warnings":{
            "$ref":"#/definitions/warnings"
        },
        "cacheInstanceId":{
            "type":"string",
            "description":"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.",
            "title":"Cache Instance Id"
        },
        "destinationURL":{
            "type":"string",
            "description":"The destination url as defined in destination tab in action definition.",
            "title":"Destination URL"
        }
    }
}

Nested Schema : warnings

Type: object

Title: warnings

warning messages

Show Source

• messages: array Messages
  Title: Messages

  Array of messages that have been generated for a specific object.

{
    "type":"object",
    "properties":{
        "messages":{
            "type":"array",
            "description":"Array of messages that have been generated for a specific object.",
            "title":"Messages",
            "items":{
                "type":"string",
                "description":"warning message."
            }
        }
    },
    "title":"warnings",
    "description":"warning messages"
}

Nested Schema : Messages

Type: array

Title: Messages

Array of messages that have been generated for a specific object.

Show Source

• Array of: string
  warning message.

{
    "type":"array",
    "description":"Array of messages that have been generated for a specific object.",
    "title":"Messages",
    "items":{
        "type":"string",
        "description":"warning message."
    }
}

Back to Top