GET action not supported
get
/fscmRestApi/resources/11.13.18.05/pickTransactions/{TransactionHeaderId}
Request
Path Parameters
-
TransactionHeaderId(required): integer
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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-item-response
Type:
Show Source
object-
ErrorCode: string
Abbreviation that identifies the error that occurred when the pick transaction fails. If the pick transaction doesn't fail, then the ErrorCode attribute is empty.
-
ErrorExplanation: string
Explanation of why the error occurred when the pick transaction fails. If the pick transaction doesn't fail, then the ErrorExplanation attribute is empty.
-
ErrorPickSlipAndLine: string
Value that uniquely identifies the pick slips and pick slip lines in the error.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OverpickAndMoveFlag: boolean
Default Value:
falseContains one of the following values: true or false. If true, then overpick and move the transaction line. If false, then don't overpick and move the transaction line. The default value is false. -
pickLines: array
Pick Lines
Title:
Pick LinesThe Pick Lines resource manages picking details that describe the line to confirm. -
PickSlip: integer
Value that uniquely identifies the pick slip that the transaction references.
-
PickSlipLine: integer
Value that uniquely identifies a line on the pick slip that the transaction references.
-
ReturnStatus: string
Status of the pick transaction. Valid values include SUCCESS or ERROR.
-
RollbackAllLinesOnError: string
Default Value:
YContains one of the following values: Y or N. If Y, then even if one line fails, all the lines are rolled back and no pick is processed. If N, then the successfully processed lines are picked and the lines that failed processing are moved to error state. The default value is Y. -
TransactionHeaderId: integer
Value that uniquely identifies the inventory transaction header.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Pick Lines
Type:
arrayTitle:
Pick LinesThe Pick Lines resource manages picking details that describe the line to confirm.
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-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
dffs
-
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
inventoryAttributesDFF
-
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
Pick Exceptions
Title:
Pick ExceptionsPick exceptions of a pick slip -
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 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. -
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 : 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 : Pick Exceptions
Type:
arrayTitle:
Pick ExceptionsPick exceptions of a pick slip
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-dffs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:30Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
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-inventoryAttributesDFF-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 -
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 -
TransactionInterfaceId: integer
(int64)
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
serialAttributeDFFs
-
serialStandardDFFs: array
serialStandardDFFs
-
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 : pickTransactions-pickLines-lotSerialItemLots-lotSerialItemSerials-serialAttributeDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
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:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
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:
30Reason of a pick line exception. -
ReasonId: integer
(int64)
Unique reason identifier of a pick line 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
serialAttributeDFFs
-
serialStandardDFFs: array
serialStandardDFFs
-
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 : pickTransactions-pickLines-serialItemSerials-serialAttributeDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
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:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
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
Links
- pickLines
-
Operation: /fscmRestApi/resources/11.13.18.05/pickTransactions/{TransactionHeaderId}/child/pickLinesParameters:
- TransactionHeaderId:
$request.path.TransactionHeaderId
The Pick Lines resource manages picking details that describe the line to confirm. - TransactionHeaderId: