Show full documentation

 Show full documentation

Definition

An interface to manage competitor products from a source system or file.

Business Context and Use

The web service interface Manage Competitor Material In enables you to connect external applications to your solution, and to create and edit competitor products in your system. This web service interface is relevant if your company wants to access and manage business partner data from external applications.

The web service interface Manage Competitor Material In offers the operations MaintainBundle and CheckMaintainBundle.

Here’s a simple web service request that creates competitor product for the competitor business partner 1001195:

<n0:MaterialBundleMaintainCompRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <CompetitorMaterial actionCode="01" CompetitorInfoCTI="true">
  <BaseMeasureUnitCode>EA</BaseMeasureUnitCode>
  <CompetitorMaterialInfo>
   <CompetitorID>1001195</CompetitorID>
   <ProductDescription>Test_Comp</ProductDescription>
   <NetUnitPrice>
    <Amount currencyCode="INR">10</Amount>
    <BaseQuantity>5</BaseQuantity>
    <BaseQuantityTypeCode>EA</BaseQuantityTypeCode>
   </NetUnitPrice>
  </CompetitorMaterialInfo>
  <OwnProduct/>
 </CompetitorMaterial>
</n0:MaterialBundleMaintainCompRequest>

The following response returns the InternalID and UUID of the created competitor product:

<n0:MaterialBundleMaintainCompConfirmation xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QXP:/1SAI/TAS834F81B93EE6F38C9AFF:804">
 <Material>
  <ReferenceObjectNodeSenderTechnicalID> </ReferenceObjectNodeSenderTechnicalID>
  <ChangeStateID>20140324103754.2261720</ChangeStateID>
  <InternalID>0000000000000000000000000000000010000063</InternalID>
  <UUID>00163e05-f1ab-1ed3-ace8-0b609a87931c</UUID>
 </Material>
 <Log/>
</n0:MaterialBundleMaintainCompConfirmation>

Prerequisites

The following business documents are only referenced and will not be created by the service operations. They must already exist in the system at the time the web service is called:

• Competitors

• Materials

More Information

General Information

You can find general information about web services, their structure and documentation in the web service documentation.

Scenarios

Possible scenarios include the following:

• Create Competitor Products

Operation MaintainBundle is used to create competitor products.

• Update Competitor Products

Operation MaintainBundle is used to update existing competitor products.

Sample xml below will update the already existing competitor product with text collection details.

<n0:MaterialBundleMaintainCompRequest xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
 </BasicMessageHeader>
 <CompetitorMaterial actionCode="06" CompetitorInfoCTI="true">
<!-- <ObjectNodeSenderTechnicalID>00163E05-F1AB-1ED3-ACE8-0B609A87B31C</ObjectNodeSenderTechnicalID>-->
   <ID>10000063</ID>
  <UUID>00163E05-F1AB-1ED3-ACE8-0B609A87931C</UUID>
  <BaseMeasureUnitCode>EA</BaseMeasureUnitCode>
  <CompetitorMaterialInfo>
   <CompetitorID>1001195</CompetitorID>
   <ProductDescription>Test_Comp</ProductDescription>
   <NetUnitPrice>
    <Amount currencyCode="INR">10</Amount>
    <BaseQuantity>5</BaseQuantity>
    <BaseQuantityTypeCode>EA</BaseQuantityTypeCode>
   </NetUnitPrice>
  </CompetitorMaterialInfo>
  <OwnProduct/>
  <TextCollection actionCode="04">
   <ContentText languageCode="EN">Test</ContentText>
  </TextCollection>
 </CompetitorMaterial>
</n0:MaterialBundleMaintainCompRequest>

 Show full documentation

 Show full documentation

Definition

To create and update competitor product master data.

Business Context and Use

The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a COMP_MATERIAL node element that contains the competitor product data to be created or updated. The detailed structure of the COMP_MATERIAL node will be explained in the following sub-chapters. The COMP_MATERIAL node can occur multiple times in the request message, meaning that there can be multiple competitor products created and updated by a single web service request.

The response message of the operation MaintainBundle contains log items, processing information, and a COMP_MATERIAL specific message node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as Competitor Product InternalID and UUID.

Structure

The COMP_MATERIAL node element contains all basic information such as INTERNAL ID, COMPETITOR_INFO, _OWN_PRODUCT. These fields can be found in the New Competitor Product UI dialog box under the workcenter Competitor. The InternalID element corresponds to the ID on the user interface - the UUID element is not visible on the UI, but can be retrieved via query and read web services.

Fields that are shared between several processes are also found on this level, for example, the InventoryValuationMeasureUnitCode, which is used in the logistics and financials processes.

Note: The UUID is read-only and cannot be set by an external application when creating competitor product. The association to Competitor_Info and Own Product will be enabled only after the COMP_PROD_IND is set to true at the root.

Competitor Material Info

Information about the competitor product and description can be maintained with the Competitor Info node element.

  <CompetitorMaterialInfo>
   <CompetitorID>1001195</CompetitorID>
   <ProductDescription>CompProductTest</ProductDescription>
   <BestSellerIndicator/>
   <NetUnitPrice>
    <Amount currencyCode='EUR'>100</Amount>
    <BaseQuantity>5</BaseQuantity>
    <BaseQuantityTypeCode>'EA'</BaseQuantityTypeCode>
   </NetUnitPrice>
  </CompetitorMaterialInfo>

Own Product

This node contains the elements Product Key and Competitor Product Evaluation result code. The evaluation result codes can take any one of the following values:

COMP_PROD_EVAL_RES_CODE	Description
1	Worse than ours
2	Better than ours
3	Same as ours

  <OwnProduct>
   <ProductKey>
    <ProductTypeCode>1</ProductTypeCode>
    <ProductIdentifierTypeCode>1</ProductIdentifierTypeCode>
    <ProductID>MDECC-DS02</ProductID>
   </ProductKey>
  </OwnProduct>

Attachment Folder

The AttachmentFolder node element can be used to add and remove competitor product attachments.

Data for this node can be found on the New Competitor Product UI dialog box as Attachments. On the user interface, Files and Links can be created. In the web service request, links and files are differentiated through the CategoryCode:

Category code	Description
1	Folder
2	Document
3	Link

The different types of attachments are differentiated by the TypeCode:

Type code	Description
10001	Standard Attachment
10011	Product Image
10015	Technical Drawing
10018	Product Specification
10043	Details for Supplier

Example

<AttachmentFolder ActionCode="04">
<Document ActionCode="04">
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>3</CategoryCode>
<TypeCode>10001</TypeCode>
<Name>SAP AG Link</Name>
<ExternalLinkWebURI>http://www.sap.com</ExternalLinkWebURI>
<AlternativeName>SAP AG URL</AlternativeName>
<Description languageCode="EN">A hyperlink to SAP AG</Description>
</Document>
</AttachmentFolder>

 Show full documentation

 Show full documentation

Definition

To check if competitor product can be created and updated without errors.

Business Context and Use

The web service request and response message types of the CheckMaintainBundle operation are the same as those of the MaintainBundle operation.

The explanations given are, therefore, applicable for CheckMaintainBundle operation.