Jump to

• Request
• Response

Get one lot information

get

/fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/{HeaderInterfaceId}/child/lines/{InterfaceTransactionId}/child/lotItemLots/{lotItemLotsUniqID}

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.
• lotItemLotsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Lots for Lot Items resource and used to uniquely identify an instance of Lots for Lot Items. The client should not generate the hash key value. Instead, the client should query on the Lots for Lot Items collection resource in order to navigate to a specific instance of Lots for Lot 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 Top

Response

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.

Body ()

Root Schema : receivingReceiptRequests-lines-lotItemLots-item-response

Type: object

Show Source

• 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 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 lot controlled and not serial controlled.
• LotExpirationDate: string (date)
  Date when the item 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 control.
• LotNumber: string
  Maximum Length: 80

  Number that identifies 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.
• 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 lot controlled and not serial controlled.
• MaturityDate: string (date)
  Date when the lot matures. This attribute is applicable when the warehouse places the item under lot control.
• OriginationDate: string (date)
  Date when the lot originated 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.
• 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 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 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 (int64)
  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
  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.
• 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.
• TransactionQuantity: number
  Transaction quantity of the item for the 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 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 control.

{
    "type":"object",
    "properties":{
        "PrimaryQuantity":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "lotAttributesDFF":{
            "title":"Flexfields for Lot Attributes",
            "type":"array",
            "description":"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 lot controlled and not serial controlled.",
            "items":{
                "$ref":"#/components/schemas/receivingReceiptRequests-lines-lotItemLots-lotAttributesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "lotNumbersDFF":{
            "title":"Flexfields for Lot Numbers",
            "type":"array",
            "description":"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 lot controlled and not serial controlled.",
            "items":{
                "$ref":"#/components/schemas/receivingReceiptRequests-lines-lotItemLots-lotNumbersDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ParentLotNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"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 control.",
            "nullable":true,
            "x-queryable":true
        },
        "MaturityDate":{
            "type":"string",
            "description":"Date when the lot matures. This attribute is applicable when the warehouse places the item under lot control.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LotExpirationDate":{
            "type":"string",
            "description":"Date when the item 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 control.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReasonName":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the reason for the receiving transaction for the lot. This attribute is applicable when the warehouse places the item under lot control.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"Transaction quantity of the item for the 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 control.",
            "nullable":false,
            "x-queryable":true
        },
        "OriginationDate":{
            "type":"string",
            "description":"Date when the lot originated 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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "GradeCode":{
            "maxLength":"150",
            "type":"string",
            "description":"Abbreviation that identifies the grade.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryTransactionQuantity":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginationType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "HoldDate":{
            "type":"string",
            "description":"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 control.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VendorLotNumber":{
            "maxLength":"150",
            "type":"string",
            "description":"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 control.",
            "nullable":true,
            "x-queryable":true
        },
        "ReasonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reason for the receiving transaction. This attribute is applicable when the warehouse places the item under lot control.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies 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.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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 lot controlled and not serial controlled.

Show Source

• Array of: object receivingReceiptRequests-lines-lotItemLots-lotAttributesDFF-item-response

{
    "title":"Flexfields for Lot Attributes",
    "type":"array",
    "description":"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 lot controlled and not serial controlled.",
    "items":{
        "$ref":"#/components/schemas/receivingReceiptRequests-lines-lotItemLots-lotAttributesDFF-item-response"
    },
    "x-cardinality":"1"
}

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 lot controlled and not serial controlled.

Show Source

• Array of: object receivingReceiptRequests-lines-lotItemLots-lotNumbersDFF-item-response

{
    "title":"Flexfields for Lot Numbers",
    "type":"array",
    "description":"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 lot controlled and not serial controlled.",
    "items":{
        "$ref":"#/components/schemas/receivingReceiptRequests-lines-lotItemLots-lotNumbersDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : receivingReceiptRequests-lines-lotItemLots-lotAttributesDFF-item-response

Type: object

Show Source

• __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)

{
    "type":"object",
    "properties":{
        "TransactionInterfaceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield context display value for lot attributes. This attribute is applicable when the warehouse places the item under lot and serial control.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":"80",
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for lot attributes. This attribute is applicable when the warehouse places the item under lot and serial control.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : receivingReceiptRequests-lines-lotItemLots-lotNumbersDFF-item-response

Type: object

Show Source

• __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)

{
    "type":"object",
    "properties":{
        "TransactionInterfaceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Descriptive flexfield context display value for lots. This attribute is applicable when the warehouse places the item under lot and serial control.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":"80",
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for lots. This attribute is applicable when the warehouse places the item under lot and serial control.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

lotAttributesDFF

Operation: /fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/{HeaderInterfaceId}/child/lines/{InterfaceTransactionId}/child/lotItemLots/{lotItemLotsUniqID}/child/lotAttributesDFF

Parameters:

• HeaderInterfaceId: $request.path.HeaderInterfaceId
• InterfaceTransactionId: $request.path.InterfaceTransactionId
• lotItemLotsUniqID: $request.path.lotItemLotsUniqID

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 lot controlled and not serial controlled.

lotNumbersDFF

Operation: /fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/{HeaderInterfaceId}/child/lines/{InterfaceTransactionId}/child/lotItemLots/{lotItemLotsUniqID}/child/lotNumbersDFF

Parameters:

• HeaderInterfaceId: $request.path.HeaderInterfaceId
• InterfaceTransactionId: $request.path.InterfaceTransactionId
• lotItemLotsUniqID: $request.path.lotItemLotsUniqID

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 lot controlled and not serial controlled.

Back to Top