Jump to

• Request
• Response

Create trade operations

post

/fscmRestApi/resources/11.13.18.05/tradeOperations/action/createTradeOperationFromTemplate

Creates trade operations, adds charges from the template, and includes default purchase order schedules, default purchase order shipments, or default transfer order shipments.

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• allocationQuantityTypeCode: string
  The abbreviation for the quantity used to process the allocation in a trade operation.
• currencyConversionRateType: string
  The type of default currency conversion rate to be used for currency conversion in a trade operation.
• defaultSourceDocumentIds: array defaultSourceDocumentIds
  Identifier for the source documents added to the trade operation.
• procurementBU: string
  Destination business unit where the trade operation will be created.
• route: string
  Route under which the trade operation is classified.
• tradeOperationCurrency: string
  Currency to be used in the trade operation.
• tradeOperationDescription: string
  Description of the trade operation.
• tradeOperationName: string
  Name of the trade operation.
• tradeOperationTemplateId: number
  Unique identifier for the trade operation template.
• transactionTypeCode: string
  The transaction type code of the trade operation.

{
    "type":"object",
    "properties":{
        "currencyConversionRateType":{
            "type":"string",
            "description":"The type of default currency conversion rate to be used for currency conversion in a trade operation.",
            "nullable":true
        },
        "route":{
            "type":"string",
            "description":"Route under which the trade operation is classified.",
            "nullable":true
        },
        "procurementBU":{
            "type":"string",
            "description":"Destination business unit where the trade operation will be created.",
            "nullable":true
        },
        "defaultSourceDocumentIds":{
            "type":"array",
            "description":"Identifier for the source documents added to the trade operation.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "tradeOperationDescription":{
            "type":"string",
            "description":"Description of the trade operation.",
            "nullable":true
        },
        "tradeOperationCurrency":{
            "type":"string",
            "description":"Currency to be used in the trade operation.",
            "nullable":true
        },
        "allocationQuantityTypeCode":{
            "type":"string",
            "description":"The abbreviation for the quantity used to process the allocation in a trade operation.",
            "nullable":true
        },
        "tradeOperationName":{
            "type":"string",
            "description":"Name of the trade operation.",
            "nullable":true
        },
        "transactionTypeCode":{
            "type":"string",
            "description":"The transaction type code of the trade operation.",
            "nullable":true
        },
        "tradeOperationTemplateId":{
            "type":"number",
            "description":"Unique identifier for the trade operation template.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : defaultSourceDocumentIds

Type: array

Identifier for the source documents added to the trade operation.

Show Source

• Array of: number

{
    "type":"array",
    "description":"Identifier for the source documents added to the trade operation.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): number
  Unique identifier for the trade operation.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"number",
            "description":"Unique identifier for the trade operation."
        }
    },
    "additionalProperties":false
}

Back to Top