Service Directory > v32.1 > Inventory > Submit_Inventory_Shipment
 

Operation: Submit_Inventory_Shipment

Create inventory shipment and its business process via web service operation


@ - 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: Submit_Inventory_Shipment_Request

Submit Inventory Shipment Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Add_Only  boolean  [0..1]  Add Only boolean indicator   
Inventory_Shipment_Reference  Inventory_Ship_ListObject  [0..1]  Reference to Inventory Ship List   
Financials_Business_Process_Parameters_Element  Financials_Business_Process_Parameters  [0..1]  Financials Business Process Parameters   
Inventory_Shipment_Data_Element  Inventory_Shipment_Data_Inbound  [0..1]  Inventory Shipment Data Inbound Element 
Validation Description
Inventory Site is incorrect. Check Inventory Site  Inventory Site is incorrect. Check Inventory Site 
Ship to Address is incorrect.  Ship to Address is incorrect. 
Inventory Site does NOT match with the inventory pick list's Inventory site  Inventory Site does NOT match with the inventory pick list's Inventory site 
The number of shipment lines is not equal to the number of lines picked  The number of shipment lines is not equal to the number of lines picked 
Duplicate entries were submitted for the same Pick List Line. Please remove the duplicates.  Duplicate entries were submitted for the same Pick List Line. Please remove the duplicates. 
Serial numbers are required for serial controlled items and the count of serial numbers must match the ship quantity  Serial numbers are required for serial controlled items and the count of serial numbers must match the ship quantity 
To be eligible for shipment via web service, the status of the Pick List must be "Picked"  To be eligible for shipment via web service, the status of the Pick List must be "Picked" 
 
Validation Description
The Web Service is set to Add Only; documents cannot be resubmitted.  The Web Service is set to Add Only; documents cannot be resubmitted. 
The document status of Inventory Shipment is Closed; Closed Inventory shipment cannot be resubmitted.  The document status of Inventory Shipment is Closed; Closed Inventory shipment cannot be resubmitted. 
top
 

Response Element: Submit_Inventory_Shipment_Request_Response

Submit Inventory Shipment Request Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Inventory_Ship_List_Reference  Inventory_Ship_ListObject  [0..1]  Reference to Inventory Ship list line   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Inventory_Ship_ListObject

part of: Submit_Inventory_Shipment_Request, Submit_Inventory_Shipment_Request_Response
 
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  Inventory_Ship_ListObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Inventory_Ship_ListObjectID

part of: Inventory_Ship_ListObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Inventory_Ship_List_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
 

Financials_Business_Process_Parameters

part of: Submit_Inventory_Shipment_Request
Contains data for business processing
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures the Comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Financials_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

part of: Business_Process_Comment_Data, Inventory_Shipment_Data_Inbound
 
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  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Employee_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
 

Inventory_Shipment_Data_Inbound

part of: Submit_Inventory_Shipment_Request
Inventory Shipment Data Inbound Element
 
Parameter name Type/Value Cardinality Description Validations
Inventory_Ship_List_ID  string  [0..1]  ID of Inventory shipment instance   
Inventory_Site_Reference  LocationObject  [1..1]  Reference to Inventory Site   
Inventory_Pick_List_Reference  Inventory_Pick_ListObject  [1..1]  Reference to Inventory Pick List Reference   
Assign_To_Worker_of_Inventory_Shipment_Reference  WorkerObject  [0..1]  Reference to Creator of Inventory Shipment   
Target_Fulfillment_Date  date  [0..1]  Target Fulfillment Date of Inventory Shipment   
Tracking_ID_Reference  Unique_IdentifierObject  [0..1]  Reference to Tracking ID of Inventory Shipment   
Tracking_Id  string  [0..1]  Tracking ID   
Ship-To_Contact  string  [0..1]  Ship-To Contact   
Ship_To_Address_Reference  Unique_IdentifierObject  [0..1]  Reference to Ship to Address   
Deliver_To_Location_Reference  LocationObject  [0..1]  Deliver To Location Reference 
Validation Description
Invalid Deliver To Location entered on the fulfillment transaction   
 
Document_Memo  string  [0..1]  Document Memo of Inventory Shipment   
Inventory_Shipment_Line_Data_Inbound_Element  Inventory_Shipment_Line_Inbound_Data  [0..*]  Inventory Shipment Line Inbound Data Element 
Validation Description
Serial numbers are required for serial controlled items and the count of serial numbers must match the ship quantity   
Serial number isn't allowed for non-serial controlled item.   
Duplicate serial numbers are not allowed.   
 
Attachment_Element  Business_Document_Attachment_with_External_Option_Data  [0..*]  Encapsulating element containing all Business Document Attachment data. 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Validation Description
Inventory Site is incorrect. Check Inventory Site  Inventory Site is incorrect. Check Inventory Site 
Ship to Address is incorrect.  Ship to Address is incorrect. 
Inventory Site does NOT match with the inventory pick list's Inventory site  Inventory Site does NOT match with the inventory pick list's Inventory site 
The number of shipment lines is not equal to the number of lines picked  The number of shipment lines is not equal to the number of lines picked 
Duplicate entries were submitted for the same Pick List Line. Please remove the duplicates.  Duplicate entries were submitted for the same Pick List Line. Please remove the duplicates. 
Serial numbers are required for serial controlled items and the count of serial numbers must match the ship quantity  Serial numbers are required for serial controlled items and the count of serial numbers must match the ship quantity 
To be eligible for shipment via web service, the status of the Pick List must be "Picked"  To be eligible for shipment via web service, the status of the Pick List must be "Picked" 
top
 

LocationObject

part of: Inventory_Shipment_Data_Inbound, Inventory_Shipment_Data_Inbound
 
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  LocationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

LocationObjectID

part of: LocationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Location_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
 

Inventory_Pick_ListObject

part of: Inventory_Shipment_Data_Inbound
 
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  Inventory_Pick_ListObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Inventory_Pick_ListObjectID

part of: Inventory_Pick_ListObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Inventory_Pick_List_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
 

Unique_IdentifierObject

part of: Inventory_Shipment_Data_Inbound, Inventory_Shipment_Data_Inbound
 
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  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [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
 

Inventory_Shipment_Line_Inbound_Data

part of: Inventory_Shipment_Data_Inbound
Inventory Shipment Line Inbound Data Element
 
Parameter name Type/Value Cardinality Description Validations
Pick_List_Line_Reference  Inventory_Pick_List_LineObject  [1..1]  Inventory Pick List Line Reference 
Validation Description
The Quantity Picked on Pick List Line [line] is zero. Only Pick List Lines with quantity picked greater than zero may be submitted for shipment.   
 
Business_Document_Line_Memo  string  [0..1]  Business Document Line memo   
Ship_Item_Serial_Line_Data  Ship_Item_Serial_Line_Data  [0..*]  Reference of the serial numbers of the Inventory Item being shipped   
Validation Description
Serial numbers are required for serial controlled items and the count of serial numbers must match the ship quantity   
Serial number isn't allowed for non-serial controlled item.   
Duplicate serial numbers are not allowed.   
top
 

Inventory_Pick_List_LineObject

part of: Inventory_Shipment_Line_Inbound_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  Inventory_Pick_List_LineObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Inventory_Pick_List_LineObjectID

part of: Inventory_Pick_List_LineObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Pick_List_Line_Number  [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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Inventory_Pick_List_Reference_ID, Inventory_Ship_List_Reference_ID, Inventory_Stock_Request_Reference_ID, Quick_Issue_Reference_ID  [1..1]  The unique identifier type of a parent object   
top
 

Ship_Item_Serial_Line_Data

part of: Inventory_Shipment_Line_Inbound_Data
Item serial data for the line
 
Parameter name Type/Value Cardinality Description Validations
Serial_Identifier  string  [0..1]  Serial Identifier   
top
 

Business_Document_Attachment_with_External_Option_Data

part of: Inventory_Shipment_Data_Inbound
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
External  boolean  [0..1]  Field to mark the attachments that can are shared with Suppliers.   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Application_Instance_Related_Exceptions_Data

part of: Submit_Inventory_Shipment_Request_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

Inventory_Ship_ListReferenceEnumeration

part of: Inventory_Ship_ListObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Inventory_Pick_ListReferenceEnumeration

part of: Inventory_Pick_ListObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Inventory_Pick_List_LineReferenceEnumeration

part of: Inventory_Pick_List_LineObjectID
Base Type
string
top
 

Base Type
string

top