Service Directory > v32.1 > Resource_Management > Import_Catalog_Load
 

Operation: Import_Catalog_Load

This service operation will add or update Catalog Items. Catalog Load Requests contain supplier specific Catalog Items and effective dated pricing. Catalog Load Requests can be associated with Supplier Contracts. Once a Catalog Load Request is fully approved Catalog Items are available for use on Requisitions and Purchase Orders based on their effective date. Catalog Loads include data such as Supplier, Supplier Contract, Effective Date, memo and item details such as Item ID, Item Name, Item Description, Unit of Measure and Unit Price.


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

Contains request reference and response group for getting Catalog Load data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..*]  Business Process Parameters provide the ability to auto-submit to the business process.   
Catalog_Load_Data  Catalog_Load__HV__Data  [1..1]  Catalog Load Data 
Validation Description
A Catalog Load Request for this Supplier Catalog has already been saved as draft or is in progress. Complete or cancel the existing Catalog Load Request before creating a new one.   
Effective Date may not be in the past.   
A Supplier Catalog is required to load items.   
There is already an update in progress for this supplier information.   
 
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

Financials_Business_Process_Parameters

part of: Import_Catalog_Load_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
 
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
 

Catalog_Load__HV__Data

part of: Import_Catalog_Load_Request
Element containing Catalog Load Data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  Catalog Effective Date   
Supplier_Catalog_Reference  Abstract_Procurement_CatalogObject  [0..1]  Supplier Catalog for Catalog Load   
Default_Lead_Time_in_Days  decimal (12, 0) >0   [0..1]  Catalog Load Default Catalog Load Item Lead Time in Days   
Catalog_Load_Item_Data  Catalog_Load_Item__HV__Data  [0..*]  Element containing Catalog Load Item data. 
Validation Description
Cannot use Catalog Item ID as it is used for a different Catalog Item   
Specify a Purchase Item that has the same Spend Category as the Catalog Item.   
Provide a valid Spend Category when you specify the Purchase Item for the Catalog Item.   
Item Tag is Inactive.   
No more than four additional images can be assigned to an item.   
You can't specify duplicate Item Identifiers on Catalog Load.   
You can't specify Item Tags for internal service catalog loads.   
You can't specify duplicate ordering units of measure.   
Select a default ordering unit of measure for the catalog load item.   
You can't specify a Purchase Item reference for internal service catalog loads.   
You can't mark units of measure as inactive when loading new catalog items.   
You can't specify alternate item identifiers for internal service catalog loads.   
Enter the same base Unit of Measure of the purchase item when there is a purchase item reference.   
Only one unit of measure can be selected as the default.   
Select a default Just In Time ordering unit of measure for the catalog load item.   
You can't enter duplicate Just In Time units of measure.   
Only one Just In Time unit of measure can be selected as the default.   
You can’t set catalog items as Inactive when they haven’t been loaded into the catalog.   
 
Memo  string  [0..1]  This transaction header memo will print on the delivered transaction. It is optional freeform text   
Validation Description
A Catalog Load Request for this Supplier Catalog has already been saved as draft or is in progress. Complete or cancel the existing Catalog Load Request before creating a new one.   
Effective Date may not be in the past.   
A Supplier Catalog is required to load items.   
There is already an update in progress for this supplier information.   
top
 

Abstract_Procurement_CatalogObject

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

Abstract_Procurement_CatalogObjectID

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

Catalog_Load_Item__HV__Data

part of: Catalog_Load__HV__Data
Element containing Catalog Load Item Data
 
Parameter name Type/Value Cardinality Description Validations
Catalog_Item_ID  string  [0..1]  Catalog Item Unique Identifier   
Item_Identifier  string  [1..1]  Catalog Item Identifier   
Inactive  boolean  [0..1]  Used to inactivate an existing Catalog Item via the Catalog Load WWS request. Please note that if this field is set, any updates to the Catalog Item included in the WWS request will not be carried over when the Catalog Load request is approved.   
Item_Name  string  [1..1]  Catalog Item Name   
Item_Description  string  [1..1]  Catalog Item Description   
Item_URL  string  [0..1]  Catalog Item URL   
Lead_Time  decimal (12, 0) >0   [0..1]  Catalog Item Lead Time   
Spend_Category_Reference [Choice]   Spend_CategoryObject  [1..1]  Catalog Item Spend Category   
UNSPSC_Code [Choice]   decimal (12, 0) >0   [1..1]  Catalog Item UNSPSC code for Spend Category   
Alternate_Item_Identifiers  Catalog_Load_Alternate_Item_Identifier  [0..*]  Alternate Item Identifiers for Catalog Load items. 
Validation Description
Can't enter duplicate Item Identifier Type if the Allow Multiples flag is false.   
Manufacturer is not Active. Please enter an active manufacturer reference.   
Only numeric values are allowed for GTIN.   
Only alphanumeric values are allowed for UPN.   
[type] has to be less than or equal to [length] characters in length   
Alternate Item Identifiers Value is required for non-manufacturer Item Identifier Type.   
Can't have Alternate Item Identifiers Value for Manufacturer Item Identifier Type.   
Enter a valid GTIN   
Item Identifier Type is Inactive.   
You can't specify a unit of measure for item identifier types that aren't unit of measure related.   
Specify a Unit of Measure for item identifier types that are unit of measure related.   
Enter only 1 alternate identifier for the same identifier type, value, and unit of measure combination.   
 
Purchase_Item_Reference  Purchase_ItemObject  [0..1]  Purchase Item for the Catalog Item   
Item_Tag_Reference  Item_TagObject  [0..*]  Item Tags for Catalog Item   
Primary_Image_Data  Primary_Image_Data  [0..1]  Primary Image for Item   
Additional_Image_Data  Additional_Image_Data  [0..*]  Additional Image for Item   
Base_Unit_of_Measure_Reference [Choice]   Unit_of_MeasureObject  [0..1]  Base Unit of Measure Reference for Catalog Load Item.   
UN_CEFACT_Base_UOM_Code [Choice]   string  [0..1]  UN CEFACT Common Code to denote Base UOM of Catalog Load Item.   
Catalog_Load_Item_Unit_of_Measure_Data  Catalog_Load_Item_Unit_of_Measure_Data  [0..*]  Catalog Load Item Unit of Measure 
Validation Description
Provide a valid UN CEFACT UOM Code.   
 
Packaging_String  string  [0..1]  Catalog Load Item Packaging String.   
Validation Description
Cannot use Catalog Item ID as it is used for a different Catalog Item   
Specify a Purchase Item that has the same Spend Category as the Catalog Item.   
Provide a valid Spend Category when you specify the Purchase Item for the Catalog Item.   
Item Tag is Inactive.   
No more than four additional images can be assigned to an item.   
You can't specify duplicate Item Identifiers on Catalog Load.   
You can't specify Item Tags for internal service catalog loads.   
You can't specify duplicate ordering units of measure.   
Select a default ordering unit of measure for the catalog load item.   
You can't specify a Purchase Item reference for internal service catalog loads.   
You can't mark units of measure as inactive when loading new catalog items.   
You can't specify alternate item identifiers for internal service catalog loads.   
Enter the same base Unit of Measure of the purchase item when there is a purchase item reference.   
Only one unit of measure can be selected as the default.   
Select a default Just In Time ordering unit of measure for the catalog load item.   
You can't enter duplicate Just In Time units of measure.   
Only one Just In Time unit of measure can be selected as the default.   
You can’t set catalog items as Inactive when they haven’t been loaded into the catalog.   
top
 

Spend_CategoryObject

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

Spend_CategoryObjectID

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

Catalog_Load_Alternate_Item_Identifier

part of: Catalog_Load_Item__HV__Data
Alternate Item Identifiers for Catalog Load items.
 
Parameter name Type/Value Cardinality Description Validations
Item_Identifier_Type_Reference  Item_Identifier_TypeObject  [1..1]  Item Identifier Type for the Alternate Item Identifier.   
Alternate_Identifier_Value  string  [0..1]  Item Identifier Value for the Alternate Item Identifier.   
Manufacturer_Reference  ManufacturerObject  [0..1]  Please enter an active Manufacturer instance as Alternate Item Identifier   
Unit_of_Measure_Reference [Choice]   Unit_of_MeasureObject  [0..1]  Unit of Measure Reference for Item Identifier Type that supports UOM.   
UN_CEFACT_UOM_Code [Choice]   string  [0..1]  UN CEFACT Common Code for Item Identifier Type that supports UOM.   
Validation Description
Can't enter duplicate Item Identifier Type if the Allow Multiples flag is false.   
Manufacturer is not Active. Please enter an active manufacturer reference.   
Only numeric values are allowed for GTIN.   
Only alphanumeric values are allowed for UPN.   
[type] has to be less than or equal to [length] characters in length   
Alternate Item Identifiers Value is required for non-manufacturer Item Identifier Type.   
Can't have Alternate Item Identifiers Value for Manufacturer Item Identifier Type.   
Enter a valid GTIN   
Item Identifier Type is Inactive.   
You can't specify a unit of measure for item identifier types that aren't unit of measure related.   
Specify a Unit of Measure for item identifier types that are unit of measure related.   
Enter only 1 alternate identifier for the same identifier type, value, and unit of measure combination.   
top
 

Item_Identifier_TypeObject

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

Item_Identifier_TypeObjectID

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

Unit_of_MeasureObject

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

Unit_of_MeasureObjectID

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

Purchase_ItemObject

part of: Catalog_Load_Item__HV__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
 

Item_TagObject

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

Item_TagObjectID

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

Primary_Image_Data

part of: Catalog_Load_Item__HV__Data
Primary Image for Item
 
Parameter name Type/Value Cardinality Description Validations
Image_Reference  ImageObject  [0..1]  Image reference if it is an existing image   
Image_Data  Image_Data  [0..1]  Image Data associated with Image   
top
 

ImageObject

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

ImageObjectID

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

Image_Data

part of: Primary_Image_Data, Additional_Image_Data
Image Data
 
Parameter name Type/Value Cardinality Description Validations
Filename  string (255)   [1..1]  Filename of Image   
File  base64Binary  [0..1]  File associated with Image   
top
 

Additional_Image_Data

part of: Catalog_Load_Item__HV__Data
Additional Image for Item
 
Parameter name Type/Value Cardinality Description Validations
Image_Reference  ImageObject  [0..1]  Image reference if it is an existing image   
Image_Data  Image_Data  [0..1]  Image Data associated with Image   
top
 

Catalog_Load_Item_Unit_of_Measure_Data

part of: Catalog_Load_Item__HV__Data
Element used to capture multiple Units of Measure for a Catalog Load Item
 
Parameter name Type/Value Cardinality Description Validations
Catalog_Load_Item_UOM_Reference  Catalog_Load_Item_Unit_of_MeasureObject  [0..1]  Catalog Load Item Unit of Measure Instance. Only applicable when invoked via Get Catalog Loads Web Service operation.   
Unit_of_Measure_Reference [Choice]   Unit_of_MeasureObject  [1..1]  Unit of Measure Reference for the Catalog Load Item.   
UN_CEFACT_UOM_Code [Choice]   string  [1..1]  UN CEFACT Common Code for Catalog Load Item.   
Item_Unit_Price  decimal (26, 6)   [0..1]  Unit Price.   
Conversion_Factor  decimal (21, 9) >0   [0..1]  Conversion Factor between the Ordering Unit of Measure and the Base Unit of Measure of Catalog Load Item.   
Default  boolean  [0..1]  Indicates whether this Unit of Measure is the default UOM.   
Just_In_Time  boolean  [0..1]  Indicates whether the Unit Of Measure is applicable for Just In Time.   
Lead_Time  decimal (12, 0) >0   [0..1]  Lead time for the UOM of the Catalog Item.   
Minimum_Order_Quantity  decimal (22, 2) >0   [0..1]  The minimum quantity per unit of measure for Item. A value of zero means that there is no minimum order quantity. 
Validation Description
You cannot set Minimum Order Quantity for Just in Time items.   
 
Inactive  boolean  [0..1]  Indicates whether the Unit of Measure is inactive. 
Validation Description
A default Unit of Measure cannot be marked inactive.   
 
Validation Description
Provide a valid UN CEFACT UOM Code.   
top
 

Catalog_Load_Item_Unit_of_MeasureObject

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

Catalog_Load_Item_Unit_of_MeasureObjectID

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

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

InstanceObject

part of: Put_Import_Process_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Abstract_Procurement_CatalogReferenceEnumeration

part of: Abstract_Procurement_CatalogObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top
 

Item_Identifier_TypeReferenceEnumeration

part of: Item_Identifier_TypeObjectID
Base Type
string
top
 

ManufacturerReferenceEnumeration

part of: ManufacturerObjectID
Base Type
string
top
 

Unit_of_MeasureReferenceEnumeration

part of: Unit_of_MeasureObjectID
Base Type
string
top
 

Purchase_ItemReferenceEnumeration

part of: Purchase_ItemObjectID
Base Type
string
top
 

Item_TagReferenceEnumeration

part of: Item_TagObjectID
Base Type
string
top
 

ImageReferenceEnumeration

part of: ImageObjectID
Base Type
string
top
 

Catalog_Load_Item_Unit_of_MeasureReferenceEnumeration

part of: Catalog_Load_Item_Unit_of_MeasureObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top