1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Inventory Management
  4. Subinventories

Get all subinventories

get

/fscmRestApi/resources/11.13.18.05/subinventories

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 subinventory.
      Finder Variables:
      • OrganizationId; integer; Value that uniquely identifies the organization that owns the subinventory.
      • SecondaryInventoryName; string; Name of the secondary inventory to use when finding the subinventory.
    • findByOrganizationId: Finds the subinventory.
      Finder Variables:
      • BindItem; string; Name of the inventory item.
      • BindOrganizationId; integer; Value that uniquely identifies the organization.
  • 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:
    • AssetSubinventory; integer; Determines whether or not to consider the inventory in the subinventory as an asset. Contains one of the following values. 1: asset subinventory. 2: not an asset subinventory. The default value is 1.
    • CountMethod; string; Indicates the method to use to replenish. Values include Two-Bin, Request, or Count. A list of accepted values is defined in the lookup type ORA_REPLENISHMENT_COUNT_METHOD. The default value is COUNT.
    • CountMethodMeaning; string; Value of the replenishment count method for a subinventory.
    • CreationDate; string; Date when the user created the subinventory record.
    • DefaultCountType; string; Value of the default replenishment count type for the subinventory.
    • DefaultCountTypeCode; string; Abbreviation that identifies the replenishment type to use with Periodic Automatic Replenishment in the subinventory. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is 4.
    • DefaultLocStatusCode; string; Abbreviation that identifies the default material status to use for the locators for this subinventory.
    • DefaultLocStatusId; integer; Value that uniquely identifies the default material status for the locators that reference this subinventory. The default value is 1.
    • Depreciable; integer; Determines whether or not the inventory in this subinventory is depreciable. Contains one of the following values. 1: depreciable subinventory. 2: not a depreciable subinventory. The default value is 2.
    • Description; string; Description of the subinventory.
    • DisableDate; string; Date when the subinventory is disabled for use in the application.
    • FillKillToLookupMeaning; string; Value of the Fill Kill status for a subinventory.
    • LocationCode; string; Abbreviation that identifies the value that identifies the location that references the subinventory.
    • LocationId; integer; Value that uniquely identifies the location that references the subinventory.
    • LocatorControl; string; Type of locator control that references the subinventory. A list of accepted values is defined in the lookup type INV_SUB_LOCATOR_CONTROL. The default value is 1.
    • LocatorControlMeaning; string; Value of the locator control for a subinventory.
    • LocatorStructure; integer; Value that uniquely identifies the locator structure for the subinventory when a locator controls the subinventory.
    • LocatorStructureMeaning; string; Value of the locator structure for the subinventory when the subinventory is a locator control.
    • MaterialStatusCode; string; Abbreviation that identifies the material status that references the subinventory.
    • MaterialStatusId; integer; Value that uniquely identifies the material status that references the subinventory. The default value is 1.
    • OracleHealthLocation; string; Value that indicates if the subinventory is enabled to sync with Oracle Health.
    • OrganizationCode; string; Abbreviation that identifies the organization that references the subinventory.
    • OrganizationId; integer; Value that uniquely identifies the organization that references the subinventory.
    • ParLocation; integer; Determines whether or not the subinventory is a Periodic Automatic Replenishment location. Contains one of the following values. 1: Yes subinventory. 2: No, not the subinventory. The default value is 2.
    • PickingOrder; integer; Picking order for the subinventory.
    • PostprocessingLeadTime; integer; Post processing lead time to use while sourcing the item.
    • PreprocessingLeadTime; integer; Preprocessing lead time to use while sourcing the item.
    • ProcessingLeadTime; integer; Processing lead time to use while sourcing the item.
    • QuantityTracked; integer; Determines whether or not to track the subinventory.
    • SecondaryInventoryName; string; Name of the subinventory.
    • SourceOrganizationCode; string; Abbreviation that identifies the source organization. Used while sourcing the material to this subinventory.
    • SourceOrganizationId; integer; Value that uniquely identifies the source organization. Used while sourcing the material to this subinventory.
    • SourceOrganizationName; string; Name of the source organization. This organization is used while sourcing the material for this subinventory.
    • SourceSubinventory; string; Name of the source subinventory. Used while sourcing the material to this subinventory.
    • SourcingType; string; Sourcing type to use to replenish stock for this subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES.
    • SourcingTypeMeaning; string; Value of the sourcing type to use to replenish stock for a subinventory.
    • SubinventoryGroup; string; Name of the subinventory group.
    • SubinventoryType; string; Type of subinventory, such as Storage or Receiving. A list of accepted values is defined in the lookup type INV_SUB_TYPE. The default value is 1.
    • SubinventoryTypeMeaning; string; Value of the subinventory type.
    • UsePackingUnitForProductCompletionAndReturnCode; string; Value indicates whether to use the packing unit for product completion and return transactions in manufacturing and maintenance. This is used only when the subinventory is enabled for manufacturing and maintenance integration with WMS. Valid values are 1 or 2.
    • UseSubinventoryForManufacturingAndMaintenanceInWmsCode; string; Value that indicates whether the subinventory is used for manufacturing and maintenance integration with WMS. Valid values are 1 or 2.
  • 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 : subinventories
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : subinventories-item-response
Type: object
Show Source
  • Title: Asset subinventory
    Default Value: 1
    Determines whether or not to consider the inventory in the subinventory as an asset. Contains one of the following values. 1: asset subinventory. 2: not an asset subinventory. The default value is 1.
  • Title: Replenishment Count Method
    Maximum Length: 30
    Indicates the method to use to replenish. Values include Two-Bin, Request, or Count. A list of accepted values is defined in the lookup type ORA_REPLENISHMENT_COUNT_METHOD. The default value is COUNT.
  • Maximum Length: 255
    Value of the replenishment count method for a subinventory.
  • Read Only: true
    Date when the user created the subinventory record.
  • Maximum Length: 255
    Value of the default replenishment count type for the subinventory.
  • Title: Default Replenishment Count Type
    Maximum Length: 30
    Default Value: 4
    Abbreviation that identifies the replenishment type to use with Periodic Automatic Replenishment in the subinventory. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is 4.
  • Maximum Length: 255
    Abbreviation that identifies the default material status to use for the locators for this subinventory.
  • Title: Default Locator Status
    Value that uniquely identifies the default material status for the locators that reference this subinventory. The default value is 1.
  • Title: Depreciable
    Default Value: 2
    Determines whether or not the inventory in this subinventory is depreciable. Contains one of the following values. 1: depreciable subinventory. 2: not a depreciable subinventory. The default value is 2.
  • Title: Description
    Maximum Length: 50
    Description of the subinventory.
  • Title: End Date
    Date when the subinventory is disabled for use in the application.
  • Maximum Length: 30
    FillKill status for this subinventory. A list of accepted values is defined in the lookup type ORA_INV_TO_FILLKILL_OPTIONS. The default value is NEXT_LEVEL.
  • Maximum Length: 255
    Value of the Fill Kill status for a subinventory.
  • Item Subinventories
    Title: Item Subinventories
    The Item Subinventories resource manages operations on item subinventories.
  • Links
  • Maximum Length: 60
    Abbreviation that identifies the value that identifies the location that references the subinventory.
  • Title: Location
    Value that uniquely identifies the location that references the subinventory.
  • Title: Locator Control
    Maximum Length: 30
    Type of locator control that references the subinventory. A list of accepted values is defined in the lookup type INV_SUB_LOCATOR_CONTROL. The default value is 1.
  • Maximum Length: 255
    Value of the locator control for a subinventory.
  • Locators
    Title: Locators
    The Locators resource manages operations on locators. It allows the user to create, update and delete the subinventories.
  • Title: Locator Structure
    Value that uniquely identifies the locator structure for the subinventory when a locator controls the subinventory.
  • Maximum Length: 255
    Value of the locator structure for the subinventory when the subinventory is a locator control.
  • Maximum Length: 255
    Abbreviation that identifies the material status that references the subinventory.
  • Title: Material Status
    Default Value: 1
    Value that uniquely identifies the material status that references the subinventory. The default value is 1.
  • Maximum Length: 1
    Value that indicates if the subinventory is enabled to sync with Oracle Health.
  • Maximum Length: 255
    Abbreviation that identifies the organization that references the subinventory.
  • Value that uniquely identifies the organization that references the subinventory.
  • Title: PAR location
    Default Value: 2
    Determines whether or not the subinventory is a Periodic Automatic Replenishment location. Contains one of the following values. 1: Yes subinventory. 2: No, not the subinventory. The default value is 2.
  • Title: Picking Order
    Picking order for the subinventory.
  • Title: Postprocessing
    Post processing lead time to use while sourcing the item.
  • Title: Preprocessing
    Preprocessing lead time to use while sourcing the item.
  • Title: Processing
    Processing lead time to use while sourcing the item.
  • Title: Quantity tracked
    Default Value: 1
    Determines whether or not to track the subinventory.
  • Maximum Length: 10
    Name of the subinventory.
  • Maximum Length: 255
    Abbreviation that identifies the source organization. Used while sourcing the material to this subinventory.
  • Title: Organization
    Value that uniquely identifies the source organization. Used while sourcing the material to this subinventory.
  • Read Only: true
    Maximum Length: 255
    Name of the source organization. This organization is used while sourcing the material for this subinventory.
  • Title: Sourcing Subinventory
    Maximum Length: 10
    Name of the source subinventory. Used while sourcing the material to this subinventory.
  • Title: Sourcing Type
    Maximum Length: 30
    Sourcing type to use to replenish stock for this subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES.
  • Maximum Length: 255
    Value of the sourcing type to use to replenish stock for a subinventory.
  • Flexfields
    Title: Flexfields
    The Flexfields resource manages descriptive flexfields that contain details about subinventories.
  • Title: Subinventory Group
    Maximum Length: 100
    Name of the subinventory group.
  • Title: Subinventory Type
    Maximum Length: 30
    Default Value: 1
    Type of subinventory, such as Storage or Receiving. A list of accepted values is defined in the lookup type INV_SUB_TYPE. The default value is 1.
  • Maximum Length: 255
    Value of the subinventory type.
  • Value that indicates whether to use the packing unit for product completion and return transactions in manufacturing and maintenance. This is used only when the subinventory is enabled for manufacturing and maintenance integration with WMS. Valid values are Yes or No.
  • Title: Use packing unit for product completions and returns
    Maximum Length: 1
    Value indicates whether to use the packing unit for product completion and return transactions in manufacturing and maintenance. This is used only when the subinventory is enabled for manufacturing and maintenance integration with WMS. Valid values are 1 or 2.
  • Value that indicates whether the subinventory is used for manufacturing and maintenance integration with WMS. Valid values are Yes or No.
  • Title: Use subinventory for manufacturing and maintenance integration with WMS
    Maximum Length: 1
    Value that indicates whether the subinventory is used for manufacturing and maintenance integration with WMS. Valid values are 1 or 2.
Nested Schema : Item Subinventories
Type: array
Title: Item Subinventories
The Item Subinventories resource manages operations on item subinventories.
Show Source
Nested Schema : Locators
Type: array
Title: Locators
The Locators resource manages operations on locators. It allows the user to create, update and delete the subinventories.
Show Source
Nested Schema : Flexfields
Type: array
Title: Flexfields
The Flexfields resource manages descriptive flexfields that contain details about subinventories.
Show Source
Nested Schema : subinventories-itemSubinventories-item-response
Type: object
Show Source
Nested Schema : Flexfields
Type: array
Title: Flexfields
The Flexfields for Item Subinventories resource manages descriptive flexfields that contain details about item subinventories.
Show Source
Nested Schema : subinventories-itemSubinventories-itemSubinventoriesDFF-item-response
Type: object
Show Source
Nested Schema : subinventories-locators-item-response
Type: object
Show Source
Nested Schema : Item Locators
Type: array
Title: Item Locators
The Item Locators resource manages operations on item locators.
Show Source
Nested Schema : Flexfields for Locators
Type: array
Title: Flexfields for Locators
Descriptive flexfields that contain details about locators.
Show Source
Nested Schema : Flexfields for Locator Keys
Type: array
Title: Flexfields for Locator Keys
Flexfields that contain details about locator keys.
Show Source
Nested Schema : subinventories-locators-itemLocators-item-response
Type: object
Show Source
  • Title: Count Required
    Maximum Length: 1
    Contains one of the following values. 1: The application requires counting during periodic-automatic replenishment for the item in the locator. 2: The application doesn't require this counting. There isn't a default value for this attribute.
  • Read Only: true
    Date when the user created the item locator record.
  • Maximum Length: 255
    The type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is Order par.
  • Title: Replenishment Count Type
    Maximum Length: 30
    Abbreviation that identifies the type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is 4.
  • Value that uniquely identifies the Item.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Value that identifies the description of the item associated with a locator in a subinventory.
  • Maximum Length: 255
    Name of the inventory item.
  • Title: Primary Image URL
    Read Only: true
    Maximum Length: 4000
    Value that provides a reference to the image of the item for which the count sequence is generated.
  • Date when the item was last replenished for a locator during par counting.
  • Links
  • Title: Description
    Read Only: true
    Maximum Length: 50
    Description of the locator that references the locator item.
  • Title: Locator
    Value that uniquely identifies the locator.
  • Read Only: true
    Value that uniquely identifies the item locator.
  • Maximum Length: 255
    Name of the locator that references the locator item.
  • Maximum Length: 255
    Abbreviation that identifies the organization that references the item locator.
  • Value that uniquely identifies the inventory organization.
  • Title: PAR Level
    Level that the application uses during periodic-automatic replenishment for the item locator.
  • Title: PAR Maximum Quantity
    Maximum quantity to use during periodic-automatic replenishment.
  • Maximum Length: 3
    Code that identifies the unit of measure to use for quantities during periodic-automatic replenishment.
  • Title: PAR Level UOM
    Unit of measure to use for quantities during periodic-automatic replenishment.
  • Title: Count Tolerance Percentage
    Count tolerance percent to use before the application doesn't allow the count. This tolerance prevents data entry mistakes when counting, and prevents ordering too much quantity for the replenishment request.
  • Maximum Length: 10
    Abbreviation that identifies the subinventory.
Nested Schema : subinventories-locators-locatorsDFF-item-response
Type: object
Show Source
Nested Schema : Discriminator: _STRUCTURE_INSTANCE_NUMBER
Type: object
Discriminator: _STRUCTURE_INSTANCE_NUMBER

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response
Type: object
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subinventories-subinventoriesDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all the subinventories that reside in one organization.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example gets all subinventories that reside in organization 207:

curl -u username:password "https://servername/fscmRestApi/resources/version/subinventories?onlyData=true&q=OrganizationId=207"

Example Response Body

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

"
{
  "items": [
    {
      "AssetSubinventory": 1,
      "DefaultCountTypeCode": "2",
      "DefaultLocStatusId": null,
      "Depreciable": 2,
      "Description": "A8285923",
      "DisableDate": "2012-08-29",
      "LocationId": null,
      "LocatorControl": "1",
      "OrganizationId": 207,
      "PickingOrder": null,
      "ParLocation": 2,
      "PostprocessingLeadTime": null,
      "PreprocessingLeadTime": null,
      "ProcessingLeadTime": null,
      "QuantityTracked": 1,
      "SecondaryInventoryName": "A8285923",
      "SourceOrganizationId": null,
      "SourceSubinventory": null,
      "SourcingType": null,
      "MaterialStatusId": 1,
      "LocatorStructure": 101,
      "SubinventoryType": "1",
      "OrganizationCode": "M1",
      "SourceOrganizationCode": null,
      "MaterialStatusCode": "Active",
      "LocationCode": null,
      "DefaultLocStatusCode": null
    },
    {
      "AssetSubinventory": 1,
      "DefaultCountTypeCode": "2",
      "DefaultLocStatusId": null,
      "Depreciable": 2,
      "Description": "A829131",
      "DisableDate": "2012-08-30",
      "LocationId": null,
      "LocatorControl": "1",
      "OrganizationId": 207,
      "PickingOrder": null,
      "ParLocation": 2,
      "PostprocessingLeadTime": null,
      "PreprocessingLeadTime": null,
      "ProcessingLeadTime": null,
      "QuantityTracked": 1,
      "SecondaryInventoryName": "A829131",
      "SourceOrganizationId": null,
      "SourceSubinventory": null,
      "SourcingType": null,
      "MaterialStatusId": 1,
      "LocatorStructure": 101,
      "SubinventoryType": "1",
      "OrganizationCode": "M1",
      "SourceOrganizationCode": null,
      "MaterialStatusCode": "Active",
      "LocationCode": null,
      "DefaultLocStatusCode": null
    }
  ]
}"
Back to Top