Jump to

• Request
• Response
• Examples

Update one subinventory item

patch

/fscmRestApi/resources/11.13.18.05/subinventoryItems/{SubinventoryItemId}

Request

Path Parameters

• SubinventoryItemId(required): string
  Value that uniquely identifies the subinventory item.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.
• 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.
• 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 a subinventory item. List of accepted values are defined in the lookup type INV_MATERIAL_PLANNING.
• MinimumMaximumPlanningMeaning: string
  Maximum Length: 255

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

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

  Value that uniquely identifies the organization.
• 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.
• onhandQuantity: array On-Hand Quantities
  Title: On-Hand Quantities

  The On-Hand Quantities resource provides the on-hand quantities for the items associated with a subinventory in their primary unit of measure.
• ParLevel: number
  Title: PAR Level

  Level that the application uses for the subinventory item 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

  Postprocessing 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 which the application doesn't allow the count. This tolerance prevents data-entry mistakes when counting, and prevents ordering more than required quantity for the replenishment request.
• 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.
• 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 in the subinventory.
• subinventoryItemsDFF: array Flexfields
  Title: Flexfields

  The Flexfields for Subinventory Items resource manages descriptive flexfields that contain details about subinventory items.

{
    "type":"object",
    "properties":{
        "subinventoryItemsDFF":{
            "title":"Flexfields",
            "type":"array",
            "description":"The Flexfields for Subinventory Items resource manages descriptive flexfields that contain details about subinventory items.",
            "items":{
                "$ref":"#/components/schemas/subinventoryItems-subinventoryItemsDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "ParLevel":{
            "title":"PAR Level",
            "type":"number",
            "description":"Level that the application uses for the subinventory item during periodic automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SecondaryInventory"
                ]
            }
        },
        "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
        },
        "ParMaximumQuantity":{
            "title":"PAR Maximum Quantity",
            "type":"number",
            "description":"Maximum quantity to use during periodic automatic replenishment.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SecondaryInventory"
                ]
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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"
                ]
            }
        },
        "ParUOMMeasure":{
            "title":"PAR Level UOM",
            "type":"string",
            "description":"Unit of measure to use for quantities during periodic automatic replenishment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ParUOMCode"
                ]
            }
        },
        "MaximumMinmaxQuantity":{
            "title":"Maximum Quantity",
            "type":"number",
            "description":"Maximum quantity for min-max replenishment.",
            "nullable":true
        },
        "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"
                ]
            }
        },
        "ProcessingLeadTime":{
            "title":"Processing",
            "type":"integer",
            "description":"Processing lead time to use while sourcing the item.",
            "nullable":true
        },
        "MinimumMaximumPlanningMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Value used to determine whether to enable min-max planning for a subinventory item.",
            "nullable":true
        },
        "MinimumMinmaxQuantity":{
            "title":"Minimum Quantity",
            "type":"number",
            "description":"Minimum quantity for min-max replenishment.",
            "nullable":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
            }
        },
        "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
        },
        "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 in the subinventory.",
            "nullable":true
        },
        "SourceOrderingUOMMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure to use for sourcing.",
            "nullable":true
        },
        "MaximumOrderQuantity":{
            "title":"Maximum Order Quantity",
            "type":"number",
            "description":"Maximum order quantity for replenishment.",
            "nullable":true
        },
        "MinmaxQuantityUOMMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure to use for the min-max quantities.",
            "nullable":true
        },
        "PreprocessingLeadTime":{
            "title":"Preprocessing",
            "type":"integer",
            "description":"Preprocessing lead time to use while sourcing the item.",
            "nullable":true
        },
        "onhandQuantity":{
            "title":"On-Hand Quantities",
            "type":"array",
            "description":"The On-Hand Quantities resource provides the on-hand quantities for the items associated with a subinventory in their primary unit of measure.",
            "items":{
                "$ref":"#/components/schemas/subinventoryItems-onhandQuantity-item-patch-request"
            }
        },
        "MinmaxQuantityUOM":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure to use for the min-max quantities.",
            "nullable":true
        },
        "MinimumMaximumPlanningCode":{
            "title":"Inventory Planning Method",
            "type":"integer",
            "description":"Abbreviation that determines whether to enable min-max planning for a subinventory item. List of accepted values are 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"
            }
        },
        "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
        },
        "MinimumOrderQuantity":{
            "title":"Minimum Order Quantity",
            "type":"number",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true
        },
        "QuantityCountTolerance":{
            "title":"Count Tolerance Percentage",
            "type":"number",
            "description":"Count tolerance percent to use before which the application doesn't allow the count. This tolerance prevents data-entry mistakes when counting, and prevents ordering more than required quantity for the replenishment request.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SecondaryInventory"
                ]
            }
        },
        "PostprocessingLeadTime":{
            "title":"Postprocessing",
            "type":"integer",
            "description":"Postprocessing lead time to use while sourcing the item.",
            "nullable":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",
                    "SecondaryInventory"
                ]
            }
        }
    }
}

Nested Schema : On-Hand Quantities

Type: array

Title: On-Hand Quantities

The On-Hand Quantities resource provides the on-hand quantities for the items associated with a subinventory in their primary unit of measure.

Show Source

• Array of: object subinventoryItems-onhandQuantity-item-patch-request

{
    "title":"On-Hand Quantities",
    "type":"array",
    "description":"The On-Hand Quantities resource provides the on-hand quantities for the items associated with a subinventory in their primary unit of measure.",
    "items":{
        "$ref":"#/components/schemas/subinventoryItems-onhandQuantity-item-patch-request"
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The Flexfields for Subinventory Items resource manages descriptive flexfields that contain details about subinventory items.

Show Source

• Array of: object schema

{
    "title":"Flexfields",
    "type":"array",
    "description":"The Flexfields for Subinventory Items resource manages descriptive flexfields that contain details about subinventory items.",
    "items":{
        "$ref":"#/components/schemas/subinventoryItems-subinventoryItemsDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : subinventoryItems-onhandQuantity-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : schema

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

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "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"
                }
            }
        },
        "__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_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : subinventoryItems-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 subinventory item 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.
• 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 a subinventory item. List of accepted values are defined in the lookup type INV_MATERIAL_PLANNING.
• MinimumMaximumPlanningMeaning: string
  Maximum Length: 255

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

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

  Value that uniquely identifies the organization.
• 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.
• onhandQuantity: array On-Hand Quantities
  Title: On-Hand Quantities

  The On-Hand Quantities resource provides the on-hand quantities for the items associated with a subinventory in their primary unit of measure.
• OrganizationCode: string
  Maximum Length: 255

  Minimum order quantity for replenishment.
• OrganizationId: integer (int64)
  Abbreviation that identifies the organization that references the subinventory item.
• ParLevel: number
  Title: PAR Level

  Level that the application uses for the subinventory item 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

  Postprocessing 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 which the application doesn't allow the count. This tolerance prevents data-entry mistakes when counting, and prevents ordering more than required 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 in the subinventory.
• SubinventoryItemId: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the subinventory item.
• subinventoryItemsDFF: array Flexfields
  Title: Flexfields

  The Flexfields for Subinventory Items resource manages descriptive flexfields that contain details about subinventory items.

{
    "type":"object",
    "properties":{
        "subinventoryItemsDFF":{
            "title":"Flexfields",
            "type":"array",
            "description":"The Flexfields for Subinventory Items resource manages descriptive flexfields that contain details about subinventory items.",
            "items":{
                "$ref":"#/components/schemas/subinventoryItems-subinventoryItemsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the subinventory item 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 subinventory item 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
        },
        "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
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Abbreviation that identifies the organization that references the subinventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ParUOMCode"
                ]
            }
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Minimum order quantity for replenishment.",
            "nullable":true,
            "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 a subinventory item.",
            "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 in 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
        },
        "SubinventoryItemId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the subinventory item.",
            "nullable":true,
            "readOnly":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
        },
        "onhandQuantity":{
            "title":"On-Hand Quantities",
            "type":"array",
            "description":"The On-Hand Quantities resource provides the on-hand quantities for the items associated with a subinventory in their primary unit of measure.",
            "items":{
                "$ref":"#/components/schemas/subinventoryItems-onhandQuantity-item-response"
            }
        },
        "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 a subinventory item. List of accepted values are 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":"Value that uniquely identifies the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityCountTolerance":{
            "title":"Count Tolerance Percentage",
            "type":"number",
            "description":"Count tolerance percent to use before which the application doesn't allow the count. This tolerance prevents data-entry mistakes when counting, and prevents ordering more than required quantity for the replenishment request.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InventoryItemId",
                    "OrganizationId",
                    "SecondaryInventory"
                ]
            },
            "x-queryable":true
        },
        "PostprocessingLeadTime":{
            "title":"Postprocessing",
            "type":"integer",
            "description":"Postprocessing lead time to use while sourcing the item.",
            "nullable":true,
            "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",
                    "SecondaryInventory"
                ]
            },
            "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 : On-Hand Quantities

Type: array

Title: On-Hand Quantities

The On-Hand Quantities resource provides the on-hand quantities for the items associated with a subinventory in their primary unit of measure.

Show Source

• Array of: object subinventoryItems-onhandQuantity-item-response

{
    "title":"On-Hand Quantities",
    "type":"array",
    "description":"The On-Hand Quantities resource provides the on-hand quantities for the items associated with a subinventory in their primary unit of measure.",
    "items":{
        "$ref":"#/components/schemas/subinventoryItems-onhandQuantity-item-response"
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The Flexfields for Subinventory Items resource manages descriptive flexfields that contain details about subinventory items.

Show Source

• Array of: object subinventoryItems-subinventoryItemsDFF-item-response

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

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 : subinventoryItems-onhandQuantity-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryOnhandQuantity: number
  Read Only: true

  Value that identifies the on-hand quantity for an item in a subinventory in its primary unit of measure.
• PrimaryUnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Value that identifies the unit of measure for an item associated with a subinventory.
• PrimaryUOMCode: string
  Read Only: true

  Maximum Length: 3

  Value that identifies the unit of measure code for an item associated with a subinventory.

{
    "type":"object",
    "properties":{
        "PrimaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Value that identifies the unit of measure code for an item associated with a subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryUnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Value that identifies the unit of measure for an item associated with a subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryOnhandQuantity":{
            "type":"number",
            "description":"Value that identifies the on-hand quantity for an item in a subinventory in its primary unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : subinventoryItems-subinventoryItemsDFF-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
• 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",
            "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_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"
    }
}

Links

onhandQuantity

Operation: /fscmRestApi/resources/11.13.18.05/subinventoryItems/{SubinventoryItemId}/child/onhandQuantity

Parameters:

• SubinventoryItemId: $request.path.SubinventoryItemId

The On-Hand Quantities resource provides the on-hand quantities for the items associated with a subinventory in their primary unit of measure.

subinventoryItemsDFF

Operation: /fscmRestApi/resources/11.13.18.05/subinventoryItems/{SubinventoryItemId}/child/subinventoryItemsDFF

Parameters:

• SubinventoryItemId: $request.path.SubinventoryItemId

The Flexfields for Subinventory Items resource manages descriptive flexfields that contain details about subinventory items.

Back to Top

Examples

This example describes how to update one subinventory item.

Example cURL Command

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

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/subinventoryItems/subinventoryItemsUniqID"

For example, this command updates the mininum order quantity and the maximumn order quantity in item subinventory 00030000000EACED00057708000110F07C424F9A0000000EACED0005770800000000000000CF000000084142435355423031s:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/subinventoryItems/00030000000EACED00057708000110F07C424F9A0000000EACED0005770800000000000000CF000000084142435355423031"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{ 

"MinimumOrderQuantity": 100, 

"MaximumOrderQuantity": 1000

}

Example Response Body

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

{

    "FixedLotMultiple": 10,

    "InventoryItemId": 663913,

    "MinimumMaximumPlanningCode": 6,

    "MaximumMinmaxQuantity": 100,

    "MaximumOrderQuantity": 150,

    "MinmaxQuantityUOM": "Ea",

    "MinmaxQuantityUOMMeasure": null,

    "MinimumMinmaxQuantity": 10,

    "MinimumOrderQuantity": 100,

    "OrganizationId": 207,

    "OrganizationCode": "M1",

    "PostprocessingLeadTime": 5,

    "PreprocessingLeadTime": 15,

    "ProcessingLeadTime": 10,

    "SecondaryInventory": "AALOCSUB1",

    "SourceOrganizationId": null,

    "SourceSubinventory": null,

    "SourceOrderingUOM": null,

    "SourceOrderingUOMMeasure": null,

    "SourceType": null,

    "ItemNumber": "INV-100",

    "SourceOrganizationCode": null,

    "ParLevel": null,

    "ParMaximumQuantity": null,

    "ParUOMCode": null,

    "ParUOMMeasure": null,

    "DefaultCountTypeCode": null,

    "CountRequired": null,

    "QuantityCountTolerance": null,

    "links": [

        {

            "rel": "self",

            "href": "https://servername/fscmRestApi/resources/version/subinventoryItems/00030000000EACED0005770800000000000A21690000000EACED0005770800000000000000CF0000000941414C4F4353554231",

            "name": "subinventoryItems",

            "kind": "item",

            "properties": {

                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"

            }

        },

        {

            "rel": "canonical",

            "href": "https://servername/fscmRestApi/resources/version/subinventoryItems/00030000000EACED0005770800000000000A21690000000EACED0005770800000000000000CF0000000941414C4F4353554231",

            "name": "subinventoryItems",

            "kind": "item"

        },

        {

            "rel": "child",

            "href": "https://servername/fscmRestApi/resources/version/subinventoryItems/00030000000EACED0005770800000000000A21690000000EACED0005770800000000000000CF0000000941414C4F4353554231/child/subinventoryItemsDFF",

            "name": "subinventoryItemsDFF",

            "kind": "collection"

        }

    ]
}

Back to Top