Get all locator items
get
/fscmRestApi/resources/11.13.18.05/locatorItems
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds locator items.
Finder Variables:- LocatorItemId; integer; Value that uniquely identifies the locator item ID.
- findOnhand: Finds on-hand inventory.
Finder Variables:- bindInventoryItemId; integer; Value that uniquely identifies the item.
- bindLocatorId; integer; Value that uniquely identifies the locator.
- bindOrgId; integer; Value that uniquely identifies the organization.
- bindSubinventoryCode; string; Name of the subinventory.
- PrimaryKey: Finds locator items.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CountRequired; string; 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 when the user created the locator item record.
- DefaultCountType; string; 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; 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; Value that uniquely identifies the item.
- ItemDescription; string; Value that identifies the description of the item associated with a locator in a subinventory.
- ItemNumber; string; Name of the inventory item.
- ItemPrimaryImageURL; string; Value that provides a reference to the image of the item for which the count sequence is generated.
- LastReplenishedDate; string; Date when the item was last replenished for a location during par counting.
- LocatorDescription; string; Description of the locator that references the locator item.
- LocatorId; integer; Value that uniquely identifies the locator.
- LocatorItemId; integer; Value that uniquely identifies the locator item.
- LocatorName; string; Name of the locator that references the locator item.
- OrganizationCode; string; Abbreviation that identifies the organization that references the locator item.
- OrganizationId; integer; Value that uniquely identifies the inventory organization.
- ParLevel; number; Level that the application uses during periodic automatic replenishment for the locator item.
- ParMaximumQuantity; number; Maximum quantity to use during periodic automatic replenishment.
- ParUOMCode; string; Code that identifies the unit of measure to use for quantities during periodic automatic replenishment.
- ParUOMMeasure; string; Unit of measure to use for quantities during periodic automatic replenishment.
- QuantityCountTolerance; number; 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; Abbreviation that identifies the subinventory.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
Examples
This example describes how to get all locator items.
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/locatorItems"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "items": [ { "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" } ] }, { "InventoryItemId": 300100039626666, "LocatorItemId": 300100039728424, "OrganizationId": 207, "OrganizationCode": "M1", "LocatorId": 3094, "LocatorName": "1.1.", "SubinventoryCode": "ABCSUB01", "ItemNumber": "MFG-D-SER-LOT-REV-LOC-PROD1", "ParLevel": null, "ParMaximumQuantity": null, "ParUOMCode": null, "ParUOMMeasure": null, "CountRequired": null, "DefaultCountTypeCode": null, "QuantityCountTolerance": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/locatorItems/300100039728424", "name": "locatorItems", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/locatorItems/300100039728424", "name": "locatorItems", "kind": "item" } ] } ] }