GET action not supported
get
/fscmRestApi/resources/11.13.18.05/pickTransactions
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: Find pick transactions according to TransactionHeaderId.
Finder Variables:- TransactionHeaderId; integer; Value that uniquely identifies the inventory transaction header.
- PrimaryKey: Find pick transactions according to TransactionHeaderId.
-
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 -
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(required):
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(required):
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
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 : 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 does not fail, then the ErrorCode attribute is empty.
-
ErrorExplanation: string
Explanation of why the error occurred when the pick transaction fails. If the pick transaction does not 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:
Links
The link relations associated with the resource instance. -
OverpickAndMoveFlag: boolean
Default Value:
false
Contains one of the following values: true or false. If true, then overpick and move the transaction line. If false, then do not overpick and move the transaction line. The default value is false. -
pickLines: array
Pick Lines
Title:
Pick Lines
The 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:
Y
Contains 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pick Lines
Type:
array
Title:
Pick Lines
The 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 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 : pickTransactions-pickLines-item-response
Type:
Show Source
object
-
DestinationLocator: string
Maximum Length:
1000
Destination locator to use when performing overpick and move. -
DestinationSubinventoryCode: string
Maximum Length:
10
Abbreviation that identifies the destination subinventory to use when performing overpick and move. -
dffs: array
Flexfields
Title:
Flexfields
The Flexfields for Pick Lines resource manages the descriptive flexfield that the user uses to set the pick line. -
inventoryAttributesDFF: array
Flexfields for Inventory Attributes
Title:
Flexfields for Inventory Attributes
The 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:
30
Value that uniquely identifies the container where the pick placed the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Maximum Length:
1000
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. -
lotItemLots: array
Lots for Picked Items
Title:
Lots for Picked Items
The 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 Control
The 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:
Exceptions
The 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.
-
SecondaryPickedQuantity: number
Quantity picked for the pick line in the secondary unit of measure.
-
serialItemSerials: array
Serials for Picked Items
Title:
Serials for Picked Items
The Serials for Picked Items resource manages the serial that controls the picked item. Use it when a serial controls the item. -
SubinventoryCode: string
Maximum Length:
10
Subinventory to use when picking the item. -
TransactionDate: string
(date-time)
Date and time when the transaction occurred.
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The 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:
array
Title:
Flexfields for Inventory Attributes
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Lots for Picked Items
Type:
array
Title:
Lots for Picked Items
The 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:
array
Title:
Lots That Share Control
The 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:
array
Title:
Exceptions
The 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:
array
Title:
Serials for Picked Items
The 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:
Context
Maximum Length:30
Name of the context for the descriptive flexfield that contains details about the pick line. -
__FLEX_Context_DisplayValue: string
Title:
Context
Display value of the context for the descriptive flexfield that contains details about the pick line. -
links: array
Links
Title:
Links
The 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:
array
Title:
Links
The 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 Segment
Maximum Length:40
Descriptive flexfield context name for inventory attributes. This attribute is associated with a feature that requires opt in. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for inventory attributes. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country of origin. This attribute is associated with a feature that requires opt in. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in. -
projectId_Display: string
Title:
Project
Number that identifies the project. This attribute is associated with a feature that requires opt in. -
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in. -
taskId_Display: string
Title:
Task
Number 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : pickTransactions-pickLines-lotItemLots-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Lot: string
Maximum Length:
80
Value 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.
-
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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : pickTransactions-pickLines-lotSerialItemLots-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Lot: string
Maximum Length:
80
Value 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 Control
The 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.
-
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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Serials That Share Control
Type:
array
Title:
Serials That Share Control
The 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:
80
Number that identifies the starting serial in a range of serial numbers for the item. Applies when the warehouse places the item under serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ToSerialNumber: string
Maximum Length:
80
Number that identifies the ending serial in a range of serial numbers for the item. Applies when the warehouse places the item under serial control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : pickTransactions-pickLines-pickExceptions-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Reason: string
Maximum Length:
30
Explanation for the pick exception. -
ReasonId: integer
(int64)
Value that uniquely identifies the reason for the pick exception.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : pickTransactions-pickLines-serialItemSerials-item-response
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Number that identifies the starting serial in a range of serial numbers for the item. Applies when the warehouse places the item under serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ToSerialNumber: string
Maximum Length:
80
Number that identifies the ending serial in a range of serial numbers for the item. Applies when the warehouse places the item under serial control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source