Get all lots
get
/fscmRestApi/resources/11.13.18.05/inventoryCompletedTransactions/{TransactionId}/child/lots
Request
Path Parameters
-
TransactionId(required): integer(int64)
Value that uniquely identifies the transaction.
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Find lots for completed transactions in inventory.
Finder Variables:- LotNumber; string; Value that uniquely identifies the lot.
- PrimaryKey: Find lots for completed transactions in inventory.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ExpirationAction; string; Name of the expiration action.
- ExpirationActionCode; string; Abbreviation that identifies the expiration action.
- ExpirationActionDate; string; Date when the expiration action occurred.
- GradeCode; string; Abbreviation that identifies the grade when the item is under lot control.
- HoldDate; string; Date when the lot can be released.
- LotNumber; string; Lot number for the item. This value is applicable when the warehouse places the item under lot control.
- MaturityDate; string; Date when the lot has reached its full maturity.
- OriginationDate; string; Date when the serial originated.
- OriginationType; string; Type if origination.
- OriginationTypeCode; integer; Abbreviation that identifies the origination type.
- ParentLot; string; Number that identifies the parent lot of a lot.
- Reason; string; Reason for the transaction.
- ReasonId; integer; Value that uniquely identifies the reason for the transaction.
- RetestDate; string; Date when the lot is retested.
- Status; string; Description of the status of the lot when the item is under lot control.
- StatusId; integer; Value that uniquely identifies the status of the lot when the item is under lot control.
- SupplierLotNumber; string; Number that identifies the supplier lot.
- TransactionQuantity; number; Transaction quantity of the item for this lot. This value is applicable when the warehouse places the item under lot control.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : inventoryCompletedTransactions-lots
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryCompletedTransactions-lots-item-response
Type:
Show Source
object
-
ExpirationAction: string
Read Only:
true
Name of the expiration action. -
ExpirationActionCode: string
Maximum Length:
32
Abbreviation that identifies the expiration action. -
ExpirationActionDate: string
(date)
Title:
Expiration Action Date
Date when the expiration action occurred. -
GradeCode: string
Maximum Length:
150
Abbreviation that identifies the grade when the item is under lot control. -
HoldDate: string
(date)
Date when the lot can be released.
-
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 descriptive flexfields that modifies lot attributes. Use this resource only when the item is under lot control. -
LotNumber: string
Title:
Lot
Maximum Length:80
Lot number for the item. This value is applicable when the warehouse places the item under lot control. -
lotSerials: array
Serials in Lots in Completed Transactions
Title:
Serials in Lots in Completed Transactions
The Serials in Lots in Completed Transactions resource gets serial details for inventory transactions when the item is under both lot and serial control. The details include serial number, and so on. -
lotStandardDFFs: array
Flexfields for Lots
Title:
Flexfields for Lots
The Flexfields for Lots resource manages the descriptive flexfields that modifies lots. Use this resource only when the item is under lot control. -
MaturityDate: string
(date)
Date when the lot has reached its full maturity.
-
OriginationDate: string
(date)
Date when the serial originated.
-
OriginationType: string
Read Only:
true
Type if origination. -
OriginationTypeCode: integer
(int64)
Abbreviation that identifies the origination type.
-
ParentLot: string
Title:
Parent Lot
Maximum Length:80
Number that identifies the parent lot of a lot. -
Reason: string
Read Only:
true
Reason for the transaction. -
ReasonId: integer
(int64)
Value that uniquely identifies the reason for the transaction.
-
RetestDate: string
(date)
Date when the lot is retested.
-
Status: string
Read Only:
true
Description of the status of the lot when the item is under lot control. -
StatusId: integer
(int64)
Value that uniquely identifies the status of the lot when the item is under lot control.
-
SupplierLotNumber: string
Title:
Supplier Lot
Maximum Length:150
Number that identifies the supplier lot. -
TransactionQuantity: number
Transaction quantity of the item for this lot. This value is applicable when the warehouse places the item under lot 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 descriptive flexfields that modifies lot attributes. Use this resource only when the item is under lot control.
Show Source
Nested Schema : Serials in Lots in Completed Transactions
Type:
array
Title:
Serials in Lots in Completed Transactions
The Serials in Lots in Completed Transactions resource gets serial details for inventory transactions when the item is under both lot and serial control. The details include serial number, and so on.
Show Source
Nested Schema : Flexfields for Lots
Type:
array
Title:
Flexfields for Lots
The Flexfields for Lots resource manages the descriptive flexfields that modifies lots. Use this resource only when the item is under lot control.
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 : inventoryCompletedTransactions-lots-lotAttributeDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name that references a lot attribute when the item is under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value that references a lot attribute when the item is under lot control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that references the lot of the inventory item when the item is under lot control. -
TransactionId: integer
(int64)
Value that uniquely identifies the completed transaction when the item is under lot control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryCompletedTransactions-lots-lotSerials-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
serialAttributeDFFs: array
Flexfields for Serial Attributes
Title:
Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the descriptive flexfields that modifies serial attributes. Use this resource only when the item is under serial control. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number of the transaction. This value is applicable when the item is under both lot and serial control. -
serialStandardDFFs: array
Flexfields for Serials
Title:
Flexfields for Serials
The Flexfields for Serials resource manages the descriptive flexfields that modifies serials. Use this resource only when the item is under serial control. -
SupplierSerialNumber: string
Read Only:
true
Serial number assigned to the item by its supplier.
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 descriptive flexfields that modifies serial attributes. Use this resource only when the item is under serial control.
Show Source
Nested Schema : Flexfields for Serials
Type:
array
Title:
Flexfields for Serials
The Flexfields for Serials resource manages the descriptive flexfields that modifies serials. Use this resource only when the item is under serial control.
Show Source
Nested Schema : inventoryCompletedTransactions-lots-lotSerials-serialAttributeDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name that references a serial attribute. This value is applicable when the item is under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value that references a serial attribute. This value is applicable when the item is under serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number of the inventory item that references the serial in a lot. This value is applicable when the item is under serial control. -
TransactionId: integer
(int64)
Value that uniquely identifies the completed transaction. This value is applicable when the item is under serial control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryCompletedTransactions-lots-lotSerials-serialStandardDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name that references the serial. This value is applicable when the item is under serial control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value that references the serial. This value is applicable when the item is under serial control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number of the inventory item that references the serial in a lot. This value is applicable when the item is under serial control. -
TransactionId: integer
(int64)
Value that uniquely identifies completed transaction. This value is applicable when the item is under serial control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryCompletedTransactions-lots-lotStandardDFFs-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name that references the lot. This value is applicable when the item is under lot control. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Descriptive flexfield context display value that references the lot. This value is applicable when the item is under lot control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that references the lot of the inventory item when the item is under lot control. -
TransactionId: integer
(int64)
Value that uniquely identifies the completed transaction when the item is under lot control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all lots.
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/inventoryCompletedTransactions/TransactionId/child/lots"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "LotNumber": "KKLO3", "ParentLot": null, "TransactionQuantity": 1, "Status": null, "StatusId": 1, "SupplierLotNumber": null, "GradeCode": null, "OriginationTypeCode": 3, "OriginationType": null, "OriginationDate": null, "RetestDate": null, "ExpirationActionCode": null, "ExpirationAction": null, "ExpirationActionDate": null, "HoldDate": null, "MaturityDate": null, "Reason": null, "ReasonId": null }{},{} ], }