Get one lot for a receipt
get
/fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/{HeaderInterfaceId}/child/lines/{InterfaceTransactionId}/child/lotSerialItemLots/{lotSerialItemLotsUniqID}
Request
Path Parameters
-
HeaderInterfaceId(required): integer(int64)
Value that uniquely identifies the receipt request header.
-
InterfaceTransactionId(required): integer(int64)
Value that uniquely identifies the interfaced receipt line request.
-
lotSerialItemLotsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Lots for Lot and Serial Items resource and used to uniquely identify an instance of Lots for Lot and Serial Items. The client should not generate the hash key value. Instead, the client should query on the Lots for Lot and Serial Items collection resource in order to navigate to a specific instance of Lots for Lot and Serial Items 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(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 : receivingReceiptRequests-lines-lotSerialItemLots-item-response
Type:
Show Source
object
-
GradeCode: string
Maximum Length:
150
Abbreviation that identifies the grade. -
HoldDate: string
(date)
Date when the warehouse applied a hold on the lot corresponding to the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lotAttributesDFF: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the details of the lot attributes that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled. -
LotExpirationDate: string
(date)
Date when the item of this lot corresponding to the advanced shipment notice (ASN) line request or receipt line request expires. This attribute is applicable when the warehouse places the item under lot and serial control.
-
LotNumber: string
Maximum Length:
80
Number that identifies the lot for the item corresponding to the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control. -
lotNumbersDFF: array
Flexfields for Lot Numbers
Title:
Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages the details of the lot numbers that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled. -
lotSerialItemSerials: array
Serials for Lot and Serial Items
Title:
Serials for Lot and Serial Items
The Serials for Lot and Serial Items resource manages the serial number information associated with a specific lot for a line whose item is both lot and serial controlled. -
MaturityDate: string
(date)
Date when the lot matures for the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control.
-
OriginationDate: string
(date)
Date when this lot originated for the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control.
-
OriginationType: string
Maximum Length:
30
Type of origination for the lot corresponding to the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control. -
ParentLotNumber: string
Maximum Length:
80
Number that identifies the parent lot of the lot corresponding to the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control. -
PrimaryQuantity: number
Transaction quantity for this lot in the primary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot and serial control.
-
ReasonId: integer
(int64)
Value that uniquely identifies the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot and serial control.
-
ReasonName: string
Maximum Length:
30
Name of the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot and serial control. -
SecondaryTransactionQuantity: number
Transaction quantity for this lot in the secondary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot and serial control.
-
TransactionQuantity: number
Transaction quantity of the lot corresponding to the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control.
-
VendorLotNumber: string
Maximum Length:
150
Number that identifies the supplier lot for the lot corresponding to the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable 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 Lot Attributes
Type:
array
Title:
Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the details of the lot attributes that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Lot Numbers
Type:
array
Title:
Flexfields for Lot Numbers
The Flexfields for Lot Numbers resource manages the details of the lot numbers that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled.
Show Source
Nested Schema : Serials for Lot and Serial Items
Type:
array
Title:
Serials for Lot and Serial Items
The Serials for Lot and Serial Items resource manages the serial number information associated with a specific lot for a line whose item is both lot and serial controlled.
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 : receivingReceiptRequests-lines-lotSerialItemLots-lotAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lot attributes. This attribute is applicable when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for lot attributes. This attribute is applicable when the warehouse places the item under lot and serial control. -
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 : receivingReceiptRequests-lines-lotSerialItemLots-lotNumbersDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for lots. This attribute is applicable when the warehouse places the item under lot and serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for lots. This attribute is applicable when the warehouse places the item under lot and serial control. -
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 : receivingReceiptRequests-lines-lotSerialItemLots-lotSerialItemSerials-item-response
Type:
Show Source
object
-
FromSerialNumber: string
Maximum Length:
80
Starting serial number in a range of serial numbers of the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
serialAttributesDFF: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the details of the serial attributes that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled. -
serialNumbersDFF: array
Flexfields for Serial Numbers
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the details of the serial numbers that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled. -
ToSerialNumber: string
Maximum Length:
80
Ending serial number in a range of serial numbers of the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable when the warehouse places the item under lot and serial control. -
VendorSerialNumber: string
Maximum Length:
80
Supplier serial number for the serial range of the advanced shipment notice (ASN) line request or receipt line request. This attribute is applicable 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 Serial Attributes
Type:
array
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the details of the serial attributes that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Serial Numbers
Type:
array
Title:
Flexfields for Serial Numbers
The Flexfields for Serial Numbers resource manages the details of the serial numbers that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled.
Show Source
Nested Schema : receivingReceiptRequests-lines-lotSerialItemLots-lotSerialItemSerials-serialAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serial attributes. This attribute is applicable when the warehouse places the item under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value serial attributes. This attribute is applicable when the warehouse places the item under serial control. -
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 : receivingReceiptRequests-lines-lotSerialItemLots-lotSerialItemSerials-serialNumbersDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for serials. This attribute is applicable when the warehouse places the item under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value for serials. This attribute is applicable when the warehouse places the item under serial control. -
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
Links
- lotAttributesDFF
-
Parameters:
- HeaderInterfaceId:
$request.path.HeaderInterfaceId
- InterfaceTransactionId:
$request.path.InterfaceTransactionId
- lotSerialItemLotsUniqID:
$request.path.lotSerialItemLotsUniqID
The Flexfields for Lot Attributes resource manages the details of the lot attributes that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled. - HeaderInterfaceId:
- lotNumbersDFF
-
Parameters:
- HeaderInterfaceId:
$request.path.HeaderInterfaceId
- InterfaceTransactionId:
$request.path.InterfaceTransactionId
- lotSerialItemLotsUniqID:
$request.path.lotSerialItemLotsUniqID
The Flexfields for Lot Numbers resource manages the details of the lot numbers that the descriptive flexfield references and is associated with a line whose item is both lot and serial controlled. - HeaderInterfaceId:
- lotSerialItemSerials
-
Parameters:
- HeaderInterfaceId:
$request.path.HeaderInterfaceId
- InterfaceTransactionId:
$request.path.InterfaceTransactionId
- lotSerialItemLotsUniqID:
$request.path.lotSerialItemLotsUniqID
The Serials for Lot and Serial Items resource manages the serial number information associated with a specific lot for a line whose item is both lot and serial controlled. - HeaderInterfaceId: