Create locators
/fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}/child/locators
Request
-
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:
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
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. -
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.
array
Item Locators
array
Flexfields for Locators
array
Flexfields for Locator Keys
-
Array of:
object Discriminator: _STRUCTURE_INSTANCE_NUMBER
Discriminator:
{ "propertyName":"_STRUCTURE_INSTANCE_NUMBER", "mapping":{ "1004":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-post-request" } }
object
-
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
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.
-
ItemNumber: string
Maximum Length:
255
Name of the inventory item. -
LastReplenishedDate: string
(date-time)
Date when the item was last replenished for a locator during par counting.
-
LocatorId: integer
(int64)
Title:
Locator
Value that uniquely identifies the 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.
object
-
__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.
object
Discriminator Values
object
-
_INVENTORY_LOCATION_ID: integer
(int64)
Title:
Locator
Number that uniquely identifies the locator. -
_STRUCTURE_INSTANCE_NUMBER: integer
(int64)
Title:
Locator Structure
Default Value:1004
Value 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:
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: don't enable the locator. There's no default value for this attribute. -
EndDateActive: string
(date)
Date when the locator becomes inactive.
-
rack: string
Title:
Rack
Maximum Length:40
-
row: string
Title:
Row
Maximum Length:40
-
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:
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.
array
Item Locators
array
Links
array
Flexfields for Locators
array
Flexfields for Locator Keys
-
Array of:
object Discriminator: _STRUCTURE_INSTANCE_NUMBER
Discriminator:
{ "propertyName":"_STRUCTURE_INSTANCE_NUMBER", "mapping":{ "1004":"#/components/schemas/oracle_apps_scm_inventory_flex_stockLocator_view_LocatorFlexFieldPREDEF__5FSTOCK__5FLOCATOR__5FSTRUCT__5FINVO-item-response" } }
object
-
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.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
__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.
array
Links
object
Discriminator Values
object
-
_INVENTORY_LOCATION_ID: integer
(int64)
Title:
Locator
Number that uniquely identifies the locator. -
_STRUCTURE_INSTANCE_NUMBER: integer
(int64)
Title:
Locator Structure
Default Value:1004
Value 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:
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: 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:
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.
array
Links
- 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 create locators in one subinventory.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/subinventories/subinventoriesUniqID/child/locators"
For example, the following command creates locators in subinventory 00020000000EACED0005770800000000000000CF000000084142435355423031:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators"
Example Request Body
Note that you must include locatorsKeyFlex in the request body because the locator and locatorsKeyFlex together constitute the key that identifies the flexfield.
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 creates.
{ "Description": null, "DisableDate": null, "InventoryLocationType": null, "PickingOrder": null, "MaterialStatusId": 1, "StructureInstanceNumber": 101, "MaterialStatusCode": "Active", "locatorsKeyFlex": [ { "EnabledFlag": "Y", "_Row": "R1", "_Rack": "1", "_Bin": "1" } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "Description": null, "DisableDate": null, "InventoryLocationType": null, "PickingOrder": null, "MaterialStatusId": 1, "StructureInstanceNumber": 101, "SubinventoryCode": "ABCSUB01", "MaterialStatusCode": "Active", "locatorsKeyFlex": [ { "StartDateActive": null, "EndDateActive": null, "EnabledFlag": "Y", "_INVENTORY_LOCATION_ID": 300100132042551, "_SUBINVENTORY_ID": 5161, "_STRUCTURE_INSTANCE_NUMBER": 101, "_Row": "R1", "_Rack": "1", "_Bin": "1", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551/child/locatorsKeyFlex/300100132042551", "name": "locatorsKeyFlex", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551/child/locatorsKeyFlex/300100132042551", "name": "locatorsKeyFlex", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551", "name": "locators", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/locators/300100132042551", "name": "locators", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "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" } ] }