Create locator items
post
/fscmRestApi/resources/11.13.18.05/locatorItems
Request
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.
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
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 is no 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. -
GTINs: array
Global Trade Item Numbers
Title:
Global Trade Item Numbers
The GTINs resource provides a list of global trade item numbers (GTINs) associated with items for a locator. -
InventoryItemId(required): 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 location during par counting.
-
LocatorId(required): integer
(int64)
Title:
Locator
Value that uniquely identifies the locator. -
LocatorName: string
Maximum Length:
255
Name of the locator that references the locator item. -
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 locator in a subinventory in their primary unit of measure. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization that references the locator item. -
OrganizationId(required): 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 locator item. -
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 stops the count. This tolerance prevents data-entry mistakes when counting, and prevents ordering of more than necessary quantity for the replenishment request. -
SubinventoryCode(required): string
Maximum Length:
10
Abbreviation that identifies the subinventory.
Nested Schema : Global Trade Item Numbers
Type:
array
Title:
Global Trade Item Numbers
The GTINs resource provides a list of global trade item numbers (GTINs) associated with items for a locator.
Show Source
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 locator in a subinventory in their primary unit of measure.
Show Source
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : locatorItems-item-response
Type:
Show Source
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 is no default value for this attribute. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the locator 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. -
GTINs: array
Global Trade Item Numbers
Title:
Global Trade Item Numbers
The GTINs resource provides a list of global trade item numbers (GTINs) associated with items for a locator. -
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 location 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 locator item. -
LocatorName: string
Maximum Length:
255
Name of the locator that references the locator item. -
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 locator in a subinventory in their primary unit of measure. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization that references the locator item. -
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 locator item. -
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 stops the count. This tolerance prevents data-entry mistakes when counting, and prevents ordering of more than necessary quantity for the replenishment request. -
SubinventoryCode: string
Maximum Length:
10
Abbreviation that identifies the subinventory.
Nested Schema : Global Trade Item Numbers
Type:
array
Title:
Global Trade Item Numbers
The GTINs resource provides a list of global trade item numbers (GTINs) associated with items for a locator.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 locator in a subinventory in their primary unit of measure.
Show Source
Nested Schema : locatorItems-GTINs-item-response
Type:
Show Source
object
-
GTIN: string
Read Only:
true
Maximum Length:255
Value that identifies the global trade item number for an item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : locatorItems-onhandQuantity-item-response
Type:
Show Source
object
-
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. -
StockingOnhandQuantity: number
Read Only:
true
Value that indicates the on-hand quantity for an item in the stocking unit of measure of the subinventory. -
StockingUnitOfMeasure: string
Read Only:
true
Maximum Length:25
Value that indicates the unit of measure in which the items are stocked in a subinventory. -
StockingUOMCode: string
Read Only:
true
Maximum Length:3
Value that indicates the unit of measure code in which the items are stocked in a subinventory.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- GTINs
-
Parameters:
- LocatorItemId:
$request.path.LocatorItemId
The GTINs resource provides a list of global trade item numbers (GTINs) associated with items for a locator. - LocatorItemId:
- onhandQuantity
-
Parameters:
- LocatorItemId:
$request.path.LocatorItemId
The On-Hand Quantities resource provides the on-hand quantities for the items associated with a locator in a subinventory in their primary unit of measure. - LocatorItemId:
Examples
This example describes how to create locator items.
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.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/locatorItems"
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.
{ "InventoryItemId": null, "OrganizationId": 207, "OrganizationCode": "M1", "LocatorName": "1.1.1", "SubinventoryCode": "AALOCSUB1", "ItemNumber": "INV-100", "ParLevel": null, "ParMaximumQuantity": null, "ParUOMCode": null, "ParUOMMeasure": null, "CountRequired": null, "DefaultCountTypeCode": null }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "InventoryItemId": 663913, "LocatorItemId": 300100568127374, "OrganizationId": 207, "OrganizationCode": "M1", "LocatorId": 300100568126095, "LocatorName": "1.1.1", "SubinventoryCode": "AALOCSUB1", "ItemNumber": "INV-100", "ParLevel": null, "ParMaximumQuantity": null, "ParUOMCode": null, "ParUOMMeasure": null, "CountRequired": null, "DefaultCountTypeCode": null, "QuantityCountTolerance": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/locatorItems/300100568127374", "name": "locatorItems", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/locatorItems/300100568127374", "name": "locatorItems", "kind": "item" } ] }