1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Locator Items

Get one locator item

get

/fscmRestApi/resources/11.13.18.05/locatorItems/{LocatorItemId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : locatorItems-item-response
Type: object
Show Source
  • 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.
  • Read Only: true
    Date when the user created the locator item record.
  • 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.
  • 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.
  • 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.
  • Value that uniquely identifies the item.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Value that identifies the description of the item associated with a locator in a subinventory.
  • Maximum Length: 255
    Name of the inventory item.
  • 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.
  • Date when the item was last replenished for a location during par counting.
  • Links
  • Title: Description
    Read Only: true
    Maximum Length: 50
    Description of the locator that references the locator item.
  • Title: Locator
    Value that uniquely identifies the locator.
  • Read Only: true
    Value that uniquely identifies the locator item.
  • Maximum Length: 255
    Name of the locator that references the locator item.
  • Manufacturer Part Numbers
    Title: Manufacturer Part Numbers
    The MPNs resource provides a list of manufacturer part numbers (MPNs) associated with items.
  • 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.
  • Maximum Length: 255
    Abbreviation that identifies the organization that references the locator item.
  • Value that uniquely identifies the inventory organization.
  • Title: PAR Level
    Level that the application uses during periodic automatic replenishment for the locator item.
  • Title: PAR Maximum Quantity
    Maximum quantity to use during periodic automatic replenishment.
  • Maximum Length: 3
    Code that identifies the unit of measure to use for quantities during periodic automatic replenishment.
  • Title: PAR Level UOM
    Unit of measure to use for quantities during periodic automatic replenishment.
  • 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.
  • 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 : Manufacturer Part Numbers
Type: array
Title: Manufacturer Part Numbers
The MPNs resource provides a list of manufacturer part numbers (MPNs) associated with items.
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: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Value that identifies the global trade item number for an item.
  • Links
Nested Schema : locatorItems-MPNs-item-response
Type: object
Show Source
Nested Schema : locatorItems-onhandQuantity-item-response
Type: object
Show Source
  • Links
  • Read Only: true
    Value that identifies the on-hand quantity for an item in a subinventory in its primary unit of measure.
  • Read Only: true
    Maximum Length: 25
    Value that identifies the unit of measure for an item associated with a subinventory.
  • Read Only: true
    Maximum Length: 3
    Value that identifies the unit of measure code for an item associated with a subinventory.
  • Read Only: true
    Value that indicates the on-hand quantity for an item in the stocking unit of measure of the subinventory.
  • Read Only: true
    Maximum Length: 25
    Value that indicates the unit of measure in which the items are stocked in a subinventory.
  • Read Only: true
    Maximum Length: 3
    Value that indicates the unit of measure code in which the items are stocked in a subinventory.
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.
MPNs
Parameters:
  • LocatorItemId: $request.path.LocatorItemId
The MPNs resource provides a list of manufacturer part numbers (MPNs) associated with items.
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.
Back to Top

Examples

This example describes how to get one locator item.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/subinventories/subinventoriesUniqID/child/locators/locatorsUniqID/child/itemLocators/LocatorItemId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "InventoryItemId": 648,
    "LocatorItemId": 3301,
    "OrganizationId": 207,
    "OrganizationCode": "M1",
    "LocatorId": 10,
    "LocatorName": "11.10.BB",
    "SubinventoryCode": "Stores",
    "ItemNumber": "CM82333",
    "ParLevel": null,
    "ParMaximumQuantity": null,
    "ParUOMCode": null,
    "ParUOMMeasure": null,
    "CountRequired": null,
    "DefaultCountTypeCode": null,
    "QuantityCountTolerance": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/locatorItems/3301",
            "name": "locatorItems",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/locatorItems/3301",
            "name": "locatorItems",
            "kind": "item"
        }
    ]
}
Back to Top