1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. List of Values
  5. On-hand Quantity Details

Get all details

get

/fscmRestApi/resources/11.13.18.05/onhandQuantityDetails

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 on-hand quantities.
      Finder Variables:
      • InventoryItemId; integer; Value that uniquely identifies the inventory item.
      • LocatorId; integer; Value that uniquely identifies the locator.
      • LotNumber; string; Lot number of the inventory item.
      • OrganizationId; integer; Value that uniquely identifies the organization.
      • SerialNumber; string; Serial number of the inventory item.
      • SubinventoryCode; string; Abbreviation that identifies the subinventory.
  • 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:
    • ConsignedQuantity; number; Consigned quantity for the item.
    • InboundQuantity; number; Inbound quantity for the item.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • ItemNumber; string; Name of the inventory item.
    • LocatorId; integer; Value that uniquely identifies the locator.
    • LotNumber; string; Lot number of the inventory item.
    • OnhandQuantity; number; On-hand quantity for the item.
    • OrganizationCode; string; Name of the organization.
    • OrganizationId; integer; Value that uniquely identifies the organization.
    • OwningOrganization; string; Name of the owning organization.
    • OwningOrganizationId; integer; Value that uniquely identifies the owning party.
    • PrimaryUOMCode; string; Abbreviation that identifies the primary unit of measure.
    • ReceivingQuantity; number; Receiving quantity for the item.
    • ReservedQuantity; number; Reserved quantity for the item.
    • SecondaryConsignedQuantity; number; Secondary consigned quantity for the item.
    • SecondaryInboundQuantity; number; Secondary inbound quantity for the item.
    • SecondaryOnhandQuantity; integer; Secondary on-hand quantity for the item.
    • SecondaryReceivingQuantity; number; Secondary receiving quantity for the item.
    • SecondaryReservedQuantity; number; Secondary reserved quantity for the item.
    • SecondaryUOMCode; string; Abbreviation that identifies the secondary unit of measure.
    • SerialNumber; string; Serial number of the item.
    • SubinventoryCode; string; Name of the subinventory.
  • 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 : onhandQuantityDetails
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : onhandQuantityDetails-item-response
Type: object
Show Source
Nested Schema : Consigned Quantity Details
Type: array
Title: Consigned Quantity Details
The Consigned Quantity Details resource uses information about the item and inventory location that you provide to get details about the consigned quantities in the primary UOM or secondary UOM.
Show Source
Nested Schema : Inbound Quantity Details
Type: array
Title: Inbound Quantity Details
The Inbound Quantity Details resource uses information about the item and inventory location that you provide to get details about the inbound quantities in the primary UOM or secondary UOM.
Show Source
Nested Schema : onhandQuantityDetails-ConsignedQuantityDetails-item-response
Type: object
Show Source
Nested Schema : onhandQuantityDetails-InboundQuantityDetails-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all on-hand quantity details for one item.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example gets all on-hand quantity details for item 300100036705248 in organization 207:

curl -u username:password "https://servername/fscmRestApi/resources/version/onhandQuantityDetails?q=InventoryItemId=300100036705248;OrganizationId=207&onlyData=true&expand=all"

Example Response Body

The following example includes the contents of the response body in JSON format:

"
{
  "items" : [ {
    "OrganizationId" : 207,
    "OrganizationCode" : "M1",
    "InventoryItemId" : 300100036705248,
    "ItemNumber" : "zRel9BIA_CONS_INV019",
    "SubinventoryCode" : null,
    "LocatorId" : null,
    "LotNumber" : null,
    "OnhandQuantity" : 59,
    "SecondaryOnhandQuantity" : 5.41666,
    "ReceivingQuantity" : null,
    "SecondaryReceivingQuantity" : null,
    "ReservedQuantity" : null,
    "SecondaryReservedQuantity" : null,
    "InboundQuantity" : 54,
    "SecondaryInboundQuantity" : null,
    "ConsignedQuantity" : 53,
    "SecondaryConsignedQuantity" : 4.91666,
    "OwningOrganizationId" : null,
    "OwningOrganization" : null,
    "SerialNumber" : null,
    "PrimaryUOMCode" : "Ea",
    "SecondaryUOMCode" : "DZ",
    "ConsignedQuantityDetails" : [ {
      "ConsignedQuantity" : 53,
      "SecondaryConsignedQuantity" : 4.91666,
      "PartyName" : "zREL9_CONS_Supplier",
      "PartyType" : "ORGANIZATION",
      "PartyNumber" : "CDRM_75652"
    } ],
    "InboundQuantityDetails" : [ {
      "InboundQuantity" : 54,
      "SecondaryInboundQuantity" : null,
      "DocumentNumber" : "1002886",
      "LineNumber" : 3,
      "Schedule" : "1",
      "DocumentType" : "Purchase order"
    } ]
  }, {
    "OrganizationId" : 207,
    "OrganizationCode" : "M1",
    "InventoryItemId" : 300100036705248,
    "ItemNumber" : "zRel9BIA_CONS_INV019",
    "SubinventoryCode" : "Stores",
    "LocatorId" : null,
    "LotNumber" : null,
    "OnhandQuantity" : 50,
    "SecondaryOnhandQuantity" : 4.66666,
    "ReceivingQuantity" : null,
    "SecondaryReceivingQuantity" : null,
    "ReservedQuantity" : null,
    "SecondaryReservedQuantity" : null,
    "InboundQuantity" : null,
    "SecondaryInboundQuantity" : null,
    "ConsignedQuantity" : null,
    "SecondaryConsignedQuantity" : null,
    "OwningOrganizationId" : null,
    "OwningOrganization" : null,
    "SerialNumber" : null,
    "PrimaryUOMCode" : "Ea",
    "SecondaryUOMCode" : "DZ",
    "ConsignedQuantityDetails" : [ {
      "ConsignedQuantity" : 44,
      "SecondaryConsignedQuantity" : 4.16666,
      "PartyName" : "zREL9_CONS_Supplier",
      "PartyType" : "ORGANIZATION",
      "PartyNumber" : "CDRM_75652"
    } ],
    "InboundQuantityDetails" : [ ]
}, {
    "OrganizationId" : 207,
    "OrganizationCode" : "M1",
    "InventoryItemId" : 300100036705248,
    "ItemNumber" : "zRel9BIA_CONS_INV019",
    "SubinventoryCode" : "SLC_DEST",
    "LocatorId" : null,
    "LotNumber" : null,
    "OnhandQuantity" : 9,
    "SecondaryOnhandQuantity" : 0.75,
    "ReceivingQuantity" : null,
    "SecondaryReceivingQuantity" : null,
    "ReservedQuantity" : null,
    "SecondaryReservedQuantity" : null,
    "InboundQuantity" : null,
    "SecondaryInboundQuantity" : null,
    "ConsignedQuantity" : null,
    "SecondaryConsignedQuantity" : null,
    "OwningOrganizationId" : null,
    "OwningOrganization" : null,
    "SerialNumber" : null,
    "PrimaryUOMCode" : "Ea",
    "SecondaryUOMCode" : "DZ",
    "ConsignedQuantityDetails" : [ {
      "ConsignedQuantity" : 9,
      "SecondaryConsignedQuantity" : 0.75,
      "PartyName" : "zREL9_CONS_Supplier",
      "PartyType" : "ORGANIZATION",
      "PartyNumber" : "CDRM_75652"
    } ],
    "InboundQuantityDetails" : [ ]
  } ],
  "count" : 3,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/onhandQuantityDetails",
    "name" : "onhandQuantityDetails",
    "kind" : "collection"
  } ]
}"
Back to Top