GET action not supported
get
/fscmRestApi/resources/11.13.18.05/pickTransactions/{TransactionHeaderId}/child/pickLines
Request
Path Parameters
-
TransactionHeaderId(required): integer
Value that uniquely identifies the inventory transaction header.
Query Parameters
-
dependency: string
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> -
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
Finder Variables:
- PrimaryKey
-
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:- ContentLPNId; integer; Value that uniquely identifies the content LPN.
- ContentLicensePlateNumber; string; Name of the content LPN.
- DeliveryCartId; integer; Value that uniquely identifies the delivery cart.
- DestinationLocator; string; Destination locator to use when performing overpick and move.
- DestinationSubinventoryCode; string; Abbreviation that identifies the destination subinventory to use when performing overpick and move.
- EndTime; string; Date and time when the user completed picking the line in the task.
- FromLPNId; integer; Value that uniquely identifies the container from where the item is picked.
- FromLicensePlateNumber; string; Name of the container from where the item is picked.
- LicensePlateNumber; string; Value that uniquely identifies the container where the pick placed the item.
- Locator; string; Locator in the subinventory to use when picking the item. This attribute typically identifies a physical area, such as a row, aisle, bin, or shelf, in the subinventory that stores the item.
- PickSlip; integer; Value that uniquely identifies the pick slip that the pick line references.
- PickSlipLine; integer; Value that uniquely identifies a line on the pick slip.
- PickedQuantity; number; Quantity picked for the pick line in the primary unit of measure.
- Revision; string; Value that uniquely identifies the revision of the item when picking the item
- SecondaryPickedQuantity; number; Quantity picked for the pick line in the secondary unit of measure.
- SourceCode; string; Source code for the transaction.
- StartTime; string; Date and time when the user began picking the line in the task.
- SubinventoryCode; string; Subinventory to use when picking the item.
- ToLPNId; integer; Value that uniquely identifies the container to which the item is transferred.
- ToLicensePlateNumber; string; Name of the container to which the item is transferred.
- TransactionDate; string; Date and time when the transaction occurred.
- UseAllocatedLotSerialFlag; boolean; Indicates whether allocated lots and serials should be used.
-
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 : pickTransactions-pickLines
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 : pickTransactions-pickLines-item-response
Type:
Show Source
object-
ContentLicensePlateNumber: string
Maximum Length:
30Name of the content LPN. -
ContentLPNId: integer
(int64)
Value that uniquely identifies the content LPN.
-
DeliveryCartId: integer
(int64)
Value that uniquely identifies the delivery cart.
-
DestinationLocator: string
Maximum Length:
1000Destination locator to use when performing overpick and move. -
DestinationSubinventoryCode: string
Maximum Length:
10Abbreviation that identifies the destination subinventory to use when performing overpick and move. -
dffs: array
Flexfields
Title:
FlexfieldsThe Flexfields for Pick Lines resource manages the descriptive flexfield that the user uses to set the pick line. -
EndTime: string
(date-time)
Date and time when the user completed picking the line in the task.
-
FromLicensePlateNumber: string
Maximum Length:
30Name of the container from where the item is picked. -
FromLPNId: integer
(int64)
Value that uniquely identifies the container from where the item is picked.
-
inventoryAttributesDFF: array
Flexfields for Inventory Attributes
Title:
Flexfields for Inventory AttributesThe Flexfields for Inventory Attributes resource manages descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in. -
LicensePlateNumber: string
Maximum Length:
30Value that uniquely identifies the container where the pick placed the item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
1000Locator in the subinventory to use when picking the item. This attribute typically identifies a physical area, such as a row, aisle, bin, or shelf, in the subinventory that stores the item. -
lotItemLots: array
Lots for Picked Items
Title:
Lots for Picked ItemsThe Lots for Picked Items resource manages the lot that controls the picked item. Use it when a lot controls the item. -
lotSerialItemLots: array
Lots That Share Control
Title:
Lots That Share ControlThe Lots That Share Control resource manages the lot that controls the picked item. Use it when lots and serials control the item. -
PickedQuantity: number
Quantity picked for the pick line in the primary unit of measure.
-
pickExceptions: array
Exceptions
Title:
ExceptionsThe Pick Exceptions resource manages exceptions for the pick. Use it to modify the suggested attribute values, such as picked quantity, subinventory, locator, lot, and so on. -
PickSlip: integer
(int64)
Value that uniquely identifies the pick slip that the pick line references.
-
PickSlipLine: integer
Value that uniquely identifies a line on the pick slip.
-
Revision: string
Maximum Length:
18Value that uniquely identifies the revision of the item when picking the item -
SecondaryPickedQuantity: number
Quantity picked for the pick line in the secondary unit of measure.
-
serialItemSerials: array
Serials for Picked Items
Title:
Serials for Picked ItemsThe Serials for Picked Items resource manages the serial that controls the picked item. Use it when a serial controls the item. -
SourceCode: string
Maximum Length:
30Source code for the transaction. -
StartTime: string
(date-time)
Date and time when the user began picking the line in the task.
-
SubinventoryCode: string
Maximum Length:
10Subinventory to use when picking the item. -
ToLicensePlateNumber: string
Maximum Length:
30Name of the container to which the item is transferred. -
ToLPNId: integer
(int64)
Value that uniquely identifies the container to which the item is transferred.
-
TransactionDate: string
(date-time)
Date and time when the transaction occurred.
-
UseAllocatedLotSerialFlag: boolean
Maximum Length:
1Indicates whether allocated lots and serials should be used.
Nested Schema : Flexfields
Type:
arrayTitle:
FlexfieldsThe Flexfields for Pick Lines resource manages the descriptive flexfield that the user uses to set the pick line.
Show Source
Nested Schema : Flexfields for Inventory Attributes
Type:
arrayTitle:
Flexfields for Inventory AttributesThe Flexfields for Inventory Attributes resource manages descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Lots for Picked Items
Type:
arrayTitle:
Lots for Picked ItemsThe Lots for Picked Items resource manages the lot that controls the picked item. Use it when a lot controls the item.
Show Source
Nested Schema : Lots That Share Control
Type:
arrayTitle:
Lots That Share ControlThe Lots That Share Control resource manages the lot that controls the picked item. Use it when lots and serials control the item.
Show Source
Nested Schema : Exceptions
Type:
arrayTitle:
ExceptionsThe Pick Exceptions resource manages exceptions for the pick. Use it to modify the suggested attribute values, such as picked quantity, subinventory, locator, lot, and so on.
Show Source
Nested Schema : Serials for Picked Items
Type:
arrayTitle:
Serials for Picked ItemsThe Serials for Picked Items resource manages the serial that controls the picked item. Use it when a serial controls the item.
Show Source
Nested Schema : pickTransactions-pickLines-dffs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Name of the context for the descriptive flexfield that contains details about the pick line. -
__FLEX_Context_DisplayValue: string
Title:
ContextDisplay value of the context for the descriptive flexfield that contains details about the pick line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Value that uniquely identifies the interface transaction of the descriptive flexfield that contains details about the pick line.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
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 : pickTransactions-pickLines-inventoryAttributesDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:40Descriptive flexfield context name for inventory attributes. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for inventory attributes. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of OriginMaximum Length:2Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of OriginName of the country of origin. This attribute is associated with a feature that requires opt in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
ProjectValue that uniquely identifies the project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
ProjectNumber that identifies the project. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
TaskValue that uniquely identifies the task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
TaskNumber that identifies the task. This attribute is associated with a feature that requires opt in. -
TransactionInterfaceId: integer
(int64)
Value that uniquely identifies the pick line transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pickTransactions-pickLines-lotItemLots-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Lot: string
Maximum Length:
80Value that uniquely identifies the lot that includes the picked item. The lot includes items that you produce together as a group and that share similar production costs and specifications. Applies when the warehouse places the item under lot control. -
Quantity: number
Quantity picked for the lot. Applies when the warehouse places the item under lot control.
-
ReasonId: integer
(int64)
Value that uniquely identifies the reason the lot was used in the transaction.
-
SecondaryQuantity: number
Quantity picked for the lot using the secondary unit of measure. Applies when the warehouse places the item under lot control.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pickTransactions-pickLines-lotSerialItemLots-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Lot: string
Maximum Length:
80Value that uniquely identifies the lot that includes the picked item. The lot includes items that you produce together as a group and that share similar production costs and specifications. Applies when the warehouse places the item under lot and serial control. -
lotSerialItemSerials: array
Serials That Share Control
Title:
Serials That Share ControlThe Serials That Share Control resource manages the serial that controls the picked item. Use it when lots and serials control the item. -
Quantity: number
Quantity picked for the lot. Applies when the warehouse places the item under lot and serial control.
-
ReasonId: integer
(int64)
Value that uniquely identifies the reason the lot was used in the transaction.
-
SecondaryQuantity: number
Quantity picked for the lot using the secondary unit of measure. Applies when the warehouse places the item under lot and serial control.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Serials That Share Control
Type:
arrayTitle:
Serials That Share ControlThe Serials That Share Control resource manages the serial that controls the picked item. Use it when lots and serials control the item.
Show Source
Nested Schema : pickTransactions-pickLines-lotSerialItemLots-lotSerialItemSerials-item-response
Type:
Show Source
object-
FromSerialNumber: string
Maximum Length:
80Number that identifies the starting serial in a range of serial numbers for the lot. Applies when the warehouse places the item under lot and serial control. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
serialAttributeDFFs: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial AttributesFlexible fields that contain details of the serial attributes referenced by the descriptive flexfield and are associated with a line for both lot-controlled and serial-controlled items. -
serialStandardDFFs: array
Flexfields for Serial Numbers
Title:
Flexfields for Serial NumbersFlexible fields that contain details of the serial numbers referenced by the descriptive flexfield and are associated with a line for both lot-controlled and serial-controlled items. -
SupplierSerialNumber: string
Maximum Length:
80Number that uniquely identifies the supplier serial number for the serial numbers of the lot in lot- and serial-controlled items. -
ToSerialNumber: string
Maximum Length:
80Number that identifies the ending serial in a range of serial numbers for the lot. Applies when the warehouse places the item under lot and serial control.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serial Attributes
Type:
arrayTitle:
Flexfields for Serial AttributesFlexible fields that contain details of the serial attributes referenced by the descriptive flexfield and are associated with a line for both lot-controlled and serial-controlled items.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type:
arrayTitle:
Flexfields for Serial NumbersFlexible fields that contain details of the serial numbers referenced by the descriptive flexfield and are associated with a line for both lot-controlled and serial-controlled items.
Show Source
Nested Schema : pickTransactions-pickLines-lotSerialItemLots-lotSerialItemSerials-serialAttributeDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial attributes of serial-controlled items. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value serial attributes of serial-controlled items. -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pickTransactions-pickLines-lotSerialItemLots-lotSerialItemSerials-serialStandardDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serials of serial-controlled items. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serials of serial-controlled items. -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pickTransactions-pickLines-pickExceptions-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Reason: string
Maximum Length:
30Explanation for the pick exception. -
ReasonId: integer
(int64)
Value that uniquely identifies the reason for the pick exception.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pickTransactions-pickLines-serialItemSerials-item-response
Type:
Show Source
object-
FromSerialNumber: string
Maximum Length:
80Number that identifies the starting serial in a range of serial numbers for the lot. Applies when the warehouse places the item under lot and serial control. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
serialAttributeDFFs: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial AttributesFlexible fields that contain details of the serial attributes referenced by the descriptive flexfield and are associated with a line for serial-controlled but not lot-controlled items. -
serialStandardDFFs: array
Flexfields for Serial Numbers
Title:
Flexfields for Serial NumbersFlexible fields that contain details of the serials referenced by the descriptive flexfield and are associated with a line for serial-controlled but not lot-controlled items. -
SupplierSerialNumber: string
Maximum Length:
80Number that uniquely identifies the supplier serial number for the serial numbers of the lot in lot- and serial-controlled items. -
ToSerialNumber: string
Maximum Length:
80Number that identifies the ending serial in a range of serial numbers for the lot. Applies when the warehouse places the item under lot and serial control.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serial Attributes
Type:
arrayTitle:
Flexfields for Serial AttributesFlexible fields that contain details of the serial attributes referenced by the descriptive flexfield and are associated with a line for serial-controlled but not lot-controlled items.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type:
arrayTitle:
Flexfields for Serial NumbersFlexible fields that contain details of the serials referenced by the descriptive flexfield and are associated with a line for serial-controlled but not lot-controlled items.
Show Source
Nested Schema : pickTransactions-pickLines-serialItemSerials-serialAttributeDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial attributes of serial-controlled items. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value serial attributes of serial-controlled items. -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : pickTransactions-pickLines-serialItemSerials-serialStandardDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serials of serial-controlled items. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serials of serial-controlled items. -
FromSerialNumber: string
Maximum Length:
80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source