Print Transaction
post
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_print_document
This operation prints the generated document.
Request
Path Parameters
-
MainDocVarName: string
The variable name of the main document, the first letter must be capitalized
-
ProcessVarName: string
The variable name of the Commerce process, the first letter must be capitalized
-
_id: integer
Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.
Root Schema : commerceTransaction-_print_documentRequest
Type:
Show Source
object
-
actionVariableName(optional):
string
Title:
Action Variable Name
The print action variable name used to look up print action configuration -
availableAttachmentsForMerge(optional):
array Attachments available for merge
Title:
Attachments available for merge
List of attachments available to merge for an email or print action -
cacheInstanceId(optional):
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. -
saveToQuote(optional):
boolean
Title:
Save To Quote
Indicates if the print document is saved to the quote, valid values are {true, false}
Nested Schema : Attachments available for merge
Type:
array
Title:
Attachments available for merge
List of attachments available to merge for an email or print action
Show Source
-
Array of:
object Attachment properties
Title:
Attachment properties
Captures the id and name of the attachment
Nested Schema : Attachment properties
Type:
object
Title:
Attachment properties
Captures the id and name of the attachment
Show Source
-
id(optional):
integer
ID for the attachment
-
name(optional):
string
Name for the attachment
Response
Default Response
Root Schema : commerceTransaction-_print_documentResponse
Type:
Show Source
object
-
cacheInstanceId(optional):
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. -
fileAttachmentAttribute(optional):
string
Title:
File Attachment Attribute
Used for confirmation -
fileContent(optional):
string
Title:
File Content
The Base64 encoded binary document value -
fileContentType(optional):
string
Title:
File Content Type
The file content type -
fileTitle(optional):
string
Title:
File Title
This file name used when saving to the quote file attachment attribute, or when downloading the file