Create lots
post
/fscmRestApi/resources/11.13.18.05/inventoryItemLots
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
ActiveLot: string
Maximum Length:
80Value 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:
30Default Value:2Abbreviation 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:
1Default Value:NAbbreviation 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:
DescriptionMaximum Length:80Expiration action. -
ExpirationActionCode: string
Title:
Expiration ActionMaximum Length:32Abbreviation that identifies the expiration action. -
ExpirationActionDate: string
(date-time)
Title:
Expiration Action DateDate when the warehouse performed the expiration action. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the warehouse expired the lot. -
Grade: string
Title:
GradeMaximum Length:150Abbreviation that identifies the grade of the item. -
HoldUntilDate: string
(date-time)
Title:
Hold Until DateDate when the hold expires. -
InventoryItemId(required): integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemNumber(required): string
Maximum Length:
300Name of the inventory item. -
lotAttributeDFF: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot AttributesA flexible data field that includes all the inventory item lot attribute flexfields. -
LotNumber: string
Title:
LotMaximum Length:80Number that identifies the lot. -
lotStandardDFF: array
Flexfields for Lots
Title:
Flexfields for LotsA flexible data field that includes all the inventory item lot flexfields. -
MaturityDate: string
(date-time)
Title:
Maturity DateDate when the item matures. -
OrganizationCode: string
Maximum Length:
18Abbreviation that identifies the organization. -
OrganizationId(required): integer
(int64)
Value that uniquely identifies the organization.
-
OrganizationName(required): string
Maximum Length:
240Name of the organization. -
OriginationDate: string
(date-time)
Title:
Origination DateDate when the warehouse created the lot. -
OriginationType: string
Maximum Length:
80Value 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 TypeMaximum Length:30Default Value:0Abbreviation 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 LotMaximum Length:80Number 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 StatusMaximum Length:80Abbreviation that identifies the status of the item. -
StatusId: integer
(int64)
Title:
Material StatusDefault Value:1Value that uniquely identifies the material status. -
supplierLotNumbers: array
Supplier Lot Numbers
Title:
Supplier Lot NumbersA supplier lot number associated with a lot. -
UniqueDeviceIdentifier: string
Maximum Length:
150Value that uniquely identifies the device.
Nested Schema : Flexfields for Lot Attributes
Type:
arrayTitle:
Flexfields for Lot AttributesA flexible data field that includes all the inventory item lot attribute flexfields.
Show Source
Nested Schema : Flexfields for Lots
Type:
arrayTitle:
Flexfields for LotsA flexible data field that includes all the inventory item lot flexfields.
Show Source
Nested Schema : Supplier Lot Numbers
Type:
arrayTitle:
Supplier Lot NumbersA supplier lot number associated with a lot.
Show Source
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for lot attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
LotNumber: string
Title:
LotMaximum Length:80Number that identifies the lot. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive flexfield context name for lot standards. -
__FLEX_Context_DisplayValue: string
Title:
Context Value -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
LotNumber: string
Title:
LotMaximum Length:80Number that identifies the lot. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
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.
Root Schema : inventoryItemLots-item-response
Type:
Show Source
object-
ActiveLot: string
Maximum Length:
80Value 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:
30Default Value:2Abbreviation 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:
1Default Value:NAbbreviation 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:
DescriptionMaximum Length:80Expiration action. -
ExpirationActionCode: string
Title:
Expiration ActionMaximum Length:32Abbreviation that identifies the expiration action. -
ExpirationActionDate: string
(date-time)
Title:
Expiration Action DateDate when the warehouse performed the expiration action. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the warehouse expired the lot. -
Grade: string
Title:
GradeMaximum Length:150Abbreviation that identifies the grade of the item. -
GradeDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Value that describes the grade of the item. -
HoldUntilDate: string
(date-time)
Title:
Hold Until DateDate when the hold expires. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:240Description of the inventory item. -
ItemNumber: string
Maximum Length:
300Name of the inventory item. -
ItemPrimaryImageURL: string
Title:
Primary Image URLRead Only:trueMaximum Length:4000URL for the primary image of the inventory item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
lotAttributeDFF: array
Flexfields for Lot Attributes
Title:
Flexfields for Lot AttributesA flexible data field that includes all the inventory item lot attribute flexfields. -
LotNumber: string
Title:
LotMaximum Length:80Number that identifies the lot. -
lotStandardDFF: array
Flexfields for Lots
Title:
Flexfields for LotsA flexible data field that includes all the inventory item lot flexfields. -
LotStatusMeaning: string
Read Only:
trueMaximum Length:255Value 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 DateDate when the item matures. -
OrganizationCode: string
Maximum Length:
18Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
OrganizationName: string
Maximum Length:
240Name of the organization. -
OriginationDate: string
(date-time)
Title:
Origination DateDate when the warehouse created the lot. -
OriginationType: string
Maximum Length:
80Value 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 TypeMaximum Length:30Default Value:0Abbreviation 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 LotMaximum Length:80Number 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 StatusMaximum Length:80Abbreviation that identifies the status of the item. -
StatusId: integer
(int64)
Title:
Material StatusDefault Value:1Value that uniquely identifies the material status. -
supplierLotNumbers: array
Supplier Lot Numbers
Title:
Supplier Lot NumbersA supplier lot number associated with a lot. -
UniqueDeviceIdentifier: string
Maximum Length:
150Value that uniquely identifies the device.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Lot Attributes
Type:
arrayTitle:
Flexfields for Lot AttributesA flexible data field that includes all the inventory item lot attribute flexfields.
Show Source
Nested Schema : Flexfields for Lots
Type:
arrayTitle:
Flexfields for LotsA flexible data field that includes all the inventory item lot flexfields.
Show Source
Nested Schema : Supplier Lot Numbers
Type:
arrayTitle:
Supplier Lot NumbersA supplier lot number associated with a lot.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 ValueMaximum Length:30Descriptive 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:
LinksThe link relations associated with the resource instance. -
LotNumber: string
Title:
LotMaximum Length:80Number that identifies the lot. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryItemLots-lotStandardDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Descriptive 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:
LinksThe link relations associated with the resource instance. -
LotNumber: string
Title:
LotMaximum Length:80Number that identifies the lot. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : inventoryItemLots-supplierLotNumbers-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the organization. -
SupplierLotNumber: string
Read Only:
trueMaximum Length:150Value that uniquely identifies the supplier lot number.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 create lots.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inventoryItemLots"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{
"OrganizationId": 207,
"InventoryItemId": 663914,
"LotNumber": "SF20181206_1"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"OrganizationId": 207,
"OrganizationCode": "M1",
"OrganizationName": "Tall Manufacturing",
"InventoryItemId": 663914,
"ItemNumber": "INV-101",
"ItemDescription": "Lot Item",
"LotNumber": "SF20181206_1",
"ParentLotNumber": null,
"ActiveLotCode": "2",
"ActiveLot": null,
"OriginationTypeCode": "0",
"OriginationType": null,
"StatusId": 1,
"StatusCode": "Active",
"Grade": null,
"ExpirationActionCode": null,
"ExpirationAction": null,
"OriginationDate": "2018-12-06T20:30:11.196+00:00",
"ExpirationDate": null,
"MaturityDate": "2018-12-06T20:30:11.196+00:00",
"ExpirationActionDate": null,
"HoldUntilDate": "2018-12-06T20:30:11.196+00:00",
"RetestDate": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F31",
"name": "inventoryItemLots",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F31",
"name": "inventoryItemLots",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F31/lov/ActiveLotLookupVA",
"name": "ActiveLotLookupVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F31/lov/ItemVA",
"name": "ItemVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F31/lov/AccessibleOrganizationVA",
"name": "AccessibleOrganizationVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F31/lov/LotExpirationActionVA",
"name": "LotExpirationActionVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F31/lov/OriginationTypeLookupVA",
"name": "OriginationTypeLookupVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F31/lov/LotGradeVA",
"name": "LotGradeVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F31/lov/InventoryStatusVA",
"name": "InventoryStatusVA",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F31/child/lotStandardDFF",
"name": "lotStandardDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/inventoryItemLots/00030000000EACED0005770800000000000000CF0000000EACED0005770800000000000A216A0000000C534632303138313230365F31/child/lotAttributeDFF",
"name": "lotAttributeDFF",
"kind": "collection"
}
],
}