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:
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 : inventoryStagedTransactions-lots-item-response
Type:
Show Source
object
-
ErrorCode: string
Maximum Length:
240
Abbreviation that identifies the error. -
ExpirationActionCode: string
Maximum Length:
32
Abbreviation that identifies the expiration action. -
ExpirationActionDate: string
(date)
Date when the expiration action was performed.
-
ExpirationActionName: string
Maximum Length:
80
Name of the expiration action. -
GradeCode: string
Maximum Length:
150
Abbreviation that identifies the grade. -
HoldDate: string
(date)
Date when the warehouse applied a hold on the lot.
-
LengthUOMName: string
Maximum Length:
25
Unit of measure for the lot length. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lotAttributeDFFs: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the lot attributes descriptive flexfields for a lot controlled item. -
LotExpirationDate: string
(date)
Date and time when the lot expires.
-
LotLength: number
Length of the lot.
-
LotNumber: string
Maximum Length:
80
Lot number for the item. -
lotSerials: array
Lot Serials
Title:
Lot Serials
The Lot Serials resource manages the serials for a lot of a staged inventory transaction when an item is both lot and serial controlled. -
lotStandardDFFs: array
Flexfields for Lots
Title:
Flexfields for Lots
The Flexfields for Lots resource manages the lot descriptive flexfields for a lot controlled item. -
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)
Date when the warehouse created the lot.
-
OriginationType: string
Maximum Length:
30
Type of origination for the lot. -
PrimaryQuantity: number
Transaction quantity in the primary unit of measure that the item uses.
-
ProductCode: string
Maximum Length:
5
Abbreviation that identifies the product. -
ProductTransactionId: integer
(int64)
Value that uniquely identifies the product transaction.
-
ReasonCode: string
Maximum Length:
4
Abbreviation that identifies the inventory transaction reason. -
ReasonId: integer
(int64)
Value that uniquely identifies the reason.
-
ReasonName: string
Maximum Length:
30
Name of the inventory transaction reason. -
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:
30
Abbreviation that identifies the source. -
SourceLineId: integer
(int64)
Value that uniquely identifies the source line.
-
StatusCode: string
Maximum Length:
80
Abbreviation that identifies the status. -
StatusId: integer
(int64)
Value that uniquely identifies the status.
-
SupplierLotNumber: string
Maximum Length:
150
Number that identifies the supplier lot. -
TerritoryShortName: string
Maximum Length:
80
Short name of the territory. -
TransactionInterfaceId: integer
(int64)
Value that uniquely identifies the transaction.
-
TransactionQuantity: number
Transaction quantity of the item.
-
VendorName: string
Maximum Length:
240
Name of the vendor for the lot. -
VolumeUOMName: string
Maximum Length:
25
Unit of measure for the lot volume. -
WidthUOMName: string
Maximum Length:
25
Unit of measure for the lot width.
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 the lot attributes descriptive flexfields for a lot controlled item.
Show Source
Nested Schema : Lot Serials
Type:
array
Title:
Lot Serials
The Lot Serials resource manages the serials for a lot of a staged inventory transaction when an item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Lots
Type:
array
Title:
Flexfields for Lots
The Flexfields for Lots resource manages the lot descriptive flexfields for a lot controlled item.
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 : inventoryStagedTransactions-lots-lotAttributeDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lot attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for lot attributes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotSerials-item-response
Type:
Show Source
object
-
ErrorCode: string
Maximum Length:
240
Abbreviation that identifies the error. -
FmSerialNumber: string
Maximum Length:
80
Starting serial number in a range of serial numbers. -
links: array
Links
Title:
Links
The 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 Attributes
The Flexfields for Serial Attributes resource manages the serial attributes descriptive flexfields for a serial controlled item. -
serialStandardDFFs: array
Flexfields for Serials
Title:
Flexfields for Serials
The Flexfields for Serials resource manages the serial descriptive flexfields for a serial controlled item. -
SourceCode: string
Maximum Length:
30
Abbreviation that identifies the source. -
SourceLineId: integer
(int64)
Value that uniquely identifies the source line.
-
StatusCode: string
Maximum Length:
80
Abbreviation that identifies the status. -
StatusId: integer
(int64)
Value that uniquely identifies the status.
-
StatusName: string
Maximum Length:
30
Description of the status. -
ToSerialNumber: string
Maximum Length:
80
Ending serial number in a range of serial numbers. -
TransactionInterfaceId: integer
(int64)
Value that uniquely identifies the transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Serial Attributes
Type:
array
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the serial attributes descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : Flexfields for Serials
Type:
array
Title:
Flexfields for Serials
The Flexfields for Serials resource manages the serial descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotSerials-serialAttributeDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serial attributes. -
FromSerialNumber: string
Maximum Length:
80
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The 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 Value
Maximum Length:30
Descriptive flexfield context name for serial standards. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serial standards. -
FromSerialNumber: string
Maximum Length:
80
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The 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 Value
Maximum Length:30
Descriptive flexfield context name for lot standards. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for lot standards. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Maximum Length:
80
-
TransactionInterfaceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- lotAttributeDFFs
-
Parameters:
- TransactionInterfaceId:
$request.path.TransactionInterfaceId
- lotsUniqID:
$request.path.lotsUniqID
The Flexfields for Lot Attributes resource manages the lot attributes descriptive flexfields for a lot controlled item. - TransactionInterfaceId:
- lotSerials
-
Parameters:
- TransactionInterfaceId:
$request.path.TransactionInterfaceId
- lotsUniqID:
$request.path.lotsUniqID
The Lot Serials resource manages the serials for a lot of a staged inventory transaction when an item is both lot and serial controlled. - TransactionInterfaceId:
- lotStandardDFFs
-
Parameters:
- TransactionInterfaceId:
$request.path.TransactionInterfaceId
- lotsUniqID:
$request.path.lotsUniqID
The Flexfields for Lots resource manages the lot descriptive flexfields for a lot controlled item. - 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, .... }