1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Trade Operations

Get one trade operation

get

/fscmRestApi/resources/11.13.18.05/tradeOperations/{TradeOperationId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : tradeOperations-item-response
Type: object
Show Source
Nested Schema : Charges
Type: array
Title: Charges
The Charges resource gets information about the trade operation charge line, status and the allocated amounts for each charge line.
Show Source
Nested Schema : Default Purchase Order Schedules
Type: array
Title: Default Purchase Order Schedules
The Default Purchase Order Schedules resource gets information about the default purchase order schedules associated with a trade operation.
Show Source
Nested Schema : Trade Operation Shipments
Type: array
Title: Trade Operation Shipments
The Trade Operation Shipments resource manages information about advanced shipment notices (ASNs) associated with a trade operation.
Show Source
Nested Schema : tradeOperations-charges-item-response
Type: object
Show Source
Nested Schema : Charge Invoice Associations
Type: array
Title: Charge Invoice Associations
The Charge Invoice Associations resource gets information about the invoice associated with a charge line.
Show Source
Nested Schema : Charge Purchase Order Schedules
Type: array
Title: Charge Purchase Order Schedules
The Charge Purchase Order Schedules resource gets information about the purchase order schedules associated with a charge line.
Show Source
Nested Schema : Charge References
Type: array
Title: Charge References
The Charge References resource gets information about the charge references associated with a charge line.
Show Source
Nested Schema : Charge Related Lines
Type: array
Title: Charge Related Lines
The Charge Related Lines resource gets information about the related charge lines for a charge line.
Show Source
Nested Schema : tradeOperations-charges-chargeInvoiceAssociations-item-response
Type: object
Show Source
Nested Schema : tradeOperations-charges-chargePurchaseOrderSchedules-item-response
Type: object
Show Source
  • Title: Allocated Actual Amount in Trade Operation Currency
    Read Only: true
    Actual amount on the charge line in the trade operation currency.
  • Title: Allocated Actual Amount in Functional Currency
    Read Only: true
    Actual amount on the charge line in the functional currency.
  • Title: Allocated Actual Amount in Material Requisition BU Currency
    Read Only: true
    Actual amount on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Actual per Unit Amount in Trade Operation Currency
    Read Only: true
    Actual per unit amount on the charge line in the trade operation currency.
  • Title: Allocated Actual per Unit Amount in Functional Currency
    Read Only: true
    Actual per unit amount on the charge line in the functional currency.
  • Title: Allocated Actual per Unit Amount in Material Requisition BU Currency
    Read Only: true
    Actual per unit amount on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Actual NonRecoverable Tax in Trade Operation Currency
    Read Only: true
    Actual non-recoverable tax on the charge line in the trade operation currency.
  • Title: Allocated Actual NonRecoverable Tax in Functional Currency
    Read Only: true
    Actual non-recoverable tax on the charge line in the functional currency.
  • Title: Allocated Actual NonRecoverable Tax in Material Requisition BU Currency
    Read Only: true
    Actual non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Actual per Unit NonRecoverable Tax in Trade Operation Currency
    Read Only: true
    Actual per unit non-recoverable tax on the charge line in the trade operation currency.
  • Title: Allocated Actual per Unit NonRecoverable Tax in Functional Currency
    Read Only: true
    Actual per unit non-recoverable tax on the charge line in the functional currency.
  • Title: Allocated Actual per Unit NonRecoverable Tax in Material Requisition BU Currency
    Read Only: true
    Actual per unit non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocation Base Factor
    Base factor value used for charge allocation.
  • Title: Allocation Currency
    Maximum Length: 15
    Currency used for charge allocation.
  • Title: Allocation Percentage
    Percentage used for charge allocation.
  • Title: Allocation Rate
    Rate to be applied to purchase order schedules for deriving the charge estimates.
  • Title: Delivered-to Inventory Organization Name
    Read Only: true
    Maximum Length: 240
    Name of the inventory organization to which the item is delivered.
  • Title: Delivered-To Inventory Organization ID
    Read Only: true
    Value that uniquely identifies the inventory organization to which the item is delivered.
  • Title: Destination Type
    Read Only: true
    Maximum Length: 80
    Destination type on the purchase order.
  • Title: Allocated Estimate Amount in Charge Currency
    Read Only: true
    Estimated amount on the charge line in the charge currency.
  • Title: Allocated Estimate Amount in Trade Operation Currency
    Read Only: true
    Estimated amount on the charge line in the trade operation currency.
  • Title: Allocated Estimate Amount in Functional Currency
    Read Only: true
    Estimated amount on the charge line in the functional currency.
  • Title: Allocated Estimate Amount in Material Requisition BU Currency
    Read Only: true
    Estimated amount on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Estimate per Unit Amount in Charge Currency
    Read Only: true
    Estimated per unit amount on the charge line in the charge currency.
  • Title: Allocated Estimate per Unit Amount in Trade Operation Currency
    Read Only: true
    Estimated per unit amount on the charge line in the trade operation currency.
  • Title: Allocated Estimate per Unit Amount in Functional Currency
    Read Only: true
    Estimated per unit amount on the charge line in the functional currency.
  • Title: Allocated Estimate per Unit Amount in Material Requisition BU Currency
    Read Only: true
    Estimated per unit amount on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Estimate NonRecoverable Tax in Trade Operation Currency
    Read Only: true
    Estimated non-recoverable tax on the charge line in the trade operation currency.
  • Title: Allocated Estimate NonRecoverable Tax in Functional Currency
    Read Only: true
    Estimated non-recoverable tax on the charge line in the functional currency.
  • Title: Allocated Estimate NonRecoverable Tax in Material Requisitioning BU Currency
    Read Only: true
    Estimated non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Estimate per Unit NonRecoverable Tax in Charge Currency
    Read Only: true
    Estimated per unit non-recoverable tax on the charge line in the charge currency.
  • Title: Allocated Estimate per Unit NonRecoverable Tax in Trade Operation Currency
    Read Only: true
    Estimated per unit non-recoverable tax on the charge line in the trade operation currency.
  • Title: Allocated Estimate per Unit NonRecoverable Tax in Functional Currency
    Read Only: true
    Estimated per unit non-recoverable tax on the charge line in the functional currency.
  • Title: Allocated Estimate per Unit NonRecoverable Tax in Material Requisition BU Currency
    Read Only: true
    Estimated per unit non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
  • Title: Allocated Estimate NonRecoverable Tax in Charge Currency
    Read Only: true
    Estimated non-recoverable tax on the charge line in the charge currency.
  • Title: Item ID
    Read Only: true
    Value that uniquely identifies the item.
  • Read Only: true
    Maximum Length: 300
    Item on the purchase order schedule.
  • Title: Landed Cost PO Schedule ID
    Value that uniquely identifies the purchase order schedule for landed cost.
  • Links
  • Title: Ordered Quantity
    Quantity on the purchase order schedule.
  • Title: Purchase Order Header ID
    Read Only: true
    Value that uniquely identifies the purchase order header.
  • Title: Item Price
    Item price on the purchase order.
  • Title: Purchase Order Line ID
    Read Only: true
    Value that uniquely identifies the purchase order line.
  • Title: Purchase Order Line Location ID
    Read Only: true
    Value that uniquely identifies the purchase order shipment schedule.
  • Title: Purchase Order Line
    Read Only: true
    Maximum Length: 40
    Number that identifies the line in the purchase order.
  • Title: Purchase Order
    Read Only: true
    Maximum Length: 40
    Number that identifies the material purchase order for the landed cost estimate.
  • Maximum Length: 3
    Value that identifies the primary unit of measure for the purchase order schedule quantity.
  • Title: Ordered Quantity (Secondary UOM)
    Ordered quantity on the purchase order in the primary unit of measure.
  • Title: Ordered Quantity (Secondary UOM)
    Ordered quantity on the purchase order in the secondary unit of measure.
  • Title: PO Schedule Amount
    Read Only: true
    Amount on the purchase order schedule line.
  • Title: PO Schedule Functional Currency Amount
    Read Only: true
    Functional currency amount on the purchase order schedule line.
  • Title: Purchase Order Schedule
    Read Only: true
    Maximum Length: 40
    Number that identifies the schedule of the material purchase order line used for the landed cost estimate.
  • Maximum Length: 3
    Value that identifies the secondary unit of measure for the purchase order schedule quantity.
  • Title: Procurement BU
    Read Only: true
    Maximum Length: 240
    Procurement business unit on the purchase order schedule.
  • Title: Procurement Business Unit ID
    Read Only: true
    Value that uniquely identifies the procurement business unit for the material purchase order schedule.
  • Title: Profit Center BU
    Read Only: true
    Maximum Length: 240
    Profit center business unit on the purchase order schedule.
  • Title: Profit Center BU ID
    Read Only: true
    Value that uniquely identifies the profit center business unit for the material purchase order schedule.
  • Title: Receipt Quantity
    Read Only: true
    Received quantity corresponding to the purchase order schedule.
  • Title: Requisitioning BU
    Read Only: true
    Maximum Length: 240
    Requisitioning business unit on the purchase order schedule.
  • Title: Requisitioning BU ID
    Read Only: true
    Value that uniquely identifies the requisitioning business unit for the material purchase order schedule.
  • Title: Ship-to Location
    Read Only: true
    Maximum Length: 240
    Location to which the item is delivered.
  • Title: Ship-To Location ID
    Read Only: true
    Value that uniquely identifies the location to which the item is delivered.
  • Title: Supplier
    Read Only: true
    Maximum Length: 360
    Supplier on the purchase order.
  • Title: Supplier Site
    Read Only: true
    Maximum Length: 240
    Supplier site on the purchase order.
  • Title: Supplier Site ID
    Read Only: true
    Value that uniquely identifies the supplier site on the purchase order.
  • Title: Unit of Measure
    Read Only: true
    Maximum Length: 25
    Unit of measure for the purchase order schedule quantity.
  • Title: UOM Type
    Maximum Length: 30
    Value that identifies the unit of measure used for charge allocation.
Nested Schema : tradeOperations-charges-chargeReferences-item-response
Type: object
Show Source
Nested Schema : tradeOperations-charges-chargeRelatedLines-item-response
Type: object
Show Source
  • Title: Charge BU
    Read Only: true
    Maximum Length: 240
    Value that indicates the requisitioning business unit that incurs the charge.
  • Title: Related Charge Line Number
    Value that uniquely identifies the charge line number for the charge entered as related in a charge line.
  • Title: Charge Line Status Meaning
    Read Only: true
    Maximum Length: 80
    Value that indicates the meaning of the charge line status.
  • Title: Charge Line Status
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the status of the charge line. Values include Allocated, Allocated with Warning, Allocation in Error, Cancelled, Draft Allocation, Incomplete, New, Pending Association, Ready for Allocation, and Requires Reallocation.
  • Title: Related Charge Name
    Read Only: true
    Maximum Length: 80
    Name of the charge for the related charge line entered in a charge line.
  • Title: Charge Currency
    Read Only: true
    Maximum Length: 15
    Transaction currency in which the charge is entered.
  • Title: Include item value
    Contains one of the following values: true or false. If true, then the purchase value needs to be included for the purpose of deriving the charge amount. If false, then the purchase value is not included for the purpose of deriving the charge amount. The default value is false.
  • Links
  • Title: Percentage of Item Value
    Percent of the purchase value. It is required only when Include Item Value Flag is set to yes.
  • Title: Related Charge Line ID
    Value that uniquely identifies the related charge line for a trade operation charge.
  • Title: Related Charge Line Percentage
    Percent for each of the related charge line based on which the charge line amount will be derived.
  • Title: Total Amount
    Read Only: true
    Estimated total amount on the charge line.
  • Title: Trade Operation Charge ID
    Value that uniquely identifies the trade operation charge.
  • Title: Trade Operation Charge Related Line ID
    Value that uniquely identifies the trade operation charge related line.
Nested Schema : tradeOperations-defaultPOSchedules-item-response
Type: object
Show Source
Nested Schema : tradeOperations-tradeOperationShipments-item-response
Type: object
Show Source
Links
charges
Parameters:
  • TradeOperationId: $request.path.TradeOperationId
The Charges resource gets information about the trade operation charge line, status and the allocated amounts for each charge line.
defaultPOSchedules
Parameters:
  • TradeOperationId: $request.path.TradeOperationId
The Default Purchase Order Schedules resource gets information about the default purchase order schedules associated with a trade operation.
tradeOperationShipments
Parameters:
  • TradeOperationId: $request.path.TradeOperationId
The Trade Operation Shipments resource manages information about advanced shipment notices (ASNs) associated with a trade operation.
Back to Top

Examples

These examples describe how to get one trade operation.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId"

For example, the following command gets one trade operation where the trade operation identifier is 300100085591704:

curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704"

Example 1

This example describes how to get one trade operation.

Example 1 Response Body

The following shows an example of the response body in JSON format.

{
"CreationDate": "2015-12-11T16:06:52+00:00",
"CurrencyConversionRateType": "Corporate",
"LastUpdateDate": "2015-12-11",
"ProcurementBUId": 204,
"ProcurementBU": "Vision Corporation",
"RouteId": 300100071793259,
"Route": "East-South",
"TradeOperationCurrency": "USD",
"TradeOperationDescription": "Receipt Acct Landed Cost Charges",
"TradeOperationId": 300100085591704,
"TradeOperationName": "CMLRRF-RcptAcct",
"TradeOperationNumber": 2,
"TradeOperationStatus": "OPEN",
"TradeOperationTemplateId": null,
"TradeOperationTemplate": null,
"EstimatedTradeOperationAmount": null,
   "links":    [
   ...
   ]
}

Example 2

This example describes how to get one trade operation when Allocate Landed Cost Charges using the ASN Quantity feature is opted-in.

Example 2 Response Body

The following shows an example of the response body in JSON format.

{
    "CurrencyConversionRateType": "Corporate",
    "CreationDate": "2023-05-10T06:52:54+00:00",
    "CurrencyConversionRateTypeCode": "Corporate",
    "LastUpdateDate": "2023-05-10",
    "ProcurementBUId": 204,
    "ProcurementBU": "Vision Operations",
    "RouteId": null,
    "Route": null,
    "TradeOperationCurrency": "USD",
    "TradeOperationDescription": null,
    "TradeOperationId": 300100576036118,
    "TradeOperationName": "REST_DEMO1",
    "TradeOperationNumber": 49,
    "TradeOperationStatus": "DRAFT",
    "TradeOperationTemplateId": null,
    "TradeOperationTemplate": null,
    "EstimatedTradeOperationAmount": null,
    "AllocationQuantityTypeCode": "SHIP_QTY",
    "AllocationQuantityType": "Shipment Quantity",
    "links": [
        {
            "rel": "self",
            "href": "https://fa-eobx-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/tradeOperations/300100576036118",
            "name": "tradeOperations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://fa-eobx-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/tradeOperations/300100576036118",
            "name": "tradeOperations",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://fa-eobx-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/tradeOperations/300100576036118/lov/BusinessUnitLOV",
            "name": "BusinessUnitLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://fa-eobx-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/tradeOperations/300100576036118/lov/RouteLOV",
            "name": "RouteLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://fa-eobx-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/tradeOperations/300100576036118/lov/StatusLOV",
            "name": "StatusLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://fa-eobx-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/tradeOperations/300100576036118/lov/CurrencyCodeLOV",
            "name": "CurrencyCodeLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://fa-eobx-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/tradeOperations/300100576036118/lov/ConversionTypeLOV",
            "name": "ConversionTypeLOV",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://fa-eobx-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/tradeOperations/300100576036118/child/charges",
            "name": "charges",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://fa-eobx-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/tradeOperations/300100576036118/child/defaultPOSchedules",
            "name": "defaultPOSchedules",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://fa-eobx-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/tradeOperations/300100576036118/child/tradeOperationShipments",
            "name": "tradeOperationShipments",
            "kind": "collection"
        }
    ]
}
Back to Top