Get all details
get
/fscmRestApi/resources/11.13.18.05/onhandQuantityDetails
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
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.
- PrimaryKey: Find on-hand quantities.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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.
-
totalResults: boolean
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
-
Metadata-Context:
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:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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:
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.
Root Schema : onhandQuantityDetails
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : onhandQuantityDetails-item-response
Type:
Show Source
object
-
ConsignedQuantity: number
Read Only:
true
Consigned quantity for the item. -
ConsignedQuantityDetails: array
Consigned Quantity Details
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. -
InboundQuantity: number
Read Only:
true
Inbound quantity for the item. -
InboundQuantityDetails: array
Inbound Quantity Details
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. -
InventoryItemId: integer
Read Only:
true
Value that uniquely identifies the inventory item. -
ItemNumber: string
Read Only:
true
Maximum Length:255
Name of the inventory item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocatorId: integer
Read Only:
true
Value that uniquely identifies the locator. -
LotNumber: string
Read Only:
true
Maximum Length:255
Lot number of the inventory item. -
OnhandQuantity: number
Read Only:
true
On-hand quantity for the item. -
OrganizationCode: string
Read Only:
true
Maximum Length:255
Name of the organization. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the organization. -
OwningOrganization: string
Read Only:
true
Maximum Length:255
Name of the owning organization. -
OwningOrganizationId: integer
Read Only:
true
Value that uniquely identifies the owning party. -
PrimaryUOMCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the primary unit of measure. -
ReceivingQuantity: number
Read Only:
true
Receiving quantity for the item. -
ReservedQuantity: number
Read Only:
true
Reserved quantity for the item. -
SecondaryConsignedQuantity: number
Read Only:
true
Secondary consigned quantity for the item. -
SecondaryInboundQuantity: number
Read Only:
true
Secondary inbound quantity for the item. -
SecondaryOnhandQuantity: integer
(int64)
Read Only:
true
Secondary on-hand quantity for the item. -
SecondaryReceivingQuantity: number
Read Only:
true
Secondary receiving quantity for the item. -
SecondaryReservedQuantity: number
Read Only:
true
Secondary reserved quantity for the item. -
SecondaryUOMCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the secondary unit of measure. -
SerialNumber: string
Read Only:
true
Maximum Length:255
Serial number of the item. -
SubinventoryCode: string
Read Only:
true
Maximum Length:255
Name of the subinventory.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : onhandQuantityDetails-ConsignedQuantityDetails-item-response
Type:
Show Source
object
-
ConsignedQuantity: number
Read Only:
true
Consigned quantity for the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyName: string
Read Only:
true
Maximum Length:360
Name of the owning party. -
PartyNumber: string
Read Only:
true
Maximum Length:30
Name of the owning party. -
PartyType: string
Read Only:
true
Maximum Length:30
Value that indicates the type of owning party. Valid values are Person, Organization, or Group. -
SecondaryConsignedQuantity: number
Read Only:
true
Secondary consigned quantity for the item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : onhandQuantityDetails-InboundQuantityDetails-item-response
Type:
Show Source
object
-
DocumentNumber: string
Read Only:
true
Maximum Length:30
Document number that identifies the inbound shipment. -
DocumentType: string
Read Only:
true
Type of document. -
InboundQuantity: number
Read Only:
true
Inbound quantity for the item. -
LineNumber: number
Read Only:
true
Value that identifies the line number for the inbound shipment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Schedule: string
Read Only:
true
Schedule for the shipment. -
SecondaryInboundQuantity: number
Read Only:
true
Secondary inbound quantity for the item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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" } ] }"