Get on-hand quantity details for an item
get
/fscmRestApi/resources/11.13.18.05/itemStockingInquiries/{itemStockingInquiriesUniqID}
Request
Path Parameters
-
itemStockingInquiriesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- OrganizationId, InventoryItemId, SubinventoryCode, LocatorId and LotNumber ---for the Item Stocking Inquiries resource and used to uniquely identify an instance of Item Stocking Inquiries. The client should not generate the hash key value. Instead, the client should query on the Item Stocking Inquiries collection resource with a filter on the primary key values in order to navigate to a specific instance of Item Stocking Inquiries.
For example: itemStockingInquiries?q=OrganizationId=<value1>;InventoryItemId=<value2>;SubinventoryCode=<value3>;LocatorId=<value4>;LotNumber=<value5>
Query Parameters
-
dependency: string
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> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : itemStockingInquiries-item-response
Type:
Show Source
object
-
Description: string
Read Only:
true
Maximum Length:240
Value that identifies the description of the item. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the inventory item. -
LastCountDate: string
(date-time)
Read Only:
true
Date when the item was last counted for a location during cycle counting. -
LastReplenishedDate: string
(date-time)
Read Only:
true
Date when the item was last replenished for a location during par counting. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Read Only:
true
Maximum Length:4000
Physical area in the subinventory such as a row, aisle, bin, or shelf, that stores the item. -
LocatorId: integer
Read Only:
true
Value that uniquely identifies the locator. -
LotNumber: string
Read Only:
true
Maximum Length:80
Number that identifies a lot. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the organization. -
ParLocation: integer
(int32)
Read Only:
true
Value that indicates if the on-hand quantity is associated with a subinventory that's enabled for a par location inventory. -
PrimaryImageURL: string
Read Only:
true
Maximum Length:4000
Value that provides a reference to the image of the item for which the count sequence is generated. -
PrimaryOnhandQuantity: number
Read Only:
true
Quantity of the item in the primary unit of measure. -
PrimaryUnitOfMeasure: string
Read Only:
true
Maximum Length:25
Primary unit of measure of the item. -
PrimaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the primary unit of measure. -
SerialNumber: string
Read Only:
true
Serial number of the item in an inventory lot. -
StockingOnhandQuantity: number
Read Only:
true
Value that indicates the on-hand quantity for an item in the stocking unit of measure of the subinventory. -
StockingUnitOfMeasure: string
Read Only:
true
Maximum Length:25
Value that indicates the unit of measure in which the items are stocked in a subinventory. -
StockingUOMCode: string
Read Only:
true
Maximum Length:4000
Value that indicates the unit of measure code in which the items are stocked in a subinventory. -
SubinventoryCode: string
Read Only:
true
Maximum Length:10
Abbreviation that identifies the subinventory in the organization. This value references a physical area or a logical grouping of items such as a storeroom or receiving dock.
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.