Get one lot
get
/fscmRestApi/resources/11.13.18.05/inventoryItemLots/{inventoryItemLotsUniqID}
Request
Path Parameters
-
inventoryItemLotsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- OrganizationId, InventoryItemId and LotNumber ---for the Inventory Item Lots resource and used to uniquely identify an instance of Inventory Item Lots. The client should not generate the hash key value. Instead, the client should query on the Inventory Item Lots collection resource with a filter on the primary key values in order to navigate to a specific instance of Inventory Item Lots.
For example: inventoryItemLots?q=OrganizationId=<value1>;InventoryItemId=<value2>;LotNumber=<value3>
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 : inventoryItemLots-item-response
Type:
Show Source
object
-
ActiveLot: string
Maximum Length:
80
Value that indicates the status of the lots. A list of accepted values is defined in the lookup ORA_INV_LOT_ACTIVE. The default value is Yes. -
ActiveLotCode: string
Maximum Length:
30
Default Value:2
Abbreviation that indicates the status of the lot. A list of accepted values is defined in the lookup ORA_INV_LOT_ACTIVE. The default value is 2. -
Disabled: string
Value that indicates whether or not the lot number is disabled. Contains one of the following values: Yes or Null. If Yes, then the lot number is disabled. If Null, then the lot number isn't disabled. The default value is Null.
-
DisabledCode: string
Maximum Length:
1
Default Value:N
Abbreviation that identifies the current usage of the lot number. A list of accepted values is defined in the lookup YES_NO. The default value is null. -
ExpirationAction: string
Title:
Description
Maximum Length:80
Expiration action. -
ExpirationActionCode: string
Title:
Expiration Action
Maximum Length:32
Abbreviation that identifies the expiration action. -
ExpirationActionDate: string
(date-time)
Title:
Expiration Action Date
Date when the warehouse performed the expiration action. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the warehouse expired the lot. -
Grade: string
Title:
Grade
Maximum Length:150
Abbreviation that identifies the grade of the item. -
GradeDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Value that describes the grade of the item. -
HoldUntilDate: string
(date-time)
Title:
Hold Until Date
Date when the hold expires. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the inventory item. -
ItemNumber: string
Maximum Length:
300
Name of the inventory item. -
ItemPrimaryImageURL: string
Title:
Primary Image URL
Read Only:true
Maximum Length:4000
URL for the primary image of the inventory item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lotAttributeDFF: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot Attributes
A flexible data field that includes all the inventory item lot attribute flexfields. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies the lot. -
lotStandardDFF: array
Flexfields for Lots
Title:
Flexfields for Lots
A flexible data field that includes all the inventory item lot flexfields. -
LotStatusMeaning: string
Read Only:
true
Maximum Length:255
Value that displays the Enabled or Disabled status of the lookup meaning of the lot status. The default value is Enabled. -
MaturityDate: string
(date-time)
Title:
Maturity Date
Date when the item matures. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
OrganizationName: string
Maximum Length:
240
Name of the organization. -
OriginationDate: string
(date-time)
Title:
Origination Date
Date when the warehouse created the lot. -
OriginationType: string
Maximum Length:
80
Value that identifies the origination type of the lots. A list of accepted values is defined in the lookup INV_LOT_ORIGINATION_TYPE. The default value is Lot master. -
OriginationTypeCode: string
Title:
Origination Type
Maximum Length:30
Default Value:0
Abbreviation that identifies the origination type of the lots. A list of accepted values is defined in the lookup INV_LOT_ORIGINATION_TYPE. The default value is 0. -
ParentLotNumber: string
Title:
Parent Lot
Maximum Length:80
Number that identifies the parent lot. -
RetestDate: string
(date-time)
Date when the lot is retested. This attribute is based on the lot origination date and the retest interval.
-
StatusCode: string
Title:
Material Status
Maximum Length:80
Abbreviation that identifies the status of the item. -
StatusId: integer
(int64)
Title:
Material Status
Default Value:1
Value that uniquely identifies the material status. -
supplierLotNumbers: array
Supplier Lot Numbers
Title:
Supplier Lot Numbers
A supplier lot number associated with a lot. -
UniqueDeviceIdentifier: string
Maximum Length:
150
Value that uniquely identifies the device.
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
A flexible data field that includes all the inventory item lot attribute flexfields.
Show Source
Nested Schema : Flexfields for Lots
Type:
array
Title:
Flexfields for Lots
A flexible data field that includes all the inventory item lot flexfields.
Show Source
Nested Schema : Supplier Lot Numbers
Type:
array
Title:
Supplier Lot Numbers
A supplier lot number associated with a 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 : inventoryItemLots-lotAttributeDFF-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
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies the lot. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryItemLots-lotStandardDFF-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
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies the lot. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryItemLots-supplierLotNumbers-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization. -
SupplierLotNumber: string
Read Only:
true
Maximum Length:150
Value that uniquely identifies the supplier lot number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- lotAttributeDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/inventoryItemLots/{inventoryItemLotsUniqID}/child/lotAttributeDFFParameters:
- inventoryItemLotsUniqID:
$request.path.inventoryItemLotsUniqID
A flexible data field that includes all the inventory item lot attribute flexfields. - inventoryItemLotsUniqID:
- lotStandardDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/inventoryItemLots/{inventoryItemLotsUniqID}/child/lotStandardDFFParameters:
- inventoryItemLotsUniqID:
$request.path.inventoryItemLotsUniqID
A flexible data field that includes all the inventory item lot flexfields. - inventoryItemLotsUniqID:
- supplierLotNumbers
-
Parameters:
- inventoryItemLotsUniqID:
$request.path.inventoryItemLotsUniqID
A supplier lot number associated with a lot. - inventoryItemLotsUniqID:
Examples
This example describes how to get one inventory item lot.
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/inventoryItemLots?onlyData=true&=LotNumber=value"
For example, the following command gets inventory item lot S00001:
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryItemLots?onlyData=true&=LotNumber=S00001"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items" : [ { "OrganizationId" : 207, "OrganizationCode" : "M1", "OrganizationName" : "Tall Manufacturing\t\t", "InventoryItemId" : 606, "ItemNumber" : "CM11222", "ItemDescription" : "Battery - Extended Life", "LotNumber" : "S00001", "ParentLotNumber" : null, "ActiveLotCode" : "1", "ActiveLot" : "No", "OriginationTypeCode" : null, "OriginationType" : "Lot master", "StatusId" : 1, "StatusCode" : "Active", "Grade" : null, "ExpirationActionCode" : null, "ExpirationAction" : null, "OriginationDate" : null, "ExpirationDate" : "1998-06-24", "MaturityDate" : null, "ExpirationActionDate" : null, "HoldUntilDate" : null } ], "count" : 1, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/logisticsApi/resources/version/inventoryItemLots", "name" : "inventoryItemLots", "kind" : "collection" } ] }