GET action not supported
get
/fscmRestApi/resources/11.13.18.05/availableQuantityDetails/{availableQuantityDetailsUniqID}
Request
Path Parameters
-
availableQuantityDetailsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Available Quantity Details resource and used to uniquely identify an instance of Available Quantity Details. The client should not generate the hash key value. Instead, the client should query on the Available Quantity Details collection resource in order to navigate to a specific instance of Available Quantity Details to get the hash key.
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 : availableQuantityDetails-item-response
Type:
Show Source
object
-
AvailableToReserve: number
Quantity of an item available to reserve.
-
AvailableToTransact: number
Quantity that is available for transactions after the warehouse considers allocations and reservations.
-
InventoryCountryOfOrigin: string
Name of the inventory country of origin. This attribute is associated with a feature that requires opt in.
-
InventoryCountryOfOriginCode: string
Abbreviation that identifies the inventory country of origin. This attribute is associated with a feature that requires opt in.
-
InventoryItemId: integer
Value that uniquely identifies the inventory item.
-
InventoryProject: string
Name of the inventory project. This attribute is associated with a feature that requires opt in.
-
InventoryProjectId: integer
Value that uniquely identifies the inventory project. This attribute is associated with a feature that requires opt in.
-
InventoryTask: string
Name of inventory task. This attribute is associated with a feature that requires opt in.
-
InventoryTaskId: integer
Value that uniquely identifies the inventory task associated with the inventory project. This attribute is associated with a feature that requires opt in.
-
ItemNumber: string
Name of the item.
-
ItemRevision: string
Revision of the item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Description of the stock locators. It is typically a physical area in the subinventory, such as a row, aisle, bin, or shelf, that stores the item.
-
LocatorId: integer
Value that uniquely identifies the stock locator.
-
Lot: string
Number that identifies an item or group of items.
-
OrganizationCode: string
Abbreviation that identifies the inventory organization.
-
OrganizationId: integer
Value that uniquely identifies the inventory organization.
-
OwningEntityId: integer
Value that uniquely identifies the owning party.
-
OwningPartySite: string
Name corresponding to the owning entity identifier.
-
PrimaryUnitOfMeasure: string
Primary unit of measure of the item.
-
QuantityOnhand: number
On-hand quantity for the item.
-
ReceivingTransactionId: integer
Value that uniquely identifies the receiving transaction.
-
ReturnMessageName: string
Message name to use if a failure occurs.
-
ReturnMessageText: string
Message text to use if a failure occurs.
-
ReturnStatus: string
Return status of the resource. Values include SUCCESS or ERROR.
-
SecondaryAvailableToReserve: number
Quantity available to reserve in the secondary unit of measure.
-
SecondaryAvailableToTransact: number
Quantity that is available for transactions in the secondary unit of measure.
-
SecondaryQuantityOnhand: number
On-hand quantity for the item in the secondary unit of measure.
-
SecondaryUnitOfMeasure: string
Secondary unit of measure of the item.
-
Subinventory: string
Name of the subinventory.
-
TreeMode: integer
Parameter that determines the way the available quantity is calculated. Values include 1, 2, 4, and 5. 1 and 2 is for transaction mode. 4 is for transfer to owned mode. 5 is for transfer to consigned mode.
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.