Create pick transactions

post

/fscmRestApi/resources/11.13.18.05/pickTransactions

Request

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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • 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.
  • Explanation of why the error occurred when the pick transaction fails. If the pick transaction does not fail, then the ErrorExplanation attribute is empty.
  • Value that uniquely identifies the pick slips and pick slip lines in the error.
  • 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.
  • Pick Lines
    Title: Pick Lines
    The Pick Lines resource manages picking details that describe the line to confirm.
  • Value that uniquely identifies the pick slip that the transaction references.
  • Value that uniquely identifies a line on the pick slip that the transaction references.
  • Status of the pick transaction. Valid values include SUCCESS or ERROR.
  • 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.
  • Value that uniquely identifies the inventory transaction header.
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 : pickTransactions-pickLines-item-post-request
Type: object
Show Source
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 : 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 : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 40
    Descriptive flexfield context name for inventory attributes. This attribute is associated with a feature that requires opt in.
  • Title: Context Segment
    Descriptive flexfield context display value for inventory attributes. This attribute is associated with a feature that requires opt in.
  • 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.
  • Title: Country of Origin
    Name of the country of origin. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Number that identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Number that identifies the task. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the pick line transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : pickTransactions-pickLines-lotItemLots-item-post-request
Type: object
Show Source
  • 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 picked for the lot. Applies when the warehouse places the item under lot control.
  • Quantity picked for the lot using the secondary unit of measure. Applies when the warehouse places the item under lot control.
Nested Schema : pickTransactions-pickLines-lotSerialItemLots-item-post-request
Type: object
Show Source
  • 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.
  • 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 picked for the lot. Applies when the warehouse places the item under lot and serial control.
  • 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 : 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-post-request
Type: object
Show Source
  • 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.
  • 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 : schema
Type: object
Show Source
Nested Schema : pickTransactions-pickLines-serialItemSerials-item-post-request
Type: object
Show Source
  • 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.
  • 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.
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 : pickTransactions-item-response
Type: object
Show Source
  • 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.
  • Explanation of why the error occurred when the pick transaction fails. If the pick transaction does not fail, then the ErrorExplanation attribute is empty.
  • Value that uniquely identifies the pick slips and pick slip lines in the error.
  • Links
  • 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.
  • Pick Lines
    Title: Pick Lines
    The Pick Lines resource manages picking details that describe the line to confirm.
  • Value that uniquely identifies the pick slip that the transaction references.
  • Value that uniquely identifies a line on the pick slip that the transaction references.
  • Status of the pick transaction. Valid values include SUCCESS or ERROR.
  • 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.
  • Value that uniquely identifies the inventory transaction header.
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 : pickTransactions-pickLines-item-response
Type: object
Show Source
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 : 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: object
Show Source
Nested Schema : pickTransactions-pickLines-inventoryAttributesDFF-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 40
    Descriptive flexfield context name for inventory attributes. This attribute is associated with a feature that requires opt in.
  • Title: Context Segment
    Descriptive flexfield context display value for inventory attributes. This attribute is associated with a feature that requires opt in.
  • 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.
  • Title: Country of Origin
    Name of the country of origin. This attribute is associated with a feature that requires opt in.
  • Links
  • Title: Project
    Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Number that identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Number that identifies the task. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the pick line transaction. This attribute is associated with a feature that requires opt in.
Nested Schema : pickTransactions-pickLines-lotItemLots-item-response
Type: object
Show Source
  • Links
  • 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 picked for the lot. Applies when the warehouse places the item under lot control.
  • Quantity picked for the lot using the secondary unit of measure. Applies when the warehouse places the item under lot control.
Nested Schema : pickTransactions-pickLines-lotSerialItemLots-item-response
Type: object
Show Source
  • Links
  • 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.
  • 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 picked for the lot. Applies when the warehouse places the item under lot and serial control.
  • 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 : 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: object
Show Source
  • 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
  • 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 : pickTransactions-pickLines-pickExceptions-item-response
Type: object
Show Source
Nested Schema : pickTransactions-pickLines-serialItemSerials-item-response
Type: object
Show Source
  • 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
  • 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.
Back to Top

Examples

This example describes how to pick all transactions.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example picks all transactions for pick slip 1129158, on pick slip line 1, for picked quantity of 1, in subinventory FGI:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/pickTransactions"

Example 1 Request Body

The following example includes the contents of the request body in JSON format for all the lines submitted to be processed together. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{   
	"OverpickAndMoveFlag": "false",
	"pickLines" : [
	{
		"PickSlip" : 1282186,
		"PickSlipLine" : 1,
		"PickedQuantity" : 5,
		"SubinventoryCode" : "INVSUB"
	}
	] 
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
	"TransactionHeaderId": 22758367,
	"ReturnStatus": "Success",
	"ErrorCode": null,
	"ErrorExplanation": null,
	"PickSlip": null,
	"PickSlipLine": null,
	"OverpickAndMoveFlag": "false",
	"pickLines": [
	{
		"Locator": null,
		"PickSlipLine": 1,
		"PickSlip": 1282186,
		"PickedQuantity": 5,
		"SecondaryPickedQuantity": null,
		"SubinventoryCode": "INVSUB",
		"TransactionDate": null,
		"LicensePlateNumber": null,
		"DestinationLocator": null,
		"DestinationSubinventoryCode": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22758367/child/pickLines/22758368",
			"name": "pickLines",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22758367/child/pickLines/22758368",
			"name": "pickLines",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22758367",
			"name": "pickTransactions",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22758367/child/pickLines/22758368/child/dffs",
			"name": "dffs",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22758367/child/pickLines/22758368/child/inventoryAttributesDFF",
			"name": "inventoryAttributesDFF",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22758367/child/pickLines/22758368/child/lotItemLots",
			"name": "lotItemLots",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22758367/child/pickLines/22758368/child/lotSerialItemLots",
			"name": "lotSerialItemLots",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22758367/child/pickLines/22758368/child/pickExceptions",
			"name": "pickExceptions",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22758367/child/pickLines/22758368/child/serialItemSerials",
			"name": "serialItemSerials",
			"kind": "collection"
		}
		]
	}
	],
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22758367",
		"name": "pickTransactions",
		"kind": "item"
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22758367",
		"name": "pickTransactions",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22758367/child/pickLines",
		"name": "pickLines",
		"kind": "collection"
	}
	]
}

Example 2 Request Body

The following example includes the contents of the request body in JSON format to pick confirm each line at a time. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{   "RollbackAllLinesOnError" : "N",
	"OverpickAndMoveFlag": "false",
	"pickLines" : [
	{
		"PickSlip" : 1281169,
		"PickSlipLine" : 1,
		"PickedQuantity" : 5,
		"SubinventoryCode" : "SPSUB01",
		"Locator" : "S1.1.1.1"
	}
	]
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
	"TransactionHeaderId": 22677963,
	"ReturnStatus": "Success",
	"ErrorCode": null,
	"ErrorExplanation": null,
	"PickSlip": null,
	"PickSlipLine": null,
	"OverpickAndMoveFlag": "false",
	"ErrorPickSlipAndLine": null,
	"RollbackAllLinesOnError": "N",
	"pickLines": [
	{
		"Locator": "1.1.1.1",
		"PickSlipLine": 1,
		"PickSlip": 1281168,
		"PickedQuantity": 5,
		"SecondaryPickedQuantity": null,
		"SubinventoryCode": "SPSUB01",
		"TransactionDate": null,
		"LicensePlateNumber": null,
		"DestinationLocator": null,
		"DestinationSubinventoryCode": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22677963/child/pickLines/22677964",
			"name": "pickLines",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22677963/child/pickLines/22677964",
			"name": "pickLines",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22677963",
			"name": "pickTransactions",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22677963/child/pickLines/22677964/child/dffs",
			"name": "dffs",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22677963/child/pickLines/22677964/child/inventoryAttributesDFF",
			"name": "inventoryAttributesDFF",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22677963/child/pickLines/22677964/child/lotItemLots",
			"name": "lotItemLots",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22677963/child/pickLines/22677964/child/lotSerialItemLots",
			"name": "lotSerialItemLots",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22677963/child/pickLines/22677964/child/pickExceptions",
			"name": "pickExceptions",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22677963/child/pickLines/22677964/child/serialItemSerials",
			"name": "serialItemSerials",
			"kind": "collection"
		}
		]
	}
	],
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22677963",
		"name": "pickTransactions",
		"kind": "item"
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22677963",
		"name": "pickTransactions",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/pickTransactions/22677963/child/pickLines",
		"name": "pickLines",
		"kind": "collection"
	}
	]
}
Back to Top