Get one lot number
get
/fscmRestApi/resources/11.13.18.05/inventoryStagedTransactions/{TransactionInterfaceId}/child/lots/{lotsUniqID}
Request
Path Parameters
-
TransactionInterfaceId(required): integer(int64)
Value that uniquely identifies the transaction.
-
lotsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- TransactionInterfaceId and LotNumber ---for the Lots resource and used to uniquely identify an instance of Lots. The client should not generate the hash key value. Instead, the client should query on the Lots collection resource with a filter on the primary key values in order to navigate to a specific instance of Lots.
For example: lots?q=TransactionInterfaceId=<value1>;LotNumber=<value2>
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 : inventoryStagedTransactions-lots-item-response
Type:
Show Source
object-
ErrorCode: string
Maximum Length:
240Abbreviation that identifies the error. -
ExpirationActionCode: string
Maximum Length:
32Abbreviation that identifies the expiration action. -
ExpirationActionDate: string
(date)
Date when the expiration action was performed.
-
ExpirationActionName: string
Maximum Length:
80Name of the expiration action. -
GradeCode: string
Maximum Length:
150Abbreviation that identifies the grade. -
HoldDate: string
(date)
Date when the warehouse applied a hold on the lot.
-
LengthUOMName: string
Maximum Length:
25Unit of measure for the lot length. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
lotAttributeDFFs: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot AttributesA flexible data field that includes details about lot attributes. Use this resource only when the item is lot-controlled. -
LotExpirationDate: string
(date)
Date and time when the lot expires.
-
LotLength: number
Length of the lot.
-
LotNumber: string
Maximum Length:
80Lot number for the item. -
lotSerials: array
Lot Serials
Title:
Lot SerialsLot and serial details for inventory transactions when the item is lot-controlled and serial-controlled. The details include lot number and serial number. -
LotSerialSummaries: array
Lot Serials Summaries
Title:
Lot Serials SummariesThe item quantities for organization, subinventory, subinventory and locator, project, and project and task, and the inbound quantities for an organization for items that are enabled both for lot and serial control. -
lotStandardDFFs: array
Flexfields for Lots
Title:
Flexfields for LotsA flexible data field that includes details about lots. Use this resource only when the item is lot-controlled -
LotThickness: number
Thickness of the lot.
-
LotVolume: number
Volume of the lot.
-
LotWidth: number
Width of the lot.
-
MaturityDate: string
(date)
Date when the lot matures.
-
OriginationDate: string
(date-time)
Date when the warehouse created the lot.
-
OriginationType: string
Maximum Length:
30Type of origination for the lot. -
PrimaryQuantity: number
Transaction quantity in the primary unit of measure that the item uses.
-
ProductCode: string
Maximum Length:
5Abbreviation that identifies the product. -
ProductTransactionId: integer
(int64)
Value that uniquely identifies the product transaction.
-
ReasonCode: string
Maximum Length:
4Abbreviation that identifies the inventory transaction reason. -
ReasonId: integer
(int64)
Value that uniquely identifies the reason.
-
ReasonName: string
Maximum Length:
30Name of the inventory transaction reason. -
RetestDate: string
(date)
Date when the lot is retested.
-
SecondaryTransactionQuantity: number
Transaction quantity of an item in its secondary unit of measure.
-
SerialTransactionTempId: integer
(int64)
Value that uniquely identifies the serial transaction.
-
SourceCode: string
Maximum Length:
30Abbreviation that identifies the source. -
SourceLineId: integer
(int64)
Value that uniquely identifies the source line.
-
StatusCode: string
Maximum Length:
80Abbreviation that identifies the status. -
StatusId: integer
(int64)
Value that uniquely identifies the status.
-
SupplierLotNumber: string
Maximum Length:
150Number that identifies the supplier lot. -
TerritoryShortName: string
Maximum Length:
80Short name of the territory. -
TransactionInterfaceId: integer
(int64)
Value that uniquely identifies the transaction.
-
TransactionQuantity: number
Transaction quantity of the item.
-
VendorName: string
Maximum Length:
240Name of the vendor for the lot. -
VolumeUOMName: string
Maximum Length:
25Unit of measure for the lot volume. -
WidthUOMName: string
Maximum Length:
25Unit of measure for the lot width.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Lot Attributes
Type:
arrayTitle:
Flexfields for Lot AttributesA flexible data field that includes details about lot attributes. Use this resource only when the item is lot-controlled.
Show Source
Nested Schema : Lot Serials
Type:
arrayTitle:
Lot SerialsLot and serial details for inventory transactions when the item is lot-controlled and serial-controlled. The details include lot number and serial number.
Show Source
Nested Schema : Lot Serials Summaries
Type:
arrayTitle:
Lot Serials SummariesThe item quantities for organization, subinventory, subinventory and locator, project, and project and task, and the inbound quantities for an organization for items that are enabled both for lot and serial control.
Show Source
Nested Schema : Flexfields for Lots
Type:
arrayTitle:
Flexfields for LotsA flexible data field that includes details about lots. Use this resource only when the item is lot-controlled
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 : inventoryStagedTransactions-lots-lotAttributeDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for lot attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for lot attributes. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotSerials-item-response
Type:
Show Source
object-
ErrorCode: string
Maximum Length:
240Abbreviation that identifies the error. -
FmSerialNumber: string
Maximum Length:
80Starting serial number in a range of serial numbers. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OriginationDate: string
(date)
Date when this lot serial originated.
-
serialAttributeDFFs: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial AttributesA flexible data field that includes details about serial attributes. Use this resource only when the item is serial-controlled. -
SerialQuantity: number
Read Only:
trueValue that indicates the serial quantity for an interfaced record. -
serialStandardDFFs: array
Flexfields for Serials
Title:
Flexfields for SerialsA flexible data field that includes details about serials. Use this resource only when the item is serial-controlled. -
SourceCode: string
Maximum Length:
30Abbreviation that identifies the source. -
SourceLineId: integer
(int64)
Value that uniquely identifies the source line.
-
StatusCode: string
Maximum Length:
80Abbreviation that identifies the status. -
StatusId: integer
(int64)
Value that uniquely identifies the status.
-
StatusName: string
Maximum Length:
30Description of the status. -
ToSerialNumber: string
Maximum Length:
80Ending serial number in a range of serial numbers. -
TransactionInterfaceId: integer
(int64)
Value that uniquely identifies the transaction.
-
VendorSerialNumber: string
Maximum Length:
80Vendor serial number corresponding to a serial number for an item.
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 AttributesA flexible data field that includes details about serial attributes. Use this resource only when the item is serial-controlled.
Show Source
Nested Schema : Flexfields for Serials
Type:
arrayTitle:
Flexfields for SerialsA flexible data field that includes details about serials. Use this resource only when the item is serial-controlled.
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotSerials-serialAttributeDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serial attributes. -
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 : inventoryStagedTransactions-lots-lotSerials-serialStandardDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for serial standards. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for serial standards. -
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 : inventoryStagedTransactions-lots-LotSerialSummaries-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Serialscount: number
Read Only:
trueCount of serial controlled item entries for the transaction. -
Serialsquantitysum: number
Read Only:
trueTotal quantity of serial controlled items for the transaction.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotStandardDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for lot standards. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDescriptive flexfield context display value for lot standards. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80 -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- LotSerialSummaries
-
Parameters:
- TransactionInterfaceId:
$request.path.TransactionInterfaceId - lotsUniqID:
$request.path.lotsUniqID
The item quantities for organization, subinventory, subinventory and locator, project, and project and task, and the inbound quantities for an organization for items that are enabled both for lot and serial control. - TransactionInterfaceId:
- lotAttributeDFFs
-
Parameters:
- TransactionInterfaceId:
$request.path.TransactionInterfaceId - lotsUniqID:
$request.path.lotsUniqID
A flexible data field that includes details about lot attributes. Use this resource only when the item is lot-controlled. - TransactionInterfaceId:
- lotSerials
-
Parameters:
- TransactionInterfaceId:
$request.path.TransactionInterfaceId - lotsUniqID:
$request.path.lotsUniqID
Lot and serial details for inventory transactions when the item is lot-controlled and serial-controlled. The details include lot number and serial number. - TransactionInterfaceId:
- lotStandardDFFs
-
Parameters:
- TransactionInterfaceId:
$request.path.TransactionInterfaceId - lotsUniqID:
$request.path.lotsUniqID
A flexible data field that includes details about lots. Use this resource only when the item is lot-controlled - TransactionInterfaceId:
Examples
This example describes how to get one lot number.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryStagedTransactions/TransactionInterfaceId/child/lots/lotsUniqID"
For example, the following command gets one lot number:
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryStagedTransactions/300100152718324/child/lots?q=TransactionInterfaceId=300100152718324;LotNumber=VC105-02"
Example Response Body
The following shows an example of the response body in JSON format.
{
"TransactionInterfaceId": 300100152718324,
"LotNumber": "VC105-02",
"TransactionQuantity": 5,
"PrimaryQuantity": null,
....
}