Service Directory > v32.1 > Inventory > Get_Item_Lots
 

Operation: Get_Item_Lots

This service operation will get Item Lots for the specified criteria. Item Lot Data includes Lot Identifier, Purchase Item, Manufacturer, Lot Manufacture Date, lot Expiration Date, Lot Status and Lot Memo.. The request criteria can be for a single item lot based on Reference, or all item lots can be retrieved if no criteria is specified.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Item_Lots_Request

Contains request reference, criteria, filter and response group for getting Item Lot data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Item_Lot_Request_References  [0..1]  Get Item Lots Request References   
Request_Criteria [Choice]   Item_Lot_Request_Criteria  [0..1]  Get Item Lots Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Item Lots Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Item_Lot_Response_Group  [0..1]  Get Item Lots Response Group   
top
 

Response Element: Get_Item_Lots_Response

Element containing Item Lot response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Item_Lot_Request_References  [0..1]  Get Item Lots Request References   
Request_Criteria  Item_Lot_Request_Criteria  [0..1]  Get Item Lots Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Item Lots Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Item_Lot_Response_Group  [0..1]  Get Item Lots Response Group   
Response_Results  Response_Results  [0..1]  Get Item Lots Response Results   
Response_Data  Item_Lot_Response_Data  [0..1]  Get Item Lots Response Data   
top
 

Item_Lot_Request_References

part of: Get_Item_Lots_Request, Get_Item_Lots_Response
Element containing reference instances for an Item Lot object
 
Parameter name Type/Value Cardinality Description Validations
Item_Lot_Reference  Item_LotObject  [1..*]  Reference to an existing Item Lot   
top
 

Item_LotObject

part of: Item_Lot_Request_References, Item_Lot
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Item_LotObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Item_LotObjectID

part of: Item_LotObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Item_Lot_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Item_Lot_Request_Criteria

part of: Get_Item_Lots_Request, Get_Item_Lots_Response
Element containing Item Lot request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Item_Lots_Request, Get_Item_Lots_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Item_Lot_Response_Group

part of: Get_Item_Lots_Request, Get_Item_Lots_Response
Element containing Item Lot response group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Item_Lots_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Item_Lot_Response_Data

part of: Get_Item_Lots_Response
Wrapper Element that includes Item Lot Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Item_Lot  Item_Lot  [0..*]  Item Lot   
top
 

Item_Lot

part of: Item_Lot_Response_Data
Wrapper Element that includes Item Lot Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Item_Lot_Reference  Item_LotObject  [0..1]  Reference to an existing Item Lot   
Item_Lot_Data  Item_Lot_Data  [0..1]  Item Lot Data 
Validation Description
Enter an Expiration Date that is on or after the Manufacture Date.   
Enter a Lot Identifier, Item and Manufacturer combination that isn't already in use.   
You can’t set the Item Lot Status to Inactive when there is an on-hand balance for the item.   
You have to select a purchase item that is marked as Lot Control.   
You can't change the Item on the Lot when inventory transaction exists.   
You can't change the Lot Identifier on the Lot when inventory transaction exists.   
You have to select an active Manufacturer for an Item Lot.   
 
top
 

Item_Lot_Data

part of: Item_Lot
Element containing all Item Lot data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Item Lot ID. This is the Item Lot unique identifier   
Lot_Identifier  string  [1..1]  Free form text field for Item Lot Identifier   
Purchase_Item_Reference  Purchase_ItemObject  [1..1]  This is the reference id value of the Purchase Item associated with the Item Lot   
Lot_Manufacturer_Reference  ManufacturerObject  [0..1]  This is the reference id value of the Item Lot Manufacturer. 
Validation Description
You must provide the manufacturer for this Item lot combination.   
 
Manufacture_Date  date  [0..1]  Manufacturer Date for the Item Lot   
Expiration_Date  date  [0..1]  Expiration Date for the Item Lot 
Validation Description
Expiration Date must be entered, It is required for this Purchase Item.   
 
Lot_Status_Reference  Document_StatusObject  [1..1]  This is the reference id value of the Item Lot Status. Valid Values are Active, Inactive or On Hold.   
Memo  string  [0..1]  Free form text for Item Lot Memo   
Validation Description
Enter an Expiration Date that is on or after the Manufacture Date.   
Enter a Lot Identifier, Item and Manufacturer combination that isn't already in use.   
You can’t set the Item Lot Status to Inactive when there is an on-hand balance for the item.   
You have to select a purchase item that is marked as Lot Control.   
You can't change the Item on the Lot when inventory transaction exists.   
You can't change the Lot Identifier on the Lot when inventory transaction exists.   
You have to select an active Manufacturer for an Item Lot.   
top
 

Purchase_ItemObject

part of: Item_Lot_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Purchase_ItemObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Purchase_ItemObjectID

part of: Purchase_ItemObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Purchase_Item_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

ManufacturerObject

part of: Item_Lot_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  ManufacturerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

ManufacturerObjectID

part of: ManufacturerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Manufacturer_Name, Manufacturer_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Document_StatusObject

part of: Item_Lot_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Document_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Document_StatusObjectID

part of: Document_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Document_Status_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Item_LotReferenceEnumeration

part of: Item_LotObjectID
Base Type
string
top
 

Purchase_ItemReferenceEnumeration

part of: Purchase_ItemObjectID
Base Type
string
top
 

ManufacturerReferenceEnumeration

part of: ManufacturerObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top