Get one lot
get
/fscmRestApi/resources/11.13.18.05/openPickLines/{TransactionId}/child/itemLots/{itemLotsUniqID}
Request
Path Parameters
-
TransactionId(required): integer(int64)
Value that uniquely identifies the transaction.
-
itemLotsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Lot Details resource and used to uniquely identify an instance of Lot Details. The client should not generate the hash key value. Instead, the client should query on the Lot Details collection resource in order to navigate to a specific instance of Lot Details to get the hash key.
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:
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:
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 : openPickLines-itemLots-item-response
Type:
Show Source
object
-
itemLotSerials: array
Serial Details for Lots
Title:
Serial Details for Lots
The Serial Details for Lots resource manages details about the serial when the lot controls the picked item. Use this resource when the lot controls the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Lot: string
Read Only:
true
Maximum Length:80
Value that uniquely identifies the lot. 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. -
lotAttributeDFFs: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages descriptive flexfields for the lot attribute. -
LotExpirationDate: string
(date)
Read Only:
true
Date controlling the availability of the lot for transaction and planning purposes. -
LotMaturityDate: string
(date-time)
Read Only:
true
Date when the lot reaches full maturity. -
LotOriginationDate: string
(date-time)
Read Only:
true
Date that is the lot creation date. -
lotStandardDFFs: array
Flexfields for Lots
Title:
Flexfields for Lots
The Flexfields for Lots resource manages descriptive flexfields for the lot. -
Quantity: number
Read Only:
true
Quantity picked for the lot number. -
SecondaryQuantity: number
Read Only:
true
Quantity picked for the lot number using the secondary unit of measure.
Nested Schema : Serial Details for Lots
Type:
array
Title:
Serial Details for Lots
The Serial Details for Lots resource manages details about the serial when the lot controls the picked item. Use this resource when the lot controls the item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Lot Attributes
Type:
array
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages descriptive flexfields for the lot attribute.
Show Source
Nested Schema : Flexfields for Lots
Type:
array
Title:
Flexfields for Lots
The Flexfields for Lots resource manages descriptive flexfields for the lot.
Show Source
Nested Schema : openPickLines-itemLots-itemLotSerials-item-response
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Starting serial number in a range of serial numbers. Applies when the warehouse places the item under lot and serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lotSerialAttributeDFFs: array
Flexfields for Serials That Control Items and Lots
Title:
Flexfields for Serials That Control Items and Lots
The Flexfields for Serials That Control Items and Lots resource manages descriptive flexfields for serial attributes. Use it when a serial controls the item or the lot. -
lotSerialStandardDFFs: array
Flexfields for Serials That Control Lots
Title:
Flexfields for Serials That Control Lots
The Flexfields for Serials That Control Lots resource manages descriptive flexfields for serials. Use it when a serial controls the lot. -
ToSerialNumber: string
Maximum Length:
80
Ending serial number in a range of serial numbers. 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 : Flexfields for Serials That Control Items and Lots
Type:
array
Title:
Flexfields for Serials That Control Items and Lots
The Flexfields for Serials That Control Items and Lots resource manages descriptive flexfields for serial attributes. Use it when a serial controls the item or the lot.
Show Source
Nested Schema : Flexfields for Serials That Control Lots
Type:
array
Title:
Flexfields for Serials That Control Lots
The Flexfields for Serials That Control Lots resource manages descriptive flexfields for serials. Use it when a serial controls the lot.
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 : openPickLines-itemLots-itemLotSerials-lotSerialAttributeDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lot and serial attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for lot and serial attributes. -
FmSerialNumber: string
Maximum Length:
80
Starting serial number in a range of serial numbers. This attribute is used when the warehouse places the item under lot and serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionTempId: integer
(int64)
Value that uniquely identifies the transaction for the lot and serial attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : openPickLines-itemLots-itemLotSerials-lotSerialStandardDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lot and serial attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for lot and serial attributes. -
FmSerialNumber: string
Maximum Length:
80
Starting serial number in a range of serial numbers. This attribute is used when the warehouse places the item under lot and serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionTempId: integer
(int64)
Value that uniquely identifies the transaction for the lot and serial attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : openPickLines-itemLots-lotAttributeDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lots. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for lots. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80
Value that uniquely identifies the lot. The lot includes items that you produce together as a group and that share similar production costs and specifications. -
TransactionTempId: integer
(int64)
Value that uniquely identifies the transaction for the pick line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : openPickLines-itemLots-lotStandardDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Value that uniquely identifies the lot for the transaction. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Value that uniquely identifies the lot. 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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80
Value that uniquely identifies the lot. 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. -
TransactionTempId: integer
(int64)
Value that uniquely identifies the lot for the transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- itemLotSerials
-
Parameters:
- TransactionId:
$request.path.TransactionId
- itemLotsUniqID:
$request.path.itemLotsUniqID
The Serial Details for Lots resource manages details about the serial when the lot controls the picked item. Use this resource when the lot controls the item. - TransactionId:
- lotAttributeDFFs
-
Parameters:
- TransactionId:
$request.path.TransactionId
- itemLotsUniqID:
$request.path.itemLotsUniqID
The Flexfields for Lot Attributes resource manages descriptive flexfields for the lot attribute. - TransactionId:
- lotStandardDFFs
-
Parameters:
- TransactionId:
$request.path.TransactionId
- itemLotsUniqID:
$request.path.itemLotsUniqID
The Flexfields for Lots resource manages descriptive flexfields for the lot. - TransactionId:
Examples
This example describes how to get the details of one lot for a picked item.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "server:port/fscmRestApi/resources/version/openPickLines/TransactionId/child/itemLots/Lot"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots?q=Lot=S135020"
Example Response Body
The following shows an example of the response body in JSON
format.
"{ "items": [ { "Lot": "S135020", "Quantity": 5, "SecondaryQuantity": null, "links": [ { "rel": "self", "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303230", "name": "itemLots", "kind": "item" }, { "rel": "canonical", "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303230", "name": "itemLots", "kind": "item" }, { "rel": "parent", "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186", "name": "openPickLines", "kind": "item" }, { "rel": "child", "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303230/child/itemLotSerials", "name": "itemLotSerials", "kind": "collection" }, { "rel": "child", "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303230/child/lotAttributeDFFs", "name": "lotAttributeDFFs", "kind": "collection" }, { "rel": "child", "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots/00020000000EACED0005770800000000015D75AA0000000753313335303230/child/lotStandardDFFs", "name": "lotStandardDFFs", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "http://servername/fscmRestApi/resources/version/openPickLines/22902186/child/itemLots", "name": "itemLots", "kind": "collection" } ] }"