Jump to

• Request
• Response
• Examples

Forward Transactions

post

/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/actions/_forward

Use this endpoint to forward selected transactions to the specified users and/or groups.

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.

Body ()

Root Schema : Transaction-_forwardCollectionRequest

Type: object

Show Source

• company: string
  Title: Company

  The company name
• ids: array The transaction ids
  Title: The transaction ids

  The list of transactions that are forwarded to user / groups
• salesGroups: array The list of sales group variable names
  Title: The list of sales group variable names

  The list of sales groups to which the transaction are forwarded to
• salesUsers: array The list of sales user keys
  Title: The list of sales user keys

  The list of sales users to whom the trsacations are forwarded to

{
    "type":"object",
    "properties":{
        "salesGroups":{
            "$ref":"#/definitions/salesGroups"
        },
        "ids":{
            "$ref":"#/definitions/ids"
        },
        "company":{
            "type":"string",
            "description":"The company name",
            "title":"Company"
        },
        "salesUsers":{
            "$ref":"#/definitions/salesUsers"
        }
    }
}

Nested Schema : The transaction ids

Type: array

Title: The transaction ids

The list of transactions that are forwarded to user / groups

Show Source

• Array of: number

{
    "title":"The transaction ids",
    "type":"array",
    "description":"The list of transactions that are forwarded to user / groups",
    "items":{
        "type":"number"
    }
}

Nested Schema : The list of sales group variable names

Type: array

Title: The list of sales group variable names

The list of sales groups to which the transaction are forwarded to

Show Source

• Array of: string

{
    "title":"The list of sales group variable names",
    "type":"array",
    "description":"The list of sales groups to which the transaction are forwarded to",
    "items":{
        "type":"string"
    }
}

Nested Schema : The list of sales user keys

Type: array

Title: The list of sales user keys

The list of sales users to whom the trsacations are forwarded to

Show Source

• Array of: string

{
    "title":"The list of sales user keys",
    "type":"array",
    "description":"The list of sales users to whom the trsacations are forwarded to",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Transaction-_forwardCollectionResponse

Type: object

Back to Top

Examples

The following example shows how to forward selected transactions to the specified users and/or groups. 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/v16/commerceDocumentsOraclecpqoTransaction/actions/_forward

Request Body Sample

{
  "ids": [18007731, 18007790, 18005157],
  "company": "company123,
  "salesGroups": [group1, group2, group3],
  "salesUsers": []
}

Back to Top