Jump to

• Request
• Response
• Examples

Email - Send Transaction Email

post

/rest/v19/commerce{Stage}{ProcessVarName}{MainDocVarName}/{id}/actions/_send_email

Use this endpoint to collect email form data, generate the attachment, pushe the email to SMTP servers, and return confirmation on email sent time. The email recipient receives an email with the comments in the email body and an attachment that contains the quote information.

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.
• Stage(required): string
  The stage variable identifies where a transaction is within the Commerce process flow. (Documents, Quotes, Agreements, or Orders)
• id(required): integer
  Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.

Body ()

Root Schema : Transaction-_send_emailRequest

Type: object

Show Source

• actionVariableName: string
  Title: Action Variable Name

  The email action variable name used to look up email action configuration
• attachmentIds: array Attachments to be merged.
  Title: Attachments to be merged.

  List of attachments to be merged for an email action.
• attachmentIdsForMerge: array Attachments to be merged.
  Title: Attachments to be merged.

  List of attachments to be merged for an email or print action.
• bccEmail: string
  Title: Bcc Email

  The bcc email address(es)
• 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.
• ccEmail: string
  Title: Cc Email

  The cc email address(es)
• comments: string
  Title: Comments

  The comments to be sent in the email body
• fromName: string
  Title: From Name

  The sender's name
• languageCode: string
  Title: Preferred Language

  The language preference for sending email
• subject: string
  Title: Subject

  The email subject line
• toEmail: string
  Title: To Email

  The recipient's email address(es)
• toName: string
  Title: To Name

  The recipient's name
• xslView: integer
  Title: XSL View

  Printer friendly proposals or history outputs generated from predefined XSL templates

{
    "type":"object",
    "properties":{
        "comments":{
            "type":"string",
            "description":"The comments to be sent in the email body",
            "title":"Comments"
        },
        "ccEmail":{
            "type":"string",
            "description":"The cc email address(es)",
            "title":"Cc Email"
        },
        "subject":{
            "type":"string",
            "description":"The email subject line",
            "title":"Subject"
        },
        "actionVariableName":{
            "type":"string",
            "description":"The email action variable name used to look up email action configuration",
            "title":"Action Variable Name"
        },
        "languageCode":{
            "type":"string",
            "description":"The language preference for sending email",
            "title":"Preferred Language"
        },
        "bccEmail":{
            "type":"string",
            "description":"The bcc email address(es)",
            "title":"Bcc Email"
        },
        "attachmentIdsForMerge":{
            "$ref":"#/definitions/attachmentIdsForMerge"
        },
        "xslView":{
            "type":"integer",
            "description":"Printer friendly proposals or history outputs generated from predefined XSL templates",
            "title":"XSL View"
        },
        "toName":{
            "type":"string",
            "description":"The recipient's name",
            "title":"To Name"
        },
        "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"
        },
        "fromName":{
            "type":"string",
            "description":"The sender's name",
            "title":"From Name"
        },
        "attachmentIds":{
            "$ref":"#/definitions/attachmentIds"
        },
        "toEmail":{
            "type":"string",
            "description":"The recipient's email address(es)",
            "title":"To Email"
        }
    }
}

Nested Schema : Attachments to be merged.

Type: array

Title: Attachments to be merged.

List of attachments to be merged for an email action.

Show Source

• Array of: object Attachment properties.
  Title: Attachment properties.

  Captures the id of the attachment.

{
    "title":"Attachments to be merged.",
    "type":"array",
    "description":"List of attachments to be merged for an email action.",
    "items":{
        "$ref":"#/definitions/attachmentIdDef"
    }
}

Nested Schema : Attachments to be merged.

Type: array

Title: Attachments to be merged.

List of attachments to be merged for an email or print action.

Show Source

• Array of: object Attachment properties.
  Title: Attachment properties.

  Captures the id of the attachment.

{
    "title":"Attachments to be merged.",
    "type":"array",
    "description":"List of attachments to be merged for an email or print action.",
    "items":{
        "$ref":"#/definitions/attachmentIdDef"
    }
}

Nested Schema : Attachment properties.

Type: object

Title: Attachment properties.

Captures the id of the attachment.

Show Source

• id: integer
  ID for the attachment.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID for the attachment."
        }
    },
    "title":"Attachment properties.",
    "description":"Captures the id of the attachment."
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Transaction-_send_emailResponse

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.
• message: string
  Title: Message

  The summary message for sending email

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"The summary message for sending email",
            "title":"Message"
        },
        "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

Examples

The following example shows how to collect email form data, generates the attachment, pushes the email to SMTP servers, and returns confirmation on email sent time by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/18498612/actions/_send_email

Request Body Sample

{
  "actionVariableName": "_action_process_email_print",
  "comments": "test comments",
  "ccEmail": "",
  "toName": "Test To Name",
  "subject": "Test subject",
  "fromName": "Test From Name",
  "toEmail": "[e-mail]",
  "languageCode": "en",
  "xslView": "3023146476",
  "attachmentIdsForMerge": ["-2", "3023146599", "3023146600"]
}

Response Body Sample

{
   "message": "Your email was sent on 06/26/2024 4: 42PM",
   "cacheInstanceId":  "5J9MTQAbF1ZmcJGnul6y4WOrAydsRpSyR2vvW1o7fWkrEkO89aiFxbEQSIUCEnF4"
}

Back to Top