1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Item Shortage Details by Kanban Locations

Get all item shortage details

get

/fscmRestApi/resources/11.13.18.05/itemShortageDetailsByKanbanLocations

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 Finds the item shortage detail with the specified primary key.
      Finder Variables
      • InventoryItemId; integer; Value that uniquely identifies the inventory item.
      • Locator; string; Name of the locator
      • OrganizationId; integer; Value that uniquely identifies the inventory organization.
      • Subinventory; string; Name of the subinventory.
    • findStockoutORShortageItems Finds the item shortage or stockout detail.
      Finder Variables
      • bindActualDemandDays; integer;
      • bindCatalogId; integer;
      • bindCategoryId; integer;
      • bindContext; string;
      • bindOrganizationId; 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.
  • 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:
    • ActualDemandQuantity; number; Value that indicates the current demand for the item.
    • AvailableElsewhereFlag; boolean; Indicates whether the item is available in other locations or not.
    • AvailableToTransactQuantity; number; Value that indicates the available to transact quantity for the item in the location.
    • AverageDemandPeriod; string; Indicates the time frame that's used for calculating the average demand.
    • AverageDemandQuantity; number; Value that indicates the historical demand for the item.
    • DemandTrendPercentage; number; Value that indicates the demand trend that's calculated using the current and historical demand.
    • InboundSupplyAvailableFlag; boolean; Indicates whether the item has any open inbound supplies.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • ItemMaximumValue; string; Maximum quantity for the item defined for the location.
    • ItemMinimumValue; number; Minimum quantity for the item defined for the location.
    • ItemNumber; string; Number that identifies the inventory item.
    • KanbanSize; number; Quantity in the Kanban bin.
    • LocationControlCode; number; Indicates the type of locator control. A list of accepted values is defined in the lookup type EGP_LOCATOR_CONTROL_CODE_TYPE.
    • Locator; string; Name of the locator
    • LocatorId; integer; Value that uniquely identifies the locator.
    • NumberOfCards; number; Number of Kanban cards in the pull sequence.
    • OnhandQuantity; number; Value that indicates the on-hand quantity for the item in a location.
    • OpenDemandPeriod; string; Indicates the time frame that's used for restricting the open demand.
    • OpenSupplyPeriod; string; Indicates the time frame that's used for restricting the open supply.
    • OrganizationId; integer; Value that uniquely identifies the organization.
    • PrimaryUnitOfMeasure; string; Primary unit of measure of the item.
    • PrimaryUnitOfMeasureCode; string; Abbreviation that identifies the primary unit of measure.
    • PurchasingEnabledFlag; boolean; Contains one of the following values: true or false. If true, then allow the application to add the item to the purchase order. If false, then don't allow it to add the item.
    • RestrictLocatorsCode; number; Value to indicate whether to restrict the transaction of this item to or from a locator.
    • RestrictSubinventoriesCode; number; Value to indicate whether to restrict the transaction of this item to or from a subinventory.
    • RevisionQuantityControlCode; number; Value to indicate whether the item is under revision control and includes inventory attributes.
    • SecondaryActualDemandQuantity; number; Value that indicates the current demand for the item in the secondary unit of measure.
    • SecondaryAvailableToTransactQuantity; number; Value that indicates the secondary available-to-transact quantity for the item in the location.
    • SecondaryAverageDemandQuantity; number; Value that indicates the historical demand for the item in the secondary unit of measure.
    • SecondaryOnhandQuantity; number; Value that indicates the secondary on-hand quantity for the item in an organization.
    • SecondaryUnitOfMeasure; string; Secondary unit of measure of the item.
    • SecondaryUnitOfMeasureCode; string; Abbreviation that identifies the secondary unit of measure.
    • ShortageThreshold; string; Indicates the percentage of the on hand below the minimum quantity that's used to identify items as shortage.
    • StockEnabledFlag; boolean; Contains one of the following values: true or false. If true, then the item can be stocked in inventory. If false, then the item can't be stocked in inventory.
    • Subinventory; string; Name of the subinventory.
    • SubinventoryName; string; Name of the subinventory.
    • SubstituteItemAvailableFlag; boolean; Indicates whether the substitute item is available in other location.
    • SupplyDelayedFlag; boolean; Indicates whether inbound supply for the item is delayed.
    • TotalCount; string; Number of inventory items that are stocked out or in shortage.
    • TransferOrderEnabledFlag; boolean; Contains one of the following values: true or false. If true, then the item can be ordered on an internal requisition. If false, then item can't be ordered based on an internal requisition.
  • 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 : itemShortageDetailsByKanbanLocations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : itemShortageDetailsByKanbanLocations-item-response
Type: object
Show Source
Back to Top