Jump to

• Request
• Response
• Examples

Get one subinventory

get

/fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}

Request

Path Parameters

• subinventoriesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- OrganizationId and SecondaryInventoryName ---for the Subinventories resource and used to uniquely identify an instance of Subinventories. The client should not generate the hash key value. Instead, the client should query on the Subinventories collection resource with a filter on the primary key values in order to navigate to a specific instance of Subinventories.
  
  For example: subinventories?q=OrganizationId=<value1>;SecondaryInventoryName=<value2>

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 Top

Response

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.

Body ()

Root Schema : subinventories-item-response

Type: object

Show Source

• AssetSubinventory: integer (int32)
  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.
• CountMethod: string
  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.
• CountMethodMeaning: string
  Maximum Length: 255

  Value of the replenishment count method for a subinventory.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the subinventory record.
• DefaultCountType: string
  Maximum Length: 255

  Value of the default replenishment count type for the subinventory.
• DefaultCountTypeCode: string
  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.
• DefaultLocStatusCode: string
  Maximum Length: 255

  Abbreviation that identifies the default material status to use for the locators for this subinventory.
• DefaultLocStatusId: integer (int64)
  Title: Default Locator Status

  Value that uniquely identifies the default material status for the locators that reference this subinventory. The default value is 1.
• Depreciable: integer (int32)
  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.
• Description: string
  Title: Description

  Maximum Length: 50

  Description of the subinventory.
• DisableDate: string (date)
  Title: End Date

  Date when the subinventory is disabled for use in the application.
• FillKillToLookup: string
  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.
• FillKillToLookupMeaning: string
  Maximum Length: 255

  Value of the Fill Kill status for a subinventory.
• itemSubinventories: array Item Subinventories
  Title: Item Subinventories

  The Item Subinventories resource manages operations on item subinventories.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationCode: string
  Maximum Length: 60

  Abbreviation that identifies the value that identifies the location that references the subinventory.
• LocationId: integer (int64)
  Title: Location

  Value that uniquely identifies the location that references the subinventory.
• LocatorControl: string
  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.
• LocatorControlMeaning: string
  Maximum Length: 255

  Value of the locator control for a subinventory.
• locators: array Locators
  Title: Locators

  The Locators resource manages operations on locators. It allows the user to create, update and delete the subinventories.
• LocatorStructure: integer (int64)
  Title: Locator Structure

  Value that uniquely identifies the locator structure for the subinventory when a locator controls the subinventory.
• LocatorStructureMeaning: string
  Maximum Length: 255

  Value of the locator structure for the subinventory when the subinventory is a locator control.
• MaterialStatusCode: string
  Maximum Length: 255

  Abbreviation that identifies the material status that references the subinventory.
• MaterialStatusId: integer (int64)
  Title: Material Status

  Default Value: 1

  Value that uniquely identifies the material status that references the subinventory. The default value is 1.
• OracleHealthLocation: string
  Maximum Length: 1

  Value that indicates if the subinventory is enabled to sync with Oracle Health.
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the organization that references the subinventory.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization that references the subinventory.
• ParLocation: integer (int32)
  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.
• PickingOrder: integer
  Title: Picking Order

  Picking order for the subinventory.
• PostprocessingLeadTime: integer
  Title: Postprocessing

  Post processing lead time to use while sourcing the item.
• PreprocessingLeadTime: integer
  Title: Preprocessing

  Preprocessing lead time to use while sourcing the item.
• ProcessingLeadTime: integer
  Title: Processing

  Processing lead time to use while sourcing the item.
• QuantityTracked: integer (int32)
  Title: Quantity tracked

  Default Value: 1

  Determines whether or not to track the subinventory.
• SecondaryInventoryName: string
  Maximum Length: 10

  Name of the subinventory.
• SourceOrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the source organization. Used while sourcing the material to this subinventory.
• SourceOrganizationId: integer (int64)
  Title: Organization

  Value that uniquely identifies the source organization. Used while sourcing the material to this subinventory.
• SourceOrganizationName: string
  Read Only: true

  Maximum Length: 255

  Name of the source organization. This organization is used while sourcing the material for this subinventory.
• SourceSubinventory: string
  Title: Sourcing Subinventory

  Maximum Length: 10

  Name of the source subinventory. Used while sourcing the material to this subinventory.
• SourcingType: string
  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.
• SourcingTypeMeaning: string
  Maximum Length: 255

  Value of the sourcing type to use to replenish stock for a subinventory.
• subinventoriesDFF: array Flexfields
  Title: Flexfields

  The Flexfields resource manages descriptive flexfields that contain details about subinventories.
• SubinventoryGroup: string
  Title: Subinventory Group

  Maximum Length: 100

  Name of the subinventory group.
• SubinventoryType: string
  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.
• SubinventoryTypeMeaning: string
  Maximum Length: 255

  Value of the subinventory type.
• UsePackingUnitForProductCompletionAndReturn: string
  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.
• UsePackingUnitForProductCompletionAndReturnCode: string
  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.
• UseSubinventoryForManufacturingAndMaintenanceInWms: string
  Value that indicates whether the subinventory is used for manufacturing and maintenance integration with WMS. Valid values are Yes or No.
• UseSubinventoryForManufacturingAndMaintenanceInWmsCode: string
  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.

{
    "type":"object",
    "properties":{
        "UsePackingUnitForProductCompletionAndReturnCode":{
            "title":"Use packing unit for product completions and returns",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the subinventory record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultCountType":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the default replenishment count type for the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "SourcingType":{
            "title":"Sourcing Type",
            "maxLength":"30",
            "type":"string",
            "description":"Sourcing type to use to replenish stock for this subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"INV_SOURCE_TYPES",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "SourceOrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the source organization. This organization is used while sourcing the material for this subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Depreciable":{
            "title":"Depreciable",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "default":"2",
            "x-hints":{
                "controlType":"choice",
                "precision":"9"
            },
            "x-queryable":true
        },
        "CountMethod":{
            "title":"Replenishment Count Method",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that references the subinventory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubinventoryGroup":{
            "title":"Subinventory Group",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the subinventory group.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultCountTypeCode":{
            "title":"Default Replenishment Count Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"4",
            "x-hints":{
                "controlType":"choice",
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"INV_DEFAULT_REPLEN_COUNT_TYPE",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "FillKillToLookupMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the Fill Kill status for a subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "subinventoriesDFF":{
            "title":"Flexfields",
            "type":"array",
            "description":"The Flexfields resource manages descriptive flexfields that contain details about subinventories.",
            "items":{
                "$ref":"#/components/schemas/subinventories-subinventoriesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "SourcingTypeMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the sourcing type to use to replenish stock for a subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "OracleHealthLocation":{
            "maxLength":"1",
            "type":"string",
            "description":"Value that indicates if the subinventory is enabled to sync with Oracle Health.",
            "nullable":true,
            "x-queryable":true
        },
        "UsePackingUnitForProductCompletionAndReturn":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "locators":{
            "title":"Locators",
            "type":"array",
            "description":"The Locators resource manages operations on locators. It allows the user to create, update and delete the subinventories.",
            "items":{
                "$ref":"#/components/schemas/subinventories-locators-item-response"
            }
        },
        "MaterialStatusId":{
            "title":"Material Status",
            "type":"integer",
            "description":"Value that uniquely identifies the material status that references the subinventory. The default value is 1.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the organization that references the subinventory.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DisableDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the subinventory is disabled for use in the application.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorStructure":{
            "title":"Locator Structure",
            "type":"integer",
            "description":"Value that uniquely identifies the locator structure for the subinventory when a locator controls the subinventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubinventoryType":{
            "title":"Subinventory Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "controlType":"choice",
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"INV_SUB_TYPE",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "ProcessingLeadTime":{
            "title":"Processing",
            "type":"integer",
            "description":"Processing lead time to use while sourcing the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryTypeMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the subinventory type.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorStructureMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the locator structure for the subinventory when the subinventory is a locator control.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryInventoryName":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"Value that uniquely identifies the source organization. Used while sourcing the material to this subinventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaterialStatusCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the material status that references the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "PickingOrder":{
            "title":"Picking Order",
            "type":"integer",
            "description":"Picking order for the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "UseSubinventoryForManufacturingAndMaintenanceInWmsCode":{
            "title":"Use subinventory for manufacturing and maintenance integration with WMS",
            "maxLength":"1",
            "type":"string",
            "description":"Value that indicates whether the subinventory is used for manufacturing and maintenance integration with WMS. Valid values are 1 or 2.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSubinventory":{
            "title":"Sourcing Subinventory",
            "maxLength":"10",
            "type":"string",
            "description":"Name of the source subinventory. Used while sourcing the material to this subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultLocStatusCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the default material status to use for the locators for this subinventory.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "DefaultLocStatusId"
                ]
            },
            "x-queryable":true
        },
        "UseSubinventoryForManufacturingAndMaintenanceInWms":{
            "type":"string",
            "description":"Value that indicates whether the subinventory is used for manufacturing and maintenance integration with WMS. Valid values are Yes or No.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationId":{
            "title":"Location",
            "type":"integer",
            "description":"Value that uniquely identifies the location that references the subinventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocationCode":{
            "maxLength":"60",
            "type":"string",
            "description":"Abbreviation that identifies the value that identifies the location that references the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorControl":{
            "title":"Locator Control",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"INV_LOCATION_CONTROL",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "PreprocessingLeadTime":{
            "title":"Preprocessing",
            "type":"integer",
            "description":"Preprocessing lead time to use while sourcing the item.",
            "nullable":true,
            "x-queryable":true
        },
        "itemSubinventories":{
            "title":"Item Subinventories",
            "type":"array",
            "description":"The Item Subinventories resource manages operations on item subinventories.",
            "items":{
                "$ref":"#/components/schemas/subinventories-itemSubinventories-item-response"
            }
        },
        "AssetSubinventory":{
            "title":"Asset subinventory",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "controlType":"choice",
                "precision":"9"
            },
            "x-queryable":true
        },
        "CountMethodMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the replenishment count method for a subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityTracked":{
            "title":"Quantity tracked",
            "type":"integer",
            "description":"Determines whether or not to track the subinventory.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "controlType":"choice",
                "precision":"9"
            },
            "x-queryable":true
        },
        "FillKillToLookup":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceOrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the source organization. Used while sourcing the material to this subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorControlMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the locator control for a subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ParLocation":{
            "title":"PAR location",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "default":"2",
            "x-hints":{
                "controlType":"choice",
                "precision":"9"
            },
            "x-queryable":true
        },
        "DefaultLocStatusId":{
            "title":"Default Locator Status",
            "type":"integer",
            "description":"Value that uniquely identifies the default material status for the locators that reference this subinventory. The default value is 1.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "PostprocessingLeadTime":{
            "title":"Postprocessing",
            "type":"integer",
            "description":"Post processing lead time to use while sourcing the item.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Item Subinventories

Type: array

Title: Item Subinventories

The Item Subinventories resource manages operations on item subinventories.

Show Source

• Array of: object subinventories-itemSubinventories-item-response

{
    "title":"Item Subinventories",
    "type":"array",
    "description":"The Item Subinventories resource manages operations on item subinventories.",
    "items":{
        "$ref":"#/components/schemas/subinventories-itemSubinventories-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object subinventories-locators-item-response

{
    "title":"Locators",
    "type":"array",
    "description":"The Locators resource manages operations on locators. It allows the user to create, update and delete the subinventories.",
    "items":{
        "$ref":"#/components/schemas/subinventories-locators-item-response"
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The Flexfields resource manages descriptive flexfields that contain details about subinventories.

Show Source

• Array of: object subinventories-subinventoriesDFF-item-response

{
    "title":"Flexfields",
    "type":"array",
    "description":"The Flexfields resource manages descriptive flexfields that contain details about subinventories.",
    "items":{
        "$ref":"#/components/schemas/subinventories-subinventoriesDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : subinventories-itemSubinventories-item-response

Type: object

Show Source

• CountRequired: string
  Title: Count Required

  Maximum Length: 1

  Contains the values 1 or 2. 1: The application requires counting during periodic-automatic replenishment for the item in the locator. 2: The application doesn't require this counting.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the item subinventory record.
• DefaultCountType: string
  Maximum Length: 255

  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.
• DefaultCountTypeCode: string
  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.
• FixedLotMultiple: integer (int32)
  Title: Fixed Lot Multiple

  Value of the fixed lot multiple. Used while sourcing the material for the item. You can source an item only in this value.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Value that identifies the description of the item associated with a subinventory.
• ItemNumber: string
  Maximum Length: 300

  Name that identifies the product or material in the subinventory.
• ItemPrimaryImageURL: string
  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.
• itemSubinventoriesDFF: array Flexfields
  Title: Flexfields

  The Flexfields for Item Subinventories resource manages descriptive flexfields that contain details about item subinventories.
• LastReplenishedDate: string (date-time)
  Date when the item was last replenished for a subinventory during par counting.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumMinmaxQuantity: number
  Title: Maximum Quantity

  Maximum quantity for min-max replenishment.
• MaximumOrderQuantity: number
  Title: Maximum Order Quantity

  Maximum order quantity for replenishment.
• MinimumMaximumPlanningCode: integer (int32)
  Title: Inventory Planning Method

  Default Value: 6

  Abbreviation that determines whether to enable min-max planning for the item subinventory. A list of accepted values is defined in the lookup type INV_MATERIAL_PLANNING.
• MinimumMaximumPlanningMeaning: string
  Maximum Length: 255

  Value used to determine whether to enable min-max planning for an item subinventory.
• MinimumMinmaxQuantity: number
  Title: Minimum Quantity

  Minimum quantity for min-max replenishment.
• MinimumOrderQuantity: number
  Title: Minimum Order Quantity

  Minimum order quantity for replenishment.
• MinmaxQuantityUOM: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure to use for the min-max quantities.
• MinmaxQuantityUOMMeasure: string
  Maximum Length: 255

  Unit of measure to use for the min-max quantities.
• ParLevel: number
  Title: PAR Level

  Level that the application uses for the item subinventory during periodic automatic replenishment.
• ParMaximumQuantity: number
  Title: PAR Maximum Quantity

  Maximum quantity to use during periodic automatic replenishment.
• ParUOMCode: string
  Title: PAR Level UOM

  Maximum Length: 3

  Abbreviation that identifies the unit of measure to use for quantities during periodic automatic replenishment.
• ParUOMMeasure: string
  Title: PAR Level UOM

  Unit of measure to use for quantities during periodic automatic replenishment.
• PostprocessingLeadTime: integer
  Title: Postprocessing

  Post processing lead time to use while sourcing the item.
• PreprocessingLeadTime: integer
  Title: Preprocessing

  Preprocessing lead time to use while sourcing the item.
• ProcessingLeadTime: integer
  Title: Processing

  Processing lead time to use while sourcing the item.
• QuantityCountTolerance: number
  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.
• SecondaryInventory: string
  Maximum Length: 10

  Subinventory that references the item.
• SourceOrderingUOM: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the unit of measure to use for sourcing.
• SourceOrderingUOMMeasure: string
  Maximum Length: 255

  Unit of measure to use for sourcing.
• SourceOrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the source organization. Used while sourcing the material for the item to this subinventory.
• SourceOrganizationId: integer (int64)
  Value that uniquely identifies the source organization. Used while sourcing the material for the item to this subinventory.
• SourceOrganizationName: string
  Read Only: true

  Maximum Length: 255

  Name of the source organization. This organization is used while sourcing the item for this subinventory.
• SourceSubinventory: string
  Title: Sourcing Subinventory

  Maximum Length: 10

  Name of the source subinventory. Used while sourcing the material for the item to this subinventory.
• SourceType: string
  Title: Sourcing Type

  Maximum Length: 30

  Sourcing type to use to replenish stock for the item to this subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES. The default value is 6.
• SourceTypeMeaning: string
  Maximum Length: 255

  Value of the sourcing type used to specify the location from which the stock for the item is replenished into the subinventory.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the item subinventory record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParLevel":{
            "title":"PAR Level",
            "type":"number",
            "description":"Level that the application uses for the item subinventory during periodic automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SecondaryInventory"
                ]
            },
            "x-queryable":true
        },
        "DefaultCountType":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ParMaximumQuantity":{
            "title":"PAR Maximum Quantity",
            "type":"number",
            "description":"Maximum quantity to use during periodic automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SecondaryInventory"
                ]
            },
            "x-queryable":true
        },
        "SourceType":{
            "title":"Sourcing Type",
            "maxLength":"30",
            "type":"string",
            "description":"Sourcing type to use to replenish stock for the item to this subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES. The default value is 6.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"INV_SOURCE_TYPES",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "itemSubinventoriesDFF":{
            "title":"Flexfields",
            "type":"array",
            "description":"The Flexfields for Item Subinventories resource manages descriptive flexfields that contain details about item subinventories.",
            "items":{
                "$ref":"#/components/schemas/subinventories-itemSubinventories-itemSubinventoriesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "SourceOrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the source organization. This organization is used while sourcing the item for this subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Value that identifies the description of the item associated with a subinventory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FixedLotMultiple":{
            "title":"Fixed Lot Multiple",
            "type":"integer",
            "description":"Value of the fixed lot multiple. Used while sourcing the material for the item. You can source an item only in this value.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "DefaultCountTypeCode":{
            "title":"Replenishment Count Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SecondaryInventory"
                ]
            },
            "x-queryable":true
        },
        "SourceOrderingUOM":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure to use for sourcing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Name that identifies the product or material in the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ParUOMMeasure":{
            "title":"PAR Level UOM",
            "type":"string",
            "description":"Unit of measure to use for quantities during periodic automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ParUOMCode"
                ]
            },
            "x-queryable":true
        },
        "MaximumMinmaxQuantity":{
            "title":"Maximum Quantity",
            "type":"number",
            "description":"Maximum quantity for min-max replenishment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParUOMCode":{
            "title":"PAR Level UOM",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure to use for quantities during periodic automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SecondaryInventory"
                ]
            },
            "x-queryable":true
        },
        "ItemPrimaryImageURL":{
            "title":"Primary Image URL",
            "maxLength":"4000",
            "type":"string",
            "description":"Value that provides a reference to the image of the item for which the count sequence is generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingLeadTime":{
            "title":"Processing",
            "type":"integer",
            "description":"Processing lead time to use while sourcing the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryInventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Subinventory that references the item.",
            "nullable":false,
            "x-queryable":true
        },
        "MinimumMaximumPlanningMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Value used to determine whether to enable min-max planning for an item subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumMinmaxQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"Minimum quantity for min-max replenishment.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source organization. Used while sourcing the material for the item to this subinventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceSubinventory":{
            "title":"Sourcing Subinventory",
            "maxLength":"10",
            "type":"string",
            "description":"Name of the source subinventory. Used while sourcing the material for the item to this subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTypeMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the sourcing type used to specify the location from which the stock for the item is replenished into the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrderingUOMMeasure":{
            "maxLength":"255",
            "type":"string",
            "description":"Unit of measure to use for sourcing.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastReplenishedDate":{
            "type":"string",
            "description":"Date when the item was last replenished for a subinventory during par counting.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumOrderQuantity":{
            "title":"Maximum Order Quantity",
            "type":"number",
            "description":"Maximum order quantity for replenishment.",
            "nullable":true,
            "x-queryable":true
        },
        "MinmaxQuantityUOMMeasure":{
            "maxLength":"255",
            "type":"string",
            "description":"Unit of measure to use for the min-max quantities.",
            "nullable":true,
            "x-queryable":true
        },
        "PreprocessingLeadTime":{
            "title":"Preprocessing",
            "type":"integer",
            "description":"Preprocessing lead time to use while sourcing the item.",
            "nullable":true,
            "x-queryable":true
        },
        "MinmaxQuantityUOM":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure to use for the min-max quantities.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumMaximumPlanningCode":{
            "title":"Inventory Planning Method",
            "type":"integer",
            "description":"Abbreviation that determines whether to enable min-max planning for the item subinventory. A list of accepted values is defined in the lookup type INV_MATERIAL_PLANNING.",
            "format":"int32",
            "nullable":false,
            "default":"6",
            "x-hints":{
                "controlType":"choice",
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"INV_MATERIAL_PLANNING",
                "precision":"9",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "SourceOrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the source organization. Used while sourcing the material for the item to this subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumOrderQuantity":{
            "title":"Minimum Order Quantity",
            "type":"number",
            "description":"Minimum order quantity for replenishment.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityCountTolerance":{
            "title":"Count Tolerance Percentage",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SecondaryInventory"
                ]
            },
            "x-queryable":true
        },
        "PostprocessingLeadTime":{
            "title":"Postprocessing",
            "type":"integer",
            "description":"Post processing lead time to use while sourcing the item.",
            "nullable":true,
            "x-queryable":true
        },
        "CountRequired":{
            "title":"Count Required",
            "maxLength":"1",
            "type":"string",
            "description":"Contains the values 1 or 2. 1: The application requires counting during periodic-automatic replenishment for the item in the locator. 2: The application doesn't require this counting.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SecondaryInventory"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The Flexfields for Item Subinventories resource manages descriptive flexfields that contain details about item subinventories.

Show Source

• Array of: object subinventories-itemSubinventories-itemSubinventoriesDFF-item-response

{
    "title":"Flexfields",
    "type":"array",
    "description":"The Flexfields for Item Subinventories resource manages descriptive flexfields that contain details about item subinventories.",
    "items":{
        "$ref":"#/components/schemas/subinventories-itemSubinventories-itemSubinventoriesDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subinventories-itemSubinventories-itemSubinventoriesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context value of the item subinventory that the descriptive flexfield references.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Display value of the item subinventory that the descriptive flexfield references.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization.
• SecondaryInventory: string
  Maximum Length: 10

  Name of the subinventory.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Display value of the item subinventory that the descriptive flexfield references.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "SecondaryInventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Context value of the item subinventory that the descriptive flexfield references.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subinventories-locators-item-response

Type: object

Show Source

• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the locator record.
• Description: string
  Title: Description

  Maximum Length: 50

  Description of the locator.
• DisableDate: string (date)
  Title: End Date

  Date when the locator is disabled for use in the application.
• InventoryLocationId: integer (int64)
  Title: Locator

  Value that uniquely identifies the locator.
• InventoryLocationType: string
  Title: Type

  Maximum Length: 30

  Value that identifies the locator type. A list of accepted values is defined in the lookup type INV_LOCATOR_TYPES.
• InventoryLocationTypeMeaning: string
  Maximum Length: 255

  Value of the locator type.
• itemLocators: array Item Locators
  Title: Item Locators

  The Item Locators resource manages operations on item locators.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocatorName: string
  Read Only: true

  Maximum Length: 255

  Name of the locator.
• locatorsDFF: array Flexfields for Locators
  Title: Flexfields for Locators

  Descriptive flexfields that contain details about locators.
• locatorsKeyFlex: array Flexfields for Locator Keys
  Title: Flexfields for Locator Keys

  Flexfields that contain details about locator keys.
• MaterialStatusCode: string
  Maximum Length: 255

  Abbreviation that identifies the material status that references the locator.
• MaterialStatusId: integer (int64)
  Title: Status

  Value that uniquely identifies the material status that references the locator.
• PickingOrder: number
  Title: Picking Order

  Picking order for the locator.
• StructureInstanceNumber: integer (int64)
  Title: Locator Structure

  Value that uniquely identifies the locator structure.
• SubinventoryCode: string
  Maximum Length: 10

  Abbreviation that identifies the subinventory name.

{
    "type":"object",
    "properties":{
        "MaterialStatusCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the material status that references the locator.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the locator record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PickingOrder":{
            "title":"Picking Order",
            "type":"number",
            "description":"Picking order for the locator.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the locator.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Abbreviation that identifies the subinventory name.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryLocationId":{
            "title":"Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LocatorName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the locator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "locatorsDFF":{
            "title":"Flexfields for Locators",
            "type":"array",
            "description":"Descriptive flexfields that contain details about locators.",
            "items":{
                "$ref":"#/components/schemas/subinventories-locators-locatorsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "itemLocators":{
            "title":"Item Locators",
            "type":"array",
            "description":"The Item Locators resource manages operations on item locators.",
            "items":{
                "$ref":"#/components/schemas/subinventories-locators-itemLocators-item-response"
            }
        },
        "StructureInstanceNumber":{
            "title":"Locator Structure",
            "type":"integer",
            "description":"Value that uniquely identifies the locator structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "FND_ACFF_FlexfieldCode":"MTLL",
                "precision":"18",
                "FND_ACFF_ApplicationID":"401",
                "FND_ACFF_StructureLookupRequired":"false",
                "FND_ACFF_ModelID":"KFF_INV_MTLL_MTLL_INV_5FITEM_5FLOCATIONS",
                "FND_ACFF_ApplicationShortName":"INV"
            },
            "x-queryable":true
        },
        "InventoryLocationType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the locator type. A list of accepted values is defined in the lookup type INV_LOCATOR_TYPES.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MaterialStatusId":{
            "title":"Status",
            "type":"integer",
            "description":"Value that uniquely identifies the material status that references the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DisableDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the locator is disabled for use in the application.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryLocationTypeMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Value of the locator type.",
            "nullable":true,
            "x-queryable":true
        },
        "locatorsKeyFlex":{
            "title":"Flexfields for Locator Keys",
            "type":"array",
            "description":"Flexfields that contain details about locator keys.",
            "items":{
                "$ref":"#/components/schemas/subinventories-locators-locatorsKeyFlex-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Item Locators

Type: array

Title: Item Locators

The Item Locators resource manages operations on item locators.

Show Source

• Array of: object subinventories-locators-itemLocators-item-response

{
    "title":"Item Locators",
    "type":"array",
    "description":"The Item Locators resource manages operations on item locators.",
    "items":{
        "$ref":"#/components/schemas/subinventories-locators-itemLocators-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Flexfields for Locators

Type: array

Title: Flexfields for Locators

Descriptive flexfields that contain details about locators.

Show Source

• Array of: object subinventories-locators-locatorsDFF-item-response

{
    "title":"Flexfields for Locators",
    "type":"array",
    "description":"Descriptive flexfields that contain details about locators.",
    "items":{
        "$ref":"#/components/schemas/subinventories-locators-locatorsDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Flexfields for Locator Keys

Type: array

Title: Flexfields for Locator Keys

Flexfields that contain details about locator keys.

Show Source

• Array of: object Discriminator: _STRUCTURE_INSTANCE_NUMBER
  Discriminator: { "propertyName":"_STRUCTURE_INSTANCE_NUMBER", "mapping":{ "1025":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response" } }

{
    "title":"Flexfields for Locator Keys",
    "type":"array",
    "description":"Flexfields that contain details about locator keys.",
    "items":{
        "$ref":"#/components/schemas/subinventories-locators-locatorsKeyFlex-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : subinventories-locators-itemLocators-item-response

Type: object

Show Source

• CountRequired: string
  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.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the item locator record.
• DefaultCountType: string
  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.
• DefaultCountTypeCode: string
  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.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the Item.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Value that identifies the description of the item associated with a locator in a subinventory.
• ItemNumber: string
  Maximum Length: 255

  Name of the inventory item.
• ItemPrimaryImageURL: string
  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.
• LastReplenishedDate: string (date-time)
  Date when the item was last replenished for a locator during par counting.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocatorDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 50

  Description of the locator that references the locator item.
• LocatorId: integer (int64)
  Title: Locator

  Value that uniquely identifies the locator.
• LocatorItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item locator.
• LocatorName: string
  Maximum Length: 255

  Name of the locator that references the locator item.
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the organization that references the item locator.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization.
• ParLevel: number
  Title: PAR Level

  Level that the application uses during periodic-automatic replenishment for the item locator.
• ParMaximumQuantity: number
  Title: PAR Maximum Quantity

  Maximum quantity to use during periodic-automatic replenishment.
• ParUOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure to use for quantities during periodic-automatic replenishment.
• ParUOMMeasure: string
  Title: PAR Level UOM

  Unit of measure to use for quantities during periodic-automatic replenishment.
• QuantityCountTolerance: number
  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.
• SubinventoryCode: string
  Maximum Length: 10

  Abbreviation that identifies the subinventory.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the item locator record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParLevel":{
            "title":"PAR Level",
            "type":"number",
            "description":"Level that the application uses during periodic-automatic replenishment for the item locator.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "DefaultCountType":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item locator.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ParMaximumQuantity":{
            "title":"PAR Maximum Quantity",
            "type":"number",
            "description":"Maximum quantity to use during periodic-automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the Item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocatorId":{
            "title":"Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastReplenishedDate":{
            "type":"string",
            "description":"Date when the item was last replenished for a locator during par counting.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorDescription":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the locator that references the locator item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"edit",
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"Abbreviation that identifies the subinventory.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Value that identifies the description of the item associated with a locator in a subinventory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultCountTypeCode":{
            "title":"Replenishment Count Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"INV_DEFAULT_REPLEN_COUNT_TYPE",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0",
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "LocatorName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the  locator that references the locator item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "ParUOMMeasure":{
            "title":"PAR Level UOM",
            "type":"string",
            "description":"Unit of measure to use for quantities during periodic-automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "ParUOMCode",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the organization that references the item locator.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure to use for quantities during periodic-automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "ItemPrimaryImageURL":{
            "title":"Primary Image URL",
            "maxLength":"4000",
            "type":"string",
            "description":"Value that provides a reference to the image of the item for which the count sequence is generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuantityCountTolerance":{
            "title":"Count Tolerance Percentage",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        },
        "CountRequired":{
            "title":"Count Required",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SubinventoryCode"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subinventories-locators-locatorsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Context value of the locator that the descriptive flexfield references.
• __FLEX_Context_DisplayValue: string
  Title: Context

  Display value of the locator that the descriptive flexfield references.
• InventoryLocationId: integer (int64)
  Title: Locator

  Value that uniquely identifies the locator.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InventoryLocationId":{
            "title":"Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Display value of the locator that the descriptive flexfield references.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":"30",
            "type":"string",
            "description":"Context value of the locator that the descriptive flexfield references.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Discriminator: _STRUCTURE_INSTANCE_NUMBER

Type: object

Discriminator: _STRUCTURE_INSTANCE_NUMBER

Discriminator Values

• 1025

{
    "discriminator":{
        "propertyName":"_STRUCTURE_INSTANCE_NUMBER",
        "mapping":{
            "1025":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response"
        }
    ]
}

Match One Schema

Show Source

• 1025 - object oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response

{
    "discriminator":{
        "propertyName":"_STRUCTURE_INSTANCE_NUMBER",
        "mapping":{
            "1025":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response

Type: object

Show Source

• _INVENTORY_LOCATION_ID: integer (int64)
  Title: Locator

  Number that uniquely identifies the locator.
• _STRUCTURE_INSTANCE_NUMBER: integer (int64)
  Title: Locator Structure

  Default Value: 1025

  Value that uniquely identifies the locator structure for the subinventory when a locator control is enabled for the subinventory.
• _SUBINVENTORY_ID: integer (int64)
  Value that uniquely identifies subinventory.
• aisle: string
  Title: Aisle

  Maximum Length: 40
• bin: string
  Title: Bin

  Maximum Length: 40
• EnabledFlag: string
  Maximum Length: 1

  Default Value: Y

  Contains one of the following values. Y: enable the locator. N: do not enable the locator. There is no default value for this attribute.
• EndDateActive: string (date)
  Date when the locator becomes inactive.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• rack: string
  Title: Rack

  Maximum Length: 40
• row: string
  Title: Row

  Maximum Length: 40
• StartDateActive: string (date)
  Date when the locator becomes active.

{
    "type":"object",
    "properties":{
        "StartDateActive":{
            "type":"string",
            "description":"Date when the locator becomes active.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EndDateActive":{
            "type":"string",
            "description":"Date when the locator becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "rack":{
            "title":"Rack",
            "maxLength":"40",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"rack",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Rack",
                "FND_ACFF_SegSeqNo":"3"
            }
        },
        "bin":{
            "title":"Bin",
            "maxLength":"40",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"bin",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Bin",
                "FND_ACFF_SegSeqNo":"4"
            }
        },
        "_INVENTORY_LOCATION_ID":{
            "title":"Locator",
            "type":"integer",
            "description":"Number that uniquely identifies the locator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "FND_ACFF_JavaType":"java.lang.Long",
                "FND_ACFF_IsCCID":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "_SUBINVENTORY_ID":{
            "type":"integer",
            "description":"Value that uniquely identifies subinventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "FND_ACFF_IsDataSetNumber":"true",
                "FND_ACFF_JavaType":"java.lang.Long"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "row":{
            "title":"Row",
            "maxLength":"40",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"row",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Row",
                "FND_ACFF_SegSeqNo":"2"
            }
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Contains one of the following values. Y: enable the locator. N: do not enable the locator. There is no default value for this attribute.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "aisle":{
            "title":"Aisle",
            "maxLength":"40",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_Inventory Locator VS 10#FORMAT_ONLY",
                "FND_ACFF_OpenIdentifier":"aisle",
                "FND_ACFF_QueryRequired":"Optional",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"10",
                "FND_ACFF_SegmentName":"Aisle",
                "FND_ACFF_SegSeqNo":"1"
            }
        },
        "_STRUCTURE_INSTANCE_NUMBER":{
            "title":"Locator Structure",
            "type":"integer",
            "description":"Value that uniquely identifies the locator structure for the subinventory when a locator control is enabled for the subinventory.",
            "format":"int64",
            "nullable":true,
            "default":"1025",
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "FND_ACFF_IsStructureID":"true",
                "FND_ACFF_JavaType":"java.lang.Long",
                "FND_ACFF_StructureLookupRequired":"false"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subinventories-subinventoriesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Source Type

  Maximum Length: 30

  Descriptive flexfield context name for subinventories.
• __FLEX_Context_DisplayValue: string
  Title: Source Type

  Descriptive flexfield context display value for subinventories.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization.
• SecondaryInventoryName: string
  Maximum Length: 10

  Name of the subinventory.

{
    "type":"object",
    "properties":{
        "SecondaryInventoryName":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Source Type",
            "type":"string",
            "description":"Descriptive flexfield context display value for subinventories.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Source Type",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for subinventories.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

itemSubinventories

Operation: /fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}/child/itemSubinventories

Parameters:

• subinventoriesUniqID: $request.path.subinventoriesUniqID

The Item Subinventories resource manages operations on item subinventories.

locators

Operation: /fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}/child/locators

Parameters:

• subinventoriesUniqID: $request.path.subinventoriesUniqID

The Locators resource manages operations on locators. It allows the user to create, update and delete the subinventories.

subinventoriesDFF

Operation: /fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}/child/subinventoriesDFF

Parameters:

• subinventoriesUniqID: $request.path.subinventoriesUniqID

The Flexfields resource manages descriptive flexfields that contain details about subinventories.

Back to Top

Examples

This example describes how to get one subinventory.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/subinventories?q=OrganizationId=value;SecondaryInventoryName=value"

For example, the following command gets one subinventory in organization 207, in inventory Stores:

curl -u username:password "https://servername/fscmRestApi/resources/version/subinventories?q=OrganizationId=207;SecondaryInventoryName=Stores"

Example Response Body

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

{
  "items": [
    {
      "AssetSubinventory": 1,
      "DefaultCountTypeCode": "2",
      "DefaultLocStatusId": 1,
      "Depreciable": 2,
      "Description": "Stores Subinventory",
      "DisableDate": null,
      "LocationId": 207,
      "LocatorControl": "5",
      "OrganizationId": 207,
      "PickingOrder": 2,
      "ParLocation": 2,
      "PostprocessingLeadTime": null,
      "PreprocessingLeadTime": null,
      "ProcessingLeadTime": null,
      "QuantityTracked": 1,
      "SecondaryInventoryName": "Stores",
      "SourceOrganizationId": null,
      "SourceSubinventory": null,
      "SourcingType": "2",
      "MaterialStatusId": 1,
      "LocatorStructure": 101,
      "SubinventoryType": null,
      "OrganizationCode": "M1",
      "SourceOrganizationCode": null,
      "MaterialStatusCode": "Active",
      "LocationCode": "M1- Seattle Mfg",
      "DefaultLocStatusCode": "Active",
      "FillKillToLookup": "NEXT_LEVEL",
      "links": [
        {
          "rel": "self",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573",
          "name": "subinventories",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573",
          "name": "subinventories",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/lov/LocatorTypeLov",
          "name": "LocatorTypeLov",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/lov/DefaultCountTypeLov",
          "name": "DefaultCountTypeLov",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/lov/SourceTypeLov",
          "name": "SourceTypeLov",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/lov/DepreciableLov",
          "name": "DepreciableLov",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/lov/KeyFlexfieldStructureInstanceVA",
          "name": "KeyFlexfieldStructureInstanceVA",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/lov/QuantityTrackedLov",
          "name": "QuantityTrackedLov",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/lov/DefaultLocStatusLov",
          "name": "DefaultLocStatusLov",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/lov/ParLocationLov",
          "name": "ParLocationLov",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/lov/SubinventoryTypeLov",
          "name": "SubinventoryTypeLov",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/lov/AssetSubinventoryLov",
          "name": "AssetSubinventoryLov",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/lov/MaterialStatusLov",
          "name": "MaterialStatusLov",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/child/locators",
          "name": "locators",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/child/subinventoriesDFF",
          "name": "subinventoriesDFF",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername/logisticsApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF0000000653746F726573/child/itemSubinventories",
          "name": "itemSubinventories",
          "kind": "collection"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername/logisticsApi/resources/version/subinventories",
      "name": "subinventories",
      "kind": "collection"
    }
  ]
}

Back to Top