1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Inventory Staged Transactions

Get all transactions

get

/fscmRestApi/resources/11.13.18.05/inventoryStagedTransactions

Request

Query Parameters
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Find inventory staged transaction according to the primary key.
      Finder Variables:
      • TransactionInterfaceId; integer; Value that uniquely identifies the transaction.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AccountAliasCombination; string; Combination of the inventory transactions for an account alias.
    • AccountCombination; string; Combination of the inventory transactions for a specified account combination.
    • AssessableValue; number; Price that the tax authority uses to calculate tax for the item.
    • Carrier; string; Name of the carrier.
    • CategoryName; string; Name of the category.
    • ChartOfAccountsId; integer; Value that uniquely identifies the chart of accounts.
    • ConsignmentAgreementNumber; string; Number that identifies the consignment agreement.
    • Containers; number; Value that identifies the container to use when packing the unit.
    • CreatedBy; string; User who created the transaction.
    • CreationDate; string; Date when the user created the transaction.
    • DefaultTaxationCountry; string; Abbreviation that identifies the default country for taxation.
    • DemandSourceDelivery; string; Value that identifies the shipment in the demand document.
    • DemandSourceHeaderId; integer; Value that uniquely identifies the demand source header.
    • DemandSourceLine; string; Value that identifies the line in the demand document.
    • DistributionAccountId; integer; Value that uniquely identifies the distribution account.
    • DocumentSubType; string; Abbreviation that identifies the classification of the fiscal document.
    • ErrorCode; string; Abbreviation that identifies the error.
    • ErrorExplanation; string; Explanation of why the error occurred.
    • ExemptCertificateNumber; string; Number that identifies the exempt certificate.
    • ExemptReasonCode; string; Abbreviation that identifies the reason for exemption.
    • ExpectedArrivalDate; string; Date when the item is expected to arrive.
    • ExternalSystemPackingUnit; string; Name of the packing unit in the external application.
    • ExternalSystemTransactionReference; string; Value that refers to the corresponding transaction in external applications.
    • FinalDischargeLocCode; string; Abbreviation that identifies the final discharge location.
    • FirstPtyNumber; string; Number that identifies the first party of the transaction.
    • FreightCarrierId; integer; Value that uniquely identifies the carrier.
    • IntendedUse; string; Value that identifies the classification for the intended use.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • ItemDescription; string; Description of the item.
    • ItemNumber; string; Inventory item number.
    • LoadRequestId; integer; Value that uniquely identifies the Load Interface File for Import scheduled process that uploaded the transaction.
    • LocatorId; integer; Value that uniquely identifies the stock locator.
    • LocatorName; string; Description of the stock locators.
    • LockStatus; string; Current status of the lock.
    • LotTransactionGroupName; string; Name of the group of lot split, merge, and translate transactions data. This value is defined by the user.
    • OrganizationId; integer; Value that uniquely identifies the organization.
    • OrganizationName; string; Name of the organization.
    • OwningOrganizationId; integer; Value that uniquely identifies the owning organization.
    • OwningOrganizationName; string; Name of the owning organization.
    • OwningTpType; string; Type of owning trading partner.
    • PrimaryQuantity; number; Transaction quantity in the primary unit of measure that the item uses.
    • ProcessStatus; string; Current status of the process.
    • ProcurementBusinessUnitName; string; Name of the business unit that procured the item.
    • ProductCategory; string; Name of the product category of the transaction.
    • ProductType; string; Type of the product of the transaction.
    • ReasonId; integer; Value that uniquely identifies the inventory staged transaction reason.
    • ReasonName; string; Name of the inventory staged transaction reason.
    • RepresentativeLotFlag; boolean; Contains one of the following values: true or false. If true, then the data belongs to the representative source lot for a lot merge transaction type. The lot attributes from the representative source lot will be copied to the resultant lot. If false, then the lot is not the representative source lot. This attribute does not have a default value.
    • RequesterId; string; Value that uniquely identifies the person who requested the material issued or received.
    • RequesterName; string; Name of the person who requested the material issued or received.
    • RequesterNumber; string; Number that uniquely identifies the person who requested the material issued or received. This value is defined by the user.
    • Revision; string; Revision of the inventory item.
    • SecondaryInventoryName; string; Name of the secondary inventory.
    • SecondaryTransactionQuantity; number; Transaction quantity of an item in its secondary unit of measure.
    • SecondaryUOMCode; string; Abbreviation that identifies the secondary unit of measure that does not have a fixed conversion from the primary unit of measure. Also, this is part of the dual unit of measure record keeping that enables industries to maintain and use inventory in both quantity and weight units of measure, or volume and length units of measure.
    • SecondaryUnitOfMeasure; string; Secondary unit of measure in which an item can be transacted.
    • ShipmentNumber; string; Number that identifies the shipment.
    • SourceCode; string; Abbreviation that identifies the source.
    • SourceHeaderId; integer; Value that uniquely identifies the source header.
    • SourceLineId; integer; Value that uniquely identifies the source line.
    • SourceLotFlag; boolean; Contains one of the following values: true or false. If true, then the data belongs to the source lot of lot split, merge, and translate transaction types. If false, then the data belongs to the resultant lot of split, merge, and translate transaction types. This attribute does not have a default value.
    • StructureInstanceNumber; integer; Number that identifies the structure instance.
    • SubinventoryCode; string; Abbreviation that identifies the subinventory.
    • SubinventoryId; integer; Value that uniquely identifies the subinventory.
    • TaxClassificationCode; string; Abbreviation that identifies the tax classification.
    • TaxInvoiceDate; string; Date and time of generation of the tax invoice document.
    • TaxInvoiceNumber; string; Number of the tax invoice document.
    • ThirdPtyNumber; string; Number that identifies the third party of the transaction.
    • TransactionActionId; string; Value that uniquely identifies the transaction action.
    • TransactionActionName; string; Name of the transaction action.
    • TransactionBatchId; integer; Value that uniquely identifies the transaction batch.
    • TransactionBatchSequence; integer; Sequence number that identifies the transaction batch.
    • TransactionCost; number; Cost incurred for the transaction.
    • TransactionCostIdentifier; string; Value that uniquely identifies the transaction cost.
    • TransactionDate; string; Date when the transaction occurred.
    • TransactionGroupId; integer; Value that uniquely identifies the transaction group.
    • TransactionGroupSequence; number; Sequence number that identifies the transaction group.
    • TransactionHeaderId; integer; Value that uniquely identifies the transaction header.
    • TransactionInterfaceId; integer; Value that uniquely identifies the transaction.
    • TransactionMode; string; Indicates the transaction mode.
    • TransactionQuantity; number; Transacted quantity of the item.
    • TransactionReference; string; Reference to the transaction.
    • TransactionSourceId; integer; Value that uniquely identifies the transaction source.
    • TransactionSourceName; string; Name of the transaction source.
    • TransactionSourceTypeId; integer; Value that uniquely identifies the transaction source type name.
    • TransactionSourceTypeName; string; Name of the transaction source type.
    • TransactionTypeId; integer; Value that uniquely identifies the transaction type.
    • TransactionTypeName; string; Name of the transaction type.
    • TransactionUOM; string; Abbreviation that identifies the unit of measure for the transaction.
    • TransactionUnitOfMeasure; string; Unit of measure for the transaction.
    • TransferCost; number; Cost incurred for the transfer.
    • TransferInvProject; string; Number that identifies the destination project for the project transfer transactions. This attribute is associated with a feature that requires opt in.
    • TransferInvTask; string; Number that identifies the destination task for the project transfer transactions. This attribute is associated with a feature that requires opt in.
    • TransferLocator; integer; Destination locator for a transfer transaction.
    • TransferLocatorName; string; Name of the destination locator for a transfer transaction.
    • TransferLocatorsSIN; integer; Structure instance number of the transfer locators.
    • TransferOrganization; integer; Value that uniquely identifies the destination organization for transfer transactions.
    • TransferOrganizationName; string; Name of the transfer organization.
    • TransferOwningOrganizationId; integer; Value that uniquely identifies the organization that owns the transfer.
    • TransferOwningOrganizationName; string; Name of the organization that owns the transfer.
    • TransferOwningTpType; string; Type of trading party owning the transfer.
    • TransferProjectId; integer; Value that uniquely identifies the destination project for the project transfer transactions. This attribute is associated with a feature that requires opt in.
    • TransferSubInventoryId; integer; Value that uniquely identifies the transfer subinventory.
    • TransferSubinventory; string; Name of the destination subinventory for a transfer transaction.
    • TransferTaskId; integer; Value that uniquely identifies the destination task for the project transfer transactions. This attribute is associated with a feature that requires opt in.
    • TransportationCost; number; Cost incurred for the transportation.
    • TrxBusinessCategory; string; Name of the transaction business category.
    • TrxSourceDeliveryId; integer; Value that uniquely identifies the transaction source shipment.
    • TrxSourceLineId; integer; Value that uniquely identifies the transaction source line.
    • UseCurrentCostFlag; boolean; Contains one of the following values: true or false. If true, then use the current item cost. If false, then do not use the current item cost. This attribute does not have a default value. This attribute is mandatory.
    • UserDefinedFiscClass; string; Name of the fiscal classification.
    • VendorName; string; Name of the vendor.
    • VendorNumber; string; Number that identifies the vendor.
    • WaybillAirbill; string; Number that identifies the waybill or airbill.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : inventoryStagedTransactions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : inventoryStagedTransactions-item-response
Type: object
Show Source
Nested Schema : Costs
Type: array
Title: Costs
The Costs resource manages the costs associated with the inventory staged transaction.
Show Source
Nested Schema : Flexfields for Inventory Staged Transactions
Type: array
Title: Flexfields for Inventory Staged Transactions
The Flexfields for Inventory Staged Transactions resource manages the descriptive flexfields defined for the transaction.
Show Source
Nested Schema : Lots
Type: array
Title: Lots
The Lots resource manages the lots of a staged inventory transaction.
Show Source
Nested Schema : Project Cost Details
Type: array
Title: Project Cost Details
The Project Cost Details resource manages the project cost elements associated with the inventory staged transaction.
Show Source
Nested Schema : Serials
Type: array
Title: Serials
The Serials resource manages the serials of a staged inventory transaction for a serial controlled item.
Show Source
Nested Schema : Tracking Attributes
Type: array
Title: Tracking Attributes
The Tracking Attributes resource manages the inventory tracking attribute associated with the inventory staged transaction. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : inventoryStagedTransactions-costs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-dFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-lots-item-response
Type: object
Show Source
Nested Schema : Flexfields for Lot Attributes
Type: array
Title: Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the lot attributes descriptive flexfields for a lot controlled item.
Show Source
Nested Schema : Lot Serials
Type: array
Title: Lot Serials
The Lot Serials resource manages the serials for a lot of a staged inventory transaction when an item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Lots
Type: array
Title: Flexfields for Lots
The Flexfields for Lots resource manages the lot descriptive flexfields for a lot controlled item.
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotSerials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Serial Attributes
Type: array
Title: Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the serial attributes descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : Flexfields for Serials
Type: array
Title: Flexfields for Serials
The Flexfields for Serials resource manages the serial descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotSerials-serialAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotSerials-serialStandardDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotStandardDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-projectCostingDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-serials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Serial Attributes
Type: array
Title: Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the serial attributes descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : Flexfields for Serials
Type: array
Title: Flexfields for Serials
The Flexfields for Serials resource manages the serial descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : inventoryStagedTransactions-serials-serialAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-serials-serialStandardDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-trackingAttributesDFF-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 40
    Descriptive flexfield context name for tracking attributes. This attribute is associated with a feature that requires opt in.
  • Title: Context Segment
    Descriptive flexfield context display value for tracking attributes. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Maximum Length: 2
    Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Name of the country of origin. This attribute is associated with a feature that requires opt in.
  • Links
  • Title: Project
    Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Number that identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Number that identifies the task. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the transaction. This attribute is associated with a feature that requires opt in.
Back to Top

Examples

This example describes how to get all transactions.

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/inventoryStagedTransactions"

Example Response Body

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

{
    "items": [
        {
            "OrganizationId": 207,
            "OrganizationName": "Seven Corporation",
            "InventoryItemId": 606,
            "ItemNumber": "CM11222",
            "ItemDescription": "Battery - Extended Life",
            "Revision": null,
            "SubinventoryCode": "Stores",
            "LocatorId": 799,
            "LocatorName": "1.1.1",
   ...

        },
        {
            "OrganizationId": 207,
            "OrganizationName": "Seven Corporation",
            "InventoryItemId": 127677,
            "ItemNumber": "CR1000",
            "ItemDescription": "Cisco Router",
            "Revision": null,
            "SubinventoryCode": "Stores",
            "LocatorId": 799,
            "LocatorName": "1.1.1",
   ...
        },
  ...
    ],
    "count": 23,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/inventoryStagedTransactions",
            "name": "inventoryStagedTransactions",
            "kind": "collection"
        }
    ]
}
Back to Top