1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Inventory Management
  4. Requests for Receiving Transactions
  5. Lots for Lot Items

Get all lot information

get

/fscmRestApi/resources/11.13.18.05/receivingReceiptTransactionRequests/{InterfaceTransactionId}/child/lotItemLots

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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: Finds lot numbers when lots control the item.
      Finder Variables:
      • LotNumber; string; Number that identifies the lot associated with the receipt transaction request when the line item is lot controlled and not serial controlled.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ExpirationActionCode; string; Abbreviation that identifies the expiration action.
    • ExpirationActionDate; string; Date when the warehouse performed the expiration action.
    • GradeCode; string; Abbreviation that identifies the grade.
    • HoldDate; string; Date when the warehouse applied a hold on the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
    • LotExpirationDate; string; Date when the item of the lot corresponding to receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
    • LotNumber; string; Number that identifies the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
    • MaturityDate; string; Date when the lot matures. This attribute is applicable when the warehouse places the item under lot control.
    • OriginationDate; string; Date when the lot originated corresponding to the ASN line request or receipt line request. This attribute is applicable when the warehouse places the item under lot control.
    • OriginationType; string; 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 control.
    • ParentLotNumber; string; Number that identifies the parent lot of the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
    • PrimaryQuantity; number; Transaction quantity for the lot in the primary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot control.
    • ReasonId; integer; Value that uniquely identifies the reason for the receiving transaction. This attribute is applicable when the warehouse places the item under lot control.
    • ReasonName; string; Name of the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot control.
    • SecondaryTransactionQuantity; number; Transaction quantity for the lot in the secondary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot control.
    • StatusId; integer; Value that uniquely identifies the material status.
    • TransactionQuantity; number; Transaction quantity of the item for the lot corresponding to the receipt transaction request expires. This attribute is applicable when the warehouse places the item under lot control.
    • VendorLotNumber; string; Number that identifies the supplier lot for the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : receivingReceiptTransactionRequests-lotItemLots
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : receivingReceiptTransactionRequests-lotItemLots-item-response
Type: object
Show Source
  • Maximum Length: 32
    Abbreviation that identifies the expiration action.
  • Date when the warehouse performed the expiration action.
  • Maximum Length: 150
    Abbreviation that identifies the grade.
  • Date when the warehouse applied a hold on the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
  • Links
  • Flexfields for Lot Attributes
    Title: Flexfields for Lot Attributes
    The Flexfields for Lot Attributes resource manages the details of the lot attributes and is associated to a transaction line whose item is both lot and serial controlled.
  • Date when the item of the lot corresponding to receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
  • Maximum Length: 80
    Number that identifies the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
  • Flexfields for Lot Numbers
    Title: Flexfields for Lot Numbers
    The Flexfields for Lot Numbers resource manages lot numbers and is associated to a transaction line whose item is both lot and serial controlled.
  • Date when the lot matures. This attribute is applicable when the warehouse places the item under lot control.
  • Date when the lot originated corresponding to the ASN line request or receipt line request. This attribute is applicable when the warehouse places the item under lot control.
  • 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 control.
  • Maximum Length: 80
    Number that identifies the parent lot of the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
  • Transaction quantity for the lot in the primary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot control.
  • Value that uniquely identifies the reason for the receiving transaction. This attribute is applicable when the warehouse places the item under lot control.
  • 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 control.
  • Date when the lot is retested. This attribute is based on the lot origination date and the retest interval.
  • Transaction quantity for the lot in the secondary unit of measure that the item uses. This attribute is applicable when the warehouse places the item under lot control.
  • Value that uniquely identifies the material status.
  • Transaction quantity of the item for the lot corresponding to the receipt transaction request expires. This attribute is applicable when the warehouse places the item under lot control.
  • Maximum Length: 150
    Number that identifies the supplier lot for the lot corresponding to the receipt transaction request. This attribute is applicable when the warehouse places the item under lot control.
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 and is associated to a transaction 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 lot numbers and is associated to a transaction line whose item is both lot and serial controlled.
Show Source
Nested Schema : receivingReceiptTransactionRequests-lotItemLots-lotAttributesDFF-item-response
Type: object
Show Source
Nested Schema : receivingReceiptTransactionRequests-lotItemLots-lotNumbersDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all lot information.

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/receivingReceiptTransactionRequests/InterfaceTransactionId/child/lotItemLots"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "LotNumber": "LOT180609",
            "LotExpirationDate": null,
            "ParentLotNumber": null,
            "VendorLotNumber": null,
            "TransactionQuantity": 3,
            "PrimaryQuantity": null,
            "SecondaryTransactionQuantity": null,
            "OriginationDate": null,
            "OriginationType": null,
            "HoldDate": null,
            "ReasonId": null,
            "ReasonName": null,
            "MaturityDate": null
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptTransactionRequests/300100169538373/child/lotItemLots",
            "name": "lotItemLots",
            "kind": "collection"
        }
    ]
}
Back to Top