Update one locator
/fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}/child/locators/{InventoryLocationId}
Request
-
InventoryLocationId(required): integer(int64)
Value that uniquely identifies the locator.
-
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>
-
Metadata-Context: string
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: string
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.
- application/json
object-
Description: string
Title:
DescriptionMaximum Length:50Description of the locator. -
DisableDate: string
(date)
Title:
End DateDate when the locator is disabled for use in the application. -
FullLPNFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the full LPN transaction is enforced in the locator. If false, then the full LPN transaction isn't enforced. -
InventoryLocationType: string
Title:
TypeMaximum Length:30Value that identifies the locator type. A list of accepted values is defined in the lookup type INV_LOCATOR_TYPES. -
InventoryLocationTypeMeaning: string
Maximum Length:
255Value of the locator type. -
itemLocators: array
Item Locators
Title:
Item LocatorsThe Item Locators resource manages operations on item locators. -
locatorsDFF: array
Flexfields for Locators
Title:
Flexfields for LocatorsDescriptive flexfields that contain details about locators. -
locatorsKeyFlex: array
Flexfields for Locator Keys
Title:
Flexfields for Locator KeysFlexfields that contain details about locator keys. -
LPNControl: integer
(int32)
Indicates whether the locator holds loose materials or LPNs.
-
MaterialStatusCode: string
Maximum Length:
255Abbreviation that identifies the material status that references the locator. -
MaterialStatusId: integer
(int64)
Title:
StatusValue that uniquely identifies the material status that references the locator. -
PickingOrder: number
Title:
Picking OrderPicking order for the locator.
arrayItem LocatorsarrayFlexfields for LocatorsarrayFlexfields for Locator Keys-
Array of:
object Discriminator: _STRUCTURE_INSTANCE_NUMBER
Discriminator:
{ "propertyName":"_STRUCTURE_INSTANCE_NUMBER", "mapping":{ "1021":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-patch-request" } }
object-
CountRequired: string
Title:
Count RequiredMaximum Length:1Contains 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:
255The 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 TypeMaximum Length:30Abbreviation 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. -
FullLPNFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the full LPN transaction is enforced for the item in the locator. If false, then the full LPN transaction isn't enforced. -
LastReplenishedDate: string
(date-time)
Date when the item was last replenished for a locator during par counting.
-
ParLevel: number
Title:
PAR LevelLevel that the application uses during periodic-automatic replenishment for the item locator. -
ParMaximumQuantity: number
Title:
PAR Maximum QuantityMaximum quantity to use during periodic-automatic replenishment. -
ParUOMCode: string
Maximum Length:
3Code that identifies the unit of measure to use for quantities during periodic-automatic replenishment. -
ParUOMMeasure: string
Title:
PAR Level UOMUnit of measure to use for quantities during periodic-automatic replenishment. -
QuantityCountTolerance: number
Title:
Count Tolerance PercentageCount 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.
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context value of the locator that the descriptive flexfield references. -
__FLEX_Context_DisplayValue: string
Title:
ContextDisplay value of the locator that the descriptive flexfield references.
objectDiscriminator Values
object-
EnabledFlag: string
Maximum Length:
1Default Value:YContains one of the following values. Y: enable the locator. N: don't enable the locator. There's no default value for this attribute. -
EndDateActive: string
(date)
Date when the locator becomes inactive.
-
StartDateActive: string
(date)
Date when the locator becomes active.
Response
- application/json
Default Response
-
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.
object-
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the locator record. -
Description: string
Title:
DescriptionMaximum Length:50Description of the locator. -
DisableDate: string
(date)
Title:
End DateDate when the locator is disabled for use in the application. -
FullLPNFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the full LPN transaction is enforced in the locator. If false, then the full LPN transaction isn't enforced. -
InventoryLocationId: integer
(int64)
Title:
LocatorValue that uniquely identifies the locator. -
InventoryLocationType: string
Title:
TypeMaximum Length:30Value that identifies the locator type. A list of accepted values is defined in the lookup type INV_LOCATOR_TYPES. -
InventoryLocationTypeMeaning: string
Maximum Length:
255Value of the locator type. -
itemLocators: array
Item Locators
Title:
Item LocatorsThe Item Locators resource manages operations on item locators. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocatorName: string
Read Only:
trueMaximum Length:255Name of the locator. -
locatorsDFF: array
Flexfields for Locators
Title:
Flexfields for LocatorsDescriptive flexfields that contain details about locators. -
locatorsKeyFlex: array
Flexfields for Locator Keys
Title:
Flexfields for Locator KeysFlexfields that contain details about locator keys. -
LPNControl: integer
(int32)
Indicates whether the locator holds loose materials or LPNs.
-
MaterialStatusCode: string
Maximum Length:
255Abbreviation that identifies the material status that references the locator. -
MaterialStatusId: integer
(int64)
Title:
StatusValue that uniquely identifies the material status that references the locator. -
PickingOrder: number
Title:
Picking OrderPicking order for the locator. -
StructureInstanceNumber: integer
(int64)
Title:
Locator StructureValue that uniquely identifies the locator structure. -
SubinventoryCode: string
Maximum Length:
10Abbreviation that identifies the subinventory name.
arrayItem LocatorsarrayLinksarrayFlexfields for LocatorsarrayFlexfields for Locator Keys-
Array of:
object Discriminator: _STRUCTURE_INSTANCE_NUMBER
Discriminator:
{ "propertyName":"_STRUCTURE_INSTANCE_NUMBER", "mapping":{ "1021":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response" } }
object-
CountRequired: string
Title:
Count RequiredMaximum Length:1Contains 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:
trueDate when the user created the item locator record. -
DefaultCountType: string
Maximum Length:
255The 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 TypeMaximum Length:30Abbreviation 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. -
FullLPNFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the full LPN transaction is enforced for the item in the locator. If false, then the full LPN transaction isn't enforced. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the Item.
-
ItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:240Value that identifies the description of the item associated with a locator in a subinventory. -
ItemNumber: string
Maximum Length:
255Name of the inventory item. -
ItemPrimaryImageURL: string
Title:
Primary Image URLRead Only:trueMaximum Length:4000Value 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:
LinksThe link relations associated with the resource instance. -
LocatorDescription: string
Title:
DescriptionRead Only:trueMaximum Length:50Description of the locator that references the locator item. -
LocatorId: integer
(int64)
Title:
LocatorValue that uniquely identifies the locator. -
LocatorItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the item locator. -
LocatorName: string
Maximum Length:
255Name of the locator that references the locator item. -
OrganizationCode: string
Maximum Length:
255Abbreviation that identifies the organization that references the item locator. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
ParLevel: number
Title:
PAR LevelLevel that the application uses during periodic-automatic replenishment for the item locator. -
ParMaximumQuantity: number
Title:
PAR Maximum QuantityMaximum quantity to use during periodic-automatic replenishment. -
ParUOMCode: string
Maximum Length:
3Code that identifies the unit of measure to use for quantities during periodic-automatic replenishment. -
ParUOMMeasure: string
Title:
PAR Level UOMUnit of measure to use for quantities during periodic-automatic replenishment. -
QuantityCountTolerance: number
Title:
Count Tolerance PercentageCount 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:
10Abbreviation that identifies the subinventory.
arrayLinksobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context value of the locator that the descriptive flexfield references. -
__FLEX_Context_DisplayValue: string
Title:
ContextDisplay value of the locator that the descriptive flexfield references. -
InventoryLocationId: integer
(int64)
Title:
LocatorValue that uniquely identifies the locator. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobjectDiscriminator Values
object-
_INVENTORY_LOCATION_ID: integer
(int64)
Title:
LocatorNumber that uniquely identifies the locator. -
_STRUCTURE_INSTANCE_NUMBER: integer
(int64)
Title:
Locator StructureDefault Value:1021Value that uniquely identifies the locator structure for the subinventory when locator control is enabled for the subinventory. -
_SUBINVENTORY_ID: integer
(int64)
Value that uniquely identifies the subinventory.
-
aisle: string
Title:
AisleMaximum Length:40Aisle -
bin: string
Title:
BinMaximum Length:40Bin -
EnabledFlag: string
Maximum Length:
1Default Value:YContains one of the following values. Y: enable the locator. N: don't enable the locator. There's no default value for this attribute. -
EndDateActive: string
(date)
Date when the locator becomes inactive.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
rack: string
Title:
RackMaximum Length:40Rack -
row: string
Title:
RowMaximum Length:40Row -
StartDateActive: string
(date)
Date when the locator becomes active.
arrayLinks- itemLocators
-
Parameters:
- InventoryLocationId:
$request.path.InventoryLocationId - subinventoriesUniqID:
$request.path.subinventoriesUniqID
The Item Locators resource manages operations on item locators. - InventoryLocationId:
- locatorsDFF
-
Parameters:
- InventoryLocationId:
$request.path.InventoryLocationId - subinventoriesUniqID:
$request.path.subinventoriesUniqID
Descriptive flexfields that contain details about locators. - InventoryLocationId:
- locatorsKeyFlex
-
Parameters:
- InventoryLocationId:
$request.path.InventoryLocationId - subinventoriesUniqID:
$request.path.subinventoriesUniqID
Flexfields that contain details about locator keys. - InventoryLocationId:
Examples
This example describes how to update one locator in one subinventory.
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/subinventories/subinventoriesUniqID/child/locators/locatorsUniqID"
For example, the following command updates locator 300100132042551 in subinventory 00020000000EACED0005770800000000000000CF000000084142435355423031:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551
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.
{
"Description": "Test Locator",
"DisableDate": null,
"InventoryLocationType": null,
"PickingOrder": null,
"MaterialStatusId": -3
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"Description": "Test Locator",
"DisableDate": null,
"InventoryLocationType": null,
"PickingOrder": null,
"MaterialStatusId": -3,
"StructureInstanceNumber": 101,
"SubinventoryCode": "ABCSUB01",
"MaterialStatusCode": "Raw Material",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551",
"name": "locators",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551",
"name": "locators",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031",
"name": "subinventories",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551/lov/LocatorTypeLov",
"name": "LocatorTypeLov",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551/lov/KeyFlexfieldStructureInstanceLov",
"name": "KeyFlexfieldStructureInstanceLov",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551/child/itemLocators",
"name": "itemLocators",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551/child/locatorsKeyFlex",
"name": "locatorsKeyFlex",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551/child/locatorsDFF",
"name": "locatorsDFF",
"kind": "collection"
}
]
}