Item Version 2

Logical Business Objects

SCM : Product Model : Item

Relationships

The following table describes how this service data object is related to other service data objects or business object services.

Relationship Type	Object or Service
Handles	Item Extensible Flexfield
Handles	Item Global Descriptive Flexfield
Handles	Item Catalog Category Version 2
Handles	Item Revision Descriptive Flexfield
Handles	Item Revision Version 2
Handles	Item Attachments
Handles	Item SDO Version 2
Handles	Revision Attachments
Handles	Item Supplier Version 2
Handles	Item Revision Extensible Flexfield
Handles	Item Translation
Handles	Item Descriptive Flexfield
Handles	Item Revision Translation Version 2
Handles	Item Supplier Extensible FlexField

Operations

deleteItem
getItemVersions
releaseVersionItem
cancelVersionItem
deleteItemCategoryAssociation
deleteSupplierSiteAssociation
getItemForSpokeSystemCrossReference
deleteSupplierSiteAssociationMultiRowExtensibleFlexfields
deleteItemMultiRowExtensibleFlexfields
deleteItemRevisionMultiRowExtensibleFlexfields
createItem
updateItem
mergeItem
findItem
processItem

deleteItem

A delete service operation for the Item entity that adds the Item to the delete group. The delete item operation will delete item, item EFFs, item DFFs, item suppliers associations, item organizations associations, item revisions, item revision details, item versions and item version details.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
itemId	long	An unique identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.
orgId	long	An unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
itemNumber	string	An attribute that is an identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.
deleteGroupName	string	An attribute value for the delete group which the structure will be added to.

Response Payload

Element Name	Type	Description
result	string	The primary key (DeleteEntitySequenceId) output that is returned from the create deleteEnity operation. Errors that are generated will be displayed.

getItemVersions

A get service operation that will return item versions based on the parameters passed. The draft version will also be returned.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
itemNumber	string	An unique identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.
organizationCode	string	An unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
itemRevision	string	A revision represents a modification to an item's definition such that the item's form, fit and function do not change. An Item can have multiple revisions created for it however only one revision is effective at any given time.
version	string	An attribute that represents a variation of an item for purposes of audit and making future effective changes.
effectiveDateTime	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	A date from which the user wants to get version data from. This parameter is optional and is to be supplied if user wants to query the version effectivity on the given date. Another usage is when user is trying to query the unmodified draft. i.e. If user queries unmodified draft ( using appropriate itemnumber, organizationcode, itemrevision and versionlabel = "Draft" ), user need to provide the effectiveDateandTime parameter also since unmodified draft is not yet associated with the planned effectivity date which is mandatory for querying the version data.

Response Payload

Element Name	Type	Description
result	Item Version 2	The output that returns the list of Item SDOs for all or selected item versions or item record corresponding to the versioned based on the parameters passed

releaseVersionItem

An operation that release or remove the version for the item revision specified in the parameters.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
versionId	long	An unique value for a variation of an item for purposes of audit and making future effective changes.
itemNumber	string	An unique identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.
organizationCode	string	An unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
itemRevision	string	A revision represents a modification to an item's definition such that the item's form, fit and function do not change. An Item can have multiple revisions created for it however only one revision is effective at any given time.
newRevision	string	The new revision that represents a modification to an item's definition such that the item's form, fit and function do not change. An Item can have multiple revisions created for it however only one revision is effective at any given time.
versionLabel	string	An attribute that represents a variation of an item for purposes of audit and making future effective changes.
versionDescription	string	An attribute that represents a description for a version of an item revision.
plannedEffectiveDateAndTime	{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp	Effective date planned when user begins version edit

Response Payload

Element Name	Type	Description
result	Item Version 2	The output that is returned from this operation is an Item Service Data Objects to which is released.

cancelVersionItem

An operation for the Item version that cancel the scheduled or pending item version provided in the parameters and the previous version will continue to be effective during the effective period of the cancel version.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
versionId	long	An unique value for a variation of an item for purposes of audit and making future effective changes.
itemNumber	string	An unique identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.
organizationCode	string	An unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
itemRevision	string	A revision represents a modification to an item's definition such that the item's form, fit and function do not change. An Item can have multiple revisions created for it however only one revision is effective at any given time.
version	string	An attribute that represents a variation of an item for purposes of audit and making future effective changes.

Response Payload

Element Name	Type	Description
result	Item Version 2	The output that is returned from this operation is an Item Service Data Objects to which is canceled.

deleteItemCategoryAssociation

A delete service operation for the Item Category entity.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
itemCategoryAssignmentId	long	An unique value that represents the assignment of an item to a category.

Response Payload

Element Name	Type	Description
result	string	The output that is returned if an item category association is deleted is Success, otherwise an error message is returned.

deleteSupplierSiteAssociation

Adds the item Association to be deleted to a delete group

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
associationId	long	An unique value indicating the item supplier association.
deleteGroupName	string	An attribute value representing the Delete Group Name, to which Item Associationg will be added.

Response Payload

Element Name	Type	Description
result	string	The output that is returned if an association is added to a delete group is Success, otherwise an error message is returned.

getItemForSpokeSystemCrossReference

A service operation to get Item, to which given source system cross reference is associated.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
sourceSystemId	long	An unique indentifier for the system or applications instance which is the source of the collected data.
sourceSystem	string	An attribute value for the system or applications instance which is the source of the collected data.
crossReference	string	An attribute value that represents the Item Cross-reference name.
organizationId	long	An unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.

Response Payload

Element Name	Type	Description
result	Item Version 2	The output that is returned from this operation is an Item Service Data Objects to which cross reference is associated.

deleteSupplierSiteAssociationMultiRowExtensibleFlexfields

A delete service operation for the extensible flexfields for the Item Supplier Site entity. In cases of specific rules, the multi-Row extensible flexfields may be added to change order or may created a version for versioned items.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
associationId	long	An unique value indicating the item supplier association.
extensibleFlexFieldLineId	long	Unique identifier for extensible flex filed row
contextCode	string	Extensible flex filed context code

Response Payload

Element Name	Type	Description
result	string	The output that is returned if a multi-row extensible attribute of a supplier association is deleted is Success, otherwise an error message is returned.

deleteItemMultiRowExtensibleFlexfields

A delete service operation for the extensible flexfields for the Item entity.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
itemId	long	An object that can be transacted, such as a physical product or service offering.
orgId	long	An unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
extensibleFlexFieldLineId	long	Unique identifier for extensible flex filed row
contextCode	string	Extensible flex filed context code

Response Payload

Element Name	Type	Description
result	string	The output that is returned if a multi-row extensible attribute of an item is deleted is Success, otherwise an error message is returned.

deleteItemRevisionMultiRowExtensibleFlexfields

A delete service operation for the extensible flexfields for the Item Revsion entity.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
itemId	long	An object that can be transacted, such as a physical product or service offering.
orgId	long	An unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
itemRevision	string	A revision represents a modification to an item's definition such that the item's form, fit and function do not change. An Item can have multiple revisions created for it however only one revision is effective at any given time.
extensibleFlexFieldLineId	long	Unique identifier for extensible flex filed row
contextCode	string	Extensible flex filed context code

Response Payload

Element Name	Type	Description
result	string	The output that is returned if a multi-row extensible attribute of an item revision is deleted is Success, otherwise an error message is returned.

createItem

The service operation is to create the entry for a single Item object. The create item operation will create standard items, Style Item, SKU Items and Versioned items, Item Organization assignment, item EFFs, item DFFs, item suppliers associations, item organizations associations, item revisions, item revision details, item versions and item version details. New Item Request will be supported for one new item request per item and adding item to an existing new item request is not supported. In addition adding item to a new item request for items created in an item class that does not require new item requests is not supported.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
item	Item Version 2	An object that can be transacted, such as a physical product or service offering.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/apps/scm/productModel/items/itemServiceV2/}ItemResult	The output that is returned from the create operation consisting of the Item service data object that is created.

updateItem

An update service operation for a single standard items, Style Item, SKU Items and Versioned item. The update item operation will update item, item EFFs, item DFFs, item suppliers associations, item organizations associations, item revisions, item revision details, item versions and item version details. Change Orders will be supported for one change order per item. Adding item to an existing change order and adding item to a change order for a rule that does not require approval are not supported. In addition the update of a version draft item is supported.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
item	Item Version 2	An object that can be transacted, such as a physical product or service offering.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/apps/scm/productModel/items/itemServiceV2/}ItemResult	The output that is returned from the update operation consisting of the Item data object that is updated.

mergeItem

An merge service operation for a single Item object. If the entity exists it will be updated, otherwise a new entity will be created. The merge item operation will merge item, item EFFs, item DFFs, item suppliers associations, item organizations associations, item category associations item revisions, item revision details, item versions and item version details.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
item	Item Version 2	An object that can be transacted, such as a physical product or service offering.

Response Payload

Element Name	Type	Description
result	{http://xmlns.oracle.com/apps/scm/productModel/items/itemServiceV2/}ItemResult	The output that is returned from the merge operation consisting of the Item service data object that is merged.

findItem

A find service operation for the item entity. The find item operation will return item, item EFFs, item DFFs, item suppliers associations, item organizations associations, item revisions, item revision details, item versions and item version details.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	An attribute that represents the search criteria for the find operation. This parameter value is null initially, the user must add the attribute from the service data object.
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	This parameter value is null and is not used currently.

Response Payload

Element Name	Type	Description
result	Item Version 2	The output that is returned from the find operation is a list of objects that match the find criteria.

processItem

The bulk load service operation for Item objects. A list of Item Objects is processed by the operation. The process item operation will process item, item EFFs, item DFFs, item suppliers associations, item organizations associations, item revisions, item revision details, item versions and item version details. The processItems operation will handle creation and updates, but does not support delete transactions.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
changeOperation	string	An attribute that indicates the action that will be performed in the process operation. The actions include Create, Update, Merge or Delete.
item	Item Version 2	An object that can be transacted, such as a physical product or service offering. A list of tem Service Data Objects that will be processed by the operation.
processControl	{http://xmlns.oracle.com/adf/svc/types/}ProcessControl	An attribute that controls the bulk upload behavior for the Item object. For example, controls if valid data will be committed if there are other invalid data in the same batch and controls if the return will contain only key attributes or full objects.

Response Payload

Element Name	Type	Description
result	Item Version 2	The output that is returned from the process operation is a list of Item Service Data Objects that are sucessfully processed.

Security

The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.

Service Operations to Privileges Mapping

Operation Name	Privilege Code	Privilege Name	Privilege Description
All Operations	EGP_MANAGE_TRADING_PARTNER_ITEM_REFERENCE_PRIV	Manage Trading Partner Item Reference	Allows access to manage trading partner item references for items.
All Operations	EGP_MANAGE_ITEM_PRIV	Manage Item	Allows access to browse items.

Privileges to Duty Roles Mapping

Privilege Code	Granted to Duty Role Code	Granted to Duty Role Name	Granted To Duty Role Description
EGP_MANAGE_ITEM_PRIV	ORA_ATC_OFFER_CATALOG_ITEM_MANAGEMENT_FSCM	Offer Catalog Item Management	Creates and manages items and item related information for offer catalog in Product Hub
EGP_MANAGE_ITEM_PRIV	ORA_EGP_ITEM_MANAGEMENT_DUTY	Item Management	Creates and manages items including item attributes, item structures, packs, associations, relationships, and catalog assignments.
EGP_MANAGE_ITEM_PRIV	ORA_PO_PROCUREMENT_INTEGRATION_SPECIALIST_JOB	Procurement Integration Specialist	Individual responsible for planning, coordinating, and supervising all activities related to the integration of procurement information systems.
EGP_MANAGE_TRADING_PARTNER_ITEM_REFERENCE_PRIV	ORA_POS_SUPPLIER_DEMAND_PLANNER_JOB	Supplier Demand Planner	Manages supplier scheduling, supplier managed inventory and consigned inventory for the supplier company.
EGP_MANAGE_TRADING_PARTNER_ITEM_REFERENCE_PRIV	ORA_EGP_ITEM_MANAGEMENT_DUTY	Item Management	Creates and manages items including item attributes, item structures, packs, associations, relationships, and catalog assignments.
EGP_MANAGE_TRADING_PARTNER_ITEM_REFERENCE_PRIV	ORA_EGP_ITEM_INQUIRY_DUTY	Item Inquiry	Queries and views items in the enterprise.
EGP_MANAGE_TRADING_PARTNER_ITEM_REFERENCE_PRIV	ORA_POS_SUPPLIER_ACCOUNTS_RECEIVABLE_SPECIALIST_JOB	Supplier Accounts Receivable Specialist	Manages invoices and payments for the supplier company. Primary tasks include submitting invoices as well as tracking invoice and payment status.
EGP_MANAGE_TRADING_PARTNER_ITEM_REFERENCE_PRIV	ORA_POS_SUPPLIER_SALES_REPRESENTATIVE_JOB	Supplier Sales Representative	Manages agreements and deliverables for the supplier company. Primary tasks include acknowledging or requesting changes to agreements in addition to adding catalog line items with customer specific pricing and terms. Updates contract deliverables that are assigned to the supplier party and updates progress on contract deliverables for which the supplier is responsible.

Duty Roles to Duty or Job Roles Mapping

Duty Role Code	Granted to Duty or Job Role Code	Granted to Duty or Job Role Name	Granted To Duty or Job Role Description
ORA_PO_PROCUREMENT_INTEGRATION_SPECIALIST_JOB	ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY	FSCM Load Interface Administration	Manages load interface file for import
ORA_POS_SUPPLIER_SALES_REPRESENTATIVE_JOB	ORA_OKC_SUPPLIER_CONTRACT_MANAGE_DUTY	Manage Supplier Contracts in Supplier Portal	Manage supplier contracts in the Supplier Portal.
ORA_POS_SUPPLIER_DEMAND_PLANNER_JOB	ORA_OKC_SUPPLIER_CONTRACT_MANAGE_DUTY	Manage Supplier Contracts in Supplier Portal	Manage supplier contracts in the Supplier Portal.
ORA_POS_SUPPLIER_ACCOUNTS_RECEIVABLE_SPECIALIST_JOB	ORA_OKC_SUPPLIER_CONTRACT_MANAGE_DUTY	Manage Supplier Contracts in Supplier Portal	Manage supplier contracts in the Supplier Portal.
ORA_POS_SUPPLIER_ACCOUNTS_RECEIVABLE_SPECIALIST_JOB	ORA_IBY_PAYEE_BANK_ACCOUNT_MANAGEMENT_DUTY	Payee Bank Account Management	Manages supplier bank accounts and other payment details.
ORA_POS_SUPPLIER_SALES_REPRESENTATIVE_JOB	ORA_PO_BPA_CPA_CHG_AS_SUPPLIER_DUTY	Purchase Agreement Management as Supplier	Perform purchase agreement change management tasks as a supplier.
ORA_POS_SUPPLIER_SALES_REPRESENTATIVE_JOB	ORA_PO_PO_CHGS_AS_SUPPLIER_DUTY	Purchase Order Management as Supplier	Perform purchase order change management tasks as a supplier.
ORA_POS_SUPPLIER_ACCOUNTS_RECEIVABLE_SPECIALIST_JOB	ORA_AP_SELF_SERVICE_PAYABLES_INVOICE_ENTRY_DUTY	Self Service Payables Invoice Entry	Enters invoices using self-service functionality.
ORA_POS_SUPPLIER_SALES_REPRESENTATIVE_JOB	ORA_PON_SUPPLIER_BIDDER_ABSTRACT	Supplier Bidder	Sales representative from a potential supplier responsible for responding to requests for quote, requests for proposal, requests for information and reverse auctions.
ORA_POS_SUPPLIER_SALES_REPRESENTATIVE_JOB	ORA_CJM_SUPPLIER_CHANNEL_IN_PORTAL_DUTY	Supplier Channel Management in Supplier Portal	Manages supplier programs from the supplier portal.
ORA_POS_SUPPLIER_SALES_REPRESENTATIVE_JOB	ORA_CJM_SUPPLIER_CHANNEL_IN_PORTAL_VIEW_DUTY	Supplier Channel Viewing in Supplier Portal	Views supplier programs from the supplier portal.
ORA_POS_SUPPLIER_ACCOUNTS_RECEIVABLE_SPECIALIST_JOB	ORA_POZ_PROFILE_INQUIRY_AS_SUPPLIER_DUTY	Supplier Profile Inquiry as Supplier	Views non-bank account related supplier profile information as a supplier.
ORA_POS_SUPPLIER_SALES_REPRESENTATIVE_JOB	ORA_POQ_SUPP_QUAL_QUESTIONNAIRE_RESPONSE_MANAGEMENT_AS_SUPPLIER_DUTY	Supplier Qualification Questionnaire Response Management as Supplier	A supplier user can respond to requests for qualification information.