Get all inventory pick lines

get

/fscmRestApi/resources/11.13.18.05/inventoryPickLines

Request

Query Parameters
  • 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
  • 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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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.
  • 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
  • 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 : inventoryPickLines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : inventoryPickLines-item-response
Type: object
Show Source
Nested Schema : Lines
Type: array
Title: Lines
The Lines for Inventory Movement Requests resource manages lines for movement requests.
Show Source
Nested Schema : inventoryPickLines-MovementRequestLine-item-response
Type: object
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : inventoryStripingDFF
Type: array
Show Source
Nested Schema : projectDFF
Type: array
Show Source
Nested Schema : inventoryPickLines-MovementRequestLine-DFF-item-response
Type: object
Show Source
Nested Schema : inventoryPickLines-MovementRequestLine-inventoryStripingDFF-item-response
Type: object
Show Source
Nested Schema : inventoryPickLines-MovementRequestLine-projectDFF-item-response
Type: object
Show Source
Back to Top