Get all inventory pick lines
get
/fscmRestApi/resources/11.13.18.05/inventoryPickLines
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 inventory pick line according to the primary key.
Finder Variables- LineId; integer; Value that uniquely identifies a movement request line
- findByProjectTask Finds pick lines according to the line identifier.
Finder Variables- bindDemandProjectId; integer; Value that identifies a project based on the primary key.
- bindDemandTaskId; integer; Value that identifies a task corresponding to a project based on the primary key.
- PrimaryKey Finds inventory pick line according to the primary key.
-
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:- CustomerId; integer; Unique identifier of the customer.
- CustomerName; string; Value that identifies the customer name.
- DemandDocumentId; number; Unique identifier for demand document.
- DemandDocumentLineId; number; Unique identifier for demand document line.
- DemandDocumentLineNumber; string; Value that identifies the demand document line.
- DemandDocumentNumber; string; Number that identifies demand document.
- DemandDocumentType; string; Description of demand document type.
- DemandDocumentTypeId; integer; Value that uniquely identifies the demand document type.
- DemandProjectId; integer; Value that uniquely identifies demand project.
- DemandProjectNumber; string; Number that identifies demand project.
- DemandProjectTaskId; integer; Value that uniquely identifies demand project task.
- DemandProjectTaskNumber; string; Number that identifies project task number.
- DueDate; string; Date that indicates the due date.
- FromSubinventoryCode; string; Abbreviation that identifies the source subinventory.
- HeaderId; integer; Value that uniquely identifies the header.
- ItemId; integer; Unique identifier for the item.
- ItemNumber; string; Value that identifies the item.
- LineId; integer; Value that uniquely identifies the line.
- MoveOrderType; integer; Value that identifies the move order type.
- OrganizationId; integer; Unique identifier for the organization.
- OriginalItemId; integer; Value that uniquely identifies the original item.
- PickConfirmedQuantity; number; Value that identifies the confirmed quantity for pick.
- PickLineCount; number; Value that identifies the count in pick.
- PickQuantity; number; Value that identifies the quantity for pick.
- PickStatus; string; Status of the picking process for the line, indicating the current stage.
- PickStatusCode; string; Value that identifies the pick status code.
- QuantityDelivered; number; Value that indicates the quantity delivered.
- RequestedQuantity; number; Value that indicates the requested quantity.
- ReservationsExist; string; Value that identifies the presence of reservations.
- ReservationsExistFlag; boolean; Value that indicates the presense of reservation.
- Revision; string; Value that indicates the revision of the inventory item.
- ToAccount; string; Number that indicates the destination account for the movement request.
- ToAccountId; integer; Value that uniquely identifies the destination account.
- ToSubinventoryCode; string; Abbreviation that identifies the destination subinventory.
- UOMCode; string; Abbreviation that identifies the unit of measure of the line quantity.
- UOMName; string; Name of the unit of measure of the line quantity.
- WorkOrderOperationSequence; number; Number that identifies the work order operation sequence.
- WorkOrderProduct; string; Value that identifies work order product.
-
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: 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.
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 : inventoryPickLines
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryPickLines-item-response
Type:
Show Source
object-
CustomerId: integer
(int64)
Read Only:
trueUnique identifier of the customer. -
CustomerName: string
Read Only:
trueMaximum Length:360Value that identifies the customer name. -
DemandDocumentId: number
Read Only:
trueUnique identifier for demand document. -
DemandDocumentLineId: number
Read Only:
trueUnique identifier for demand document line. -
DemandDocumentLineNumber: string
Read Only:
trueMaximum Length:150Value that identifies the demand document line. -
DemandDocumentNumber: string
Read Only:
trueMaximum Length:150Number that identifies demand document. -
DemandDocumentType: string
Read Only:
trueMaximum Length:80Description of demand document type. -
DemandDocumentTypeId: integer
(int64)
Read Only:
trueValue that uniquely identifies the demand document type. -
DemandProjectId: integer
(int64)
Read Only:
trueValue that uniquely identifies demand project. -
DemandProjectNumber: string
Read Only:
trueMaximum Length:25Number that identifies demand project. -
DemandProjectTaskId: integer
(int64)
Read Only:
trueValue that uniquely identifies demand project task. -
DemandProjectTaskNumber: string
Read Only:
trueMaximum Length:100Number that identifies project task number. -
DueDate: string
(date)
Read Only:
trueDate that indicates the due date. -
FromSubinventoryCode: string
Title:
Source SubinventoryRead Only:trueMaximum Length:10Abbreviation that identifies the source subinventory. -
HeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the header. -
ItemId: integer
(int64)
Read Only:
trueUnique identifier for the item. -
ItemNumber: string
Read Only:
trueMaximum Length:300Value that identifies the item. -
LineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MovementRequestLine: array
Lines
Title:
LinesThe Lines for Inventory Movement Requests resource manages lines for movement requests. -
MoveOrderType: integer
(int64)
Read Only:
trueValue that identifies the move order type. -
OrganizationId: integer
(int64)
Read Only:
trueUnique identifier for the organization. -
OriginalItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the original item. -
PickConfirmedQuantity: number
Read Only:
trueValue that identifies the confirmed quantity for pick. -
PickLineCount: number
Read Only:
trueValue that identifies the count in pick. -
PickQuantity: number
Read Only:
trueValue that identifies the quantity for pick. -
PickStatus: string
Read Only:
trueMaximum Length:80Status of the picking process for the line, indicating the current stage. -
PickStatusCode: string
Read Only:
trueMaximum Length:30Value that identifies the pick status code. -
QuantityDelivered: number
Read Only:
trueValue that indicates the quantity delivered. -
RequestedQuantity: number
Read Only:
trueValue that indicates the requested quantity. -
ReservationsExist: string
Read Only:
trueMaximum Length:1Value that identifies the presence of reservations. -
ReservationsExistFlag: boolean
Read Only:
trueMaximum Length:255Value that indicates the presense of reservation. -
Revision: string
Title:
RevisionRead Only:trueMaximum Length:18Value that indicates the revision of the inventory item. -
ToAccount: string
Title:
Destination AccountRead Only:trueMaximum Length:4000Number that indicates the destination account for the movement request. -
ToAccountId: integer
(int64)
Title:
Destination AccountRead Only:trueValue that uniquely identifies the destination account. -
ToSubinventoryCode: string
Title:
Destination SubinventoryRead Only:trueMaximum Length:10Abbreviation that identifies the destination subinventory. -
UOMCode: string
Title:
UOMRead Only:trueMaximum Length:3Abbreviation that identifies the unit of measure of the line quantity. -
UOMName: string
Title:
UOMRead Only:trueMaximum Length:25Name of the unit of measure of the line quantity. -
WorkOrderOperationSequence: number
Read Only:
trueNumber that identifies the work order operation sequence. -
WorkOrderProduct: string
Read Only:
trueMaximum Length:300Value that identifies work order product.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Lines
Type:
arrayTitle:
LinesThe Lines for Inventory Movement Requests resource manages lines for movement requests.
Show Source
Nested Schema : link
Type:
Show Source
object-
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.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : inventoryPickLines-MovementRequestLine-item-response
Type:
Show Source
object-
AvailableToTransact: string
Read Only:
trueMaximum Length:255Quantity that's available to transact for an item in a movement request. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the line. -
DestinationAccount: string
Number that indicates the destination account for the movement request.
-
DestinationAccountAlias: string
Read Only:
trueValue that identifies the destination account alias. -
DestinationAccountId: integer
(int64)
Title:
Destination AccountValue that uniquely identifies the destination account. -
DestinationLocator: string
Maximum Length:
255Description of the destination stock locator. -
DestinationLocatorId: integer
(int64)
Title:
Destination LocatorValue that uniquely identifies the destination stock locator. -
DestinationSubinventory: string
Title:
Destination SubinventoryMaximum Length:10Abbreviation that identifies the destination subinventory. -
DFF: array
DFF
-
ExternalSystemAllocatedQuantity: number
Read Only:
trueAllocated quantity of the UOM of movement request lines interfaced with an external system. This value is interfaced only for movement requests of type shop floor. -
ExternalSystemCancelledQuantity: number
Read Only:
trueCanceled quantity of the UOM of movement request lines interfaced with an external system. This value is interfaced only for movement requests of the type shop floor. -
ExternalSystemGroupId: integer
(int64)
Read Only:
trueValue that uniquely identifies the movement request lines that need to be interfaced with an external system. -
ExternalSystemRequestedQuantity: number
Read Only:
trueRequested quantity of the UOM of movement request lines interfaced with an external system. This value is interfaced only for movement requests of type shop floor. -
ExternalSystemRequestedQuantityInPUOM: number
Read Only:
trueRequested quantity in Item's primary UOM interfaced by external system. This value gets interfaced only for movement requests of type shop floor. -
FromSerialNumber: string
Title:
From Serial NumberMaximum Length:80Starting serial number in a range of serial numbers that tracks items that are in inventory. The application uses this attribute when the warehouse places the item under serial control. -
Grade: string
Title:
GradeRead Only:trueMaximum Length:150Abbreviation that identifies the grade of the item. -
HeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the movement request header. -
IntegrationStatus: string
Read Only:
trueMaximum Length:255Integration status of the movement request lines interfaced to an external system. It has one of the following values: Interfaced, Confirmed, or Not Applicable. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
inventoryStripingDFF: array
inventoryStripingDFF
-
ItemDescription: string
Read Only:
trueMaximum Length:255Description of the inventory item. -
ItemNumber: string
Maximum Length:
255Name of the inventory item. -
ItemRevision: string
Maximum Length:
18Value that indicates the revision of the inventory item. -
KanbanCardId: integer
(int64)
Value that uniquely identifies the Kanban card.
-
KanbanCardNumber: string
Maximum Length:
255Kanban card number corresponding to the movement request line. -
LineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the movement request line. -
LineNumber: integer
(int64)
Title:
Line NumberRead Only:trueValue that uniquely identifies the movement request line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotNumber: string
Title:
LotMaximum Length:80Number that identifies the lot for the inventory item. This attribute is used when the warehouse places the item under lot control. -
Order: string
Read Only:
trueMaximum Length:255Number that identifies the sales order in the order capture application. -
PrimaryUOMQuantity: number
Read Only:
trueQuantity requested for the item in the primary unit of measure. -
projectDFF: array
projectDFF
-
QuantityDelivered: number
Title:
Delivered QuantityRead Only:trueQuantity delivered for the item. -
Reason: string
Maximum Length:
255Name of the movement request reason. -
ReasonId: integer
(int64)
Title:
ReasonValue that uniquely identifies the movement request reason. -
Reference: string
Title:
ReferenceMaximum Length:240Reference to the movement request. -
ReferenceSourceType: string
Read Only:
trueMaximum Length:255Name of the reference type. -
ReferenceTypeCode: integer
(int64)
Title:
Reference Source TypeRead Only:trueValue that uniquely identifies the reference type. -
RequestedQuantity: number
Title:
Requested QuantityQuantity requested for the item. -
RequesterId: integer
(int64)
Value that uniquely identifies the person who requested the movement.
-
RequesterName: string
Name of the person who requested the movement.
-
RequiredDate: string
(date-time)
Title:
Required DateDate when the movement request line is required. -
SecondaryQuantityDelivered: number
Title:
Secondary Delivered QuantityRead Only:trueQuantity delivered for the item in the secondary unit of measure. -
SecondaryRequestedQuantity: number
Title:
Secondary Requested QuantityQuantity requested for the item in the secondary unit of measure. -
SecondaryUOMCode: string
Title:
Secondary Quantity UOMRead Only:trueMaximum Length:3Abbreviation that identifies the secondary unit of measure of the line quantity. -
SecondaryUOMName: string
Read Only:
trueMaximum Length:255Name of the secondary unit of measure of the line quantity. -
ShipToLocation: string
Read Only:
trueMaximum Length:255Name of the ship-to location. -
ShipToLocationId: integer
(int64)
Title:
Ship-to LocationDate when the user requested the transfer order. -
SourceLocator: string
Maximum Length:
255Description of the source stock locator. -
SourceLocatorId: integer
(int64)
Title:
Source LocatorValue that uniquely identifies the source stock locator. -
SourceSubinventory: string
Title:
Source SubinventoryMaximum Length:10Abbreviation that identifies the source subinventory. -
Status: string
Maximum Length:
255Value that indicates the status for the movement request line. -
StatusCode: integer
(int64)
Title:
StatusDefault Value:1Value that uniquely identifies the line status for the movement request. A list of accepted values is defined in the lookup type INV_TXN_REQUEST_STATUS. -
StatusDate: string
(date)
Title:
Status DateRead Only:trueDate when the status of the movement request changed. -
ToSerialNumber: string
Title:
To Serial NumberMaximum Length:80Ending serial number in a range of serial numbers that tracks items that are in inventory. The application uses this attribute when the warehouse places the item under serial control. -
TransactionSourceId: integer
Value that uniquely identifies the transaction source.
-
TransactionSourceLineId: integer
Value that uniquely identifies the transaction source line.
-
TransactionSourceTypeId: integer
Value that uniquely identifies the transaction source type.
-
TransactionType: string
Maximum Length:
255Name of the transaction type. -
TransactionTypeId: integer
Title:
Transaction TypeValue that uniquely identifies the type of transaction. -
UOMCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure of the line quantity. -
UOMName: string
Maximum Length:
255Name of the unit of measure of the line quantity. -
ValidDestinationFlag: boolean
Read Only:
trueContains one of the following values: True or False. If True, then destination account or destination subinventory are valid. If False, then destination account or destination subinventory aren't valid. -
WorkCenterCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the work center.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryPickLines-MovementRequestLine-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
LineId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryPickLines-MovementRequestLine-inventoryStripingDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Country of Origin -
countryOfOriginCode_Display: string
Title:
Country of OriginCountry of Origin -
LineId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectProject -
projectId_Display: string
Title:
ProjectProject -
taskId: integer
(int64)
Title:
TaskTask -
taskId_Display: string
Title:
TaskTask
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryPickLines-MovementRequestLine-projectDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:40Default Value:INV_Misc_TransactionsContext Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
LineId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source