Differences

This shows you the differences between two versions of the page.

appendixd:simple_product_administration:product_admin_webmethod [2015/10/01 08:33]
vovanin
appendixd:simple_product_administration:product_admin_webmethod [2018/11/30 02:52] (current)
bdjordje
Line 9: Line 9:
 4. Add/Update/Delete product data in multiple languages\\ 4. Add/Update/Delete product data in multiple languages\\
  
-The Simple Product Administration CPQ API can maintain simple products in CPQ, and it’s capable of creating/updating configurable products to some extent.  +The Simple Product Administration SAP CPQ API can maintain simple products in SAP CPQ, and it’s capable of creating/updating configurable products to some extent.  
-Note that the current CPQ API does not permit the creation of more complex configurable products.+Note that the current SAP CPQ API does not permit the creation of more complex configurable products.
  
-The following use cases must be supported when using the ProductAdministration API to create and update products in CPQ. Note that you can view Product Administration Input XML Examples [[http://help.webcomcpq.com/doku.php?id=appendixd:simple_product_administration:product_admin_webmethod_inputxml|here.]] +The following use cases must be supported when using the ProductAdministration API to create and update products in SAP CPQ. Note that you can view Product Administration Input XML Examples [[http://help.webcomcpq.com/doku.php?id=appendixd:simple_product_administration:product_admin_webmethod_inputxml|here.]] 
  
  
Line 45: Line 45:
 //Figure 2 - Product Name// //Figure 2 - Product Name//
  
-Product System ID supports all values, there is no restriction. It is used as an object identification when migrating objects from Sandbox to Production environment.If you use an existing System ID, CPQ will return the following message: "Product with the same System ID already exist in the system. Please specify different Product System ID"+Product System ID supports all values, there is no restriction. It is used as an object identification when migrating objects from Sandbox to Production environment. If you use an existing System ID, SAP CPQ will return the following message: "Product with the same System ID already exist in the system. Please specify different Product System ID"
  
 The node is optional - if the node is not present in input XML or it is left vacant, the system will move on without crashing or returning error messages.  The node is optional - if the node is not present in input XML or it is left vacant, the system will move on without crashing or returning error messages. 
Line 53: Line 53:
      * If it contains PartNumber, the product will be searched based on the provided part number provided in the <PartNumber> node.       * If it contains PartNumber, the product will be searched based on the provided part number provided in the <PartNumber> node. 
      * If it contains “ProductName,” the product will be searched based on the provided product name (provided in node <ProductName>).       * If it contains “ProductName,” the product will be searched based on the provided product name (provided in node <ProductName>). 
-     * If it contains any other field, the product will be searched by the CPQ ID provided in node <CPQProductID>.+     * If it contains any other field, the product will be searched by the SAP CPQ ID provided in node <CPQProductID>.
  
 Note that the <Identificator> can also contain the “PricingCode” which should be used in combination with the “PartNumber.”  In <Indentificator> node we should use PriceCode, and to pass the pricing code value we should use node <PricingCode> It should look as follows: Note that the <Identificator> can also contain the “PricingCode” which should be used in combination with the “PartNumber.”  In <Indentificator> node we should use PriceCode, and to pass the pricing code value we should use node <PricingCode> It should look as follows:
Line 72: Line 72:
 </code> </code>
  
-Performing search with the <Identificator> node can return more than one product, so multiple products can be updated with the same data. +Performing search with the <Identificator> node can return more than one product, so multiple products can be updated with the same data. 
  
-In case you do not define the System ID, CPQ will generate it for you and add _cpq at the end. The best way to identify a product is by using two identificators. +In case you do not define the System ID, SAP CPQ will generate it for you and add _cpq at the end. The best way to identify a product is by using two identificators. 
  
-Product search is performed by whatever the Identification column suggests and, if that fails, search is performed by the CPQProductID (if provided). If no products are found, a new product will be created. +Product search is performed by whatever the Identification column suggests and, if that fails, the search is performed by the CPQProductID (if provided). If no products are found, a new product will be created. 
  
 If the identification node contains “ProductSystemId,” the product will be searched based on the provided Product System ID. If the identification node contains “ProductSystemId,” the product will be searched based on the provided Product System ID.
Line 105: Line 105:
  
      * If the node is not present, or is empty, the system will set User Selection as the attribute type.       * If the node is not present, or is empty, the system will set User Selection as the attribute type. 
-     * The Attribute type container can be created over API call, and the system will be able to add an attribute type container to a product if that attribute already exists within CPQ. When the Container Attribute type is created over API call, this attribute will not have any other property (columns, properties, validation messages) set up over API call.  +     * The Attribute type container can be created over API call, and the system will be able to add an attribute type container to a product if that attribute already exists within SAP CPQ. When the Container Attribute type is created over API call, this attribute will not have any other property (columns, properties, validation messages) set up over API call.  
-     * If a value sent in this node is not supporter, the system will return the following error message: “Value in Node ATTRIBUTE TYPE is not supported.”+     * If a value sent in this node is not supported, the system will return the following error message: “Value in Node ATTRIBUTE TYPE is not supported.”
 ===== Attribute Display Type ===== ===== Attribute Display Type =====
  
Line 141: Line 141:
 //Figure 4 - Measurement Type// //Figure 4 - Measurement Type//
  
-Supported values include Measurement Types previously defined in CPQ. It is not possible to create a new Measurement Type via API call. +Supported values include Measurement Types previously defined in SAP CPQ. It is not possible to create a new Measurement Type via API call. 
  
-     * Note that this node is required if attribute type is Measurement. In case this node is not present when attribute type is Measurement the system will return the following message: "Node UnitOfMeasurement is required."  +     * Note that this node is required if the attribute type is Measurement. In case this node is not present when attribute type is Measurement the system will return the following message: "Node UnitOfMeasurement is required."  
-     * If the value of this node is not supported in CPQ, the system will return the following message: "Measurement type not found in CPQ." +     * If the value of this node is not supported in SAP CPQ, the system will return the following message: "Measurement type not found in SAP CPQ." 
-     * If attribute type is not "UnitsOfMeasurement." and if the node is not present in input XML, the system would move on without crashing or returning error messages. +     * If the attribute type is not "UnitsOfMeasurement." and if the node is not present in input XML, the system would move on without crashing or returning error messages. 
    
 ===== Attribute System ID in Attribute ===== ===== Attribute System ID in Attribute =====
Line 197: Line 197:
 //Figure 8 - Value code// //Figure 8 - Value code//
  
-Supported values include all values. Since this is  an attribute value code, this field should not contain a specific character.+Supported values include all values. Since this is an attribute value code, this field should not contain a specific character.
  
 This node is optional - if the node is not present in input XML, the system will move on without crashing or returning error messages. This node is optional - if the node is not present in input XML, the system will move on without crashing or returning error messages.
Line 267: Line 267:
      * If node is empty in product Update, the system will remove all text present in this field.       * If node is empty in product Update, the system will remove all text present in this field. 
      * This node can be set only if "Line item flag" has value 1. If this node is present for non-line item attributes, the system will return the following message: “Node LINE ITEM DESCRIPTION is not supported for non-line items”      * This node can be set only if "Line item flag" has value 1. If this node is present for non-line item attributes, the system will return the following message: “Node LINE ITEM DESCRIPTION is not supported for non-line items”
-     * If the provided input contains text that is longer than what the system supports, CPQ will return the following message: “Number of characters in Node LINE ITEM DESCRIPTION is out allowed limit”+     * If the provided input contains text that is longer than what the system supports, SAP CPQ will return the following message: “Number of characters in Node LINE ITEM DESCRIPTION is out allowed limit”
        
  
Line 353: Line 353:
      * If the node is not present in input XML, the system will move on without crashing or returning error messages.       * If the node is not present in input XML, the system will move on without crashing or returning error messages. 
      * If the node is empty on product update, the system will remove all text present in this field.       * If the node is empty on product update, the system will remove all text present in this field. 
-     * If the provided input contains text that is longer than the length supported by the system, CPQ will return the following message: “Number of characters in Node LABEL is out allowed limit”+     * If the provided input contains text that is longer than the length supported by the system, SAP CPQ will return the following message: “Number of characters in Node LABEL is out allowed limit”
      
  
Line 383: Line 383:
      * If the node is not present in input XML, the system will move on without crashing or returning error messages.      * If the node is not present in input XML, the system will move on without crashing or returning error messages.
      * If the node is empty on product update the system will remove all text present in this field.      * If the node is empty on product update the system will remove all text present in this field.
-     * If the provided input contains text longer than that supported by the system, CPQ will return the following message: “Number of characters in Node HINT is out allowed limit”+     * If the provided input contains text longer than that supported by the system, SAP CPQ will return the following message: “Number of characters in Node HINT is out allowed limit”
      * If this Node has a value and attribute display type as “Button,” the system will return the following message: Node “HINT” is not supported for display type is “BUTTON”      * If this Node has a value and attribute display type as “Button,” the system will return the following message: Node “HINT” is not supported for display type is “BUTTON”
  
Line 421: Line 421:
       * If the node is not present in input XML, the system will move on without crashing or returning error messages.        * If the node is not present in input XML, the system will move on without crashing or returning error messages. 
       * If a value sent in this node is not supported, the system will return the following error message: “Value in Node SHOW RECURRING PRICES is not supported"       * If a value sent in this node is not supported, the system will return the following error message: “Value in Node SHOW RECURRING PRICES is not supported"
-      * If node is not present, this flag is not selected. +      * If the node is not present, this flag is not selected. 
       * If this node has value and attribute display type as "Button" the following message will appear: Node “SHOW RECURRING PRICES” is not supported for display type is “BUTTON”       * If this node has value and attribute display type as "Button" the following message will appear: Node “SHOW RECURRING PRICES” is not supported for display type is “BUTTON”
  
Line 441: Line 441:
      * If the node is empty on product update, the system will remove all text present in this field.      * If the node is empty on product update, the system will remove all text present in this field.
      * This node can be set only if the attribute display type is "Button." IF this node is present for other attributes' types except "Button," the system will return the following message: “Node BUTTON TEXT is supported for BUTTON attributes only”      * This node can be set only if the attribute display type is "Button." IF this node is present for other attributes' types except "Button," the system will return the following message: “Node BUTTON TEXT is supported for BUTTON attributes only”
-     * If the provided input contains text that is longer than the length supported by the system, CPQ will return the following message: +     * If the provided input contains text that is longer than the length supported by the system, SAP CPQ will return the following message: 
 “Number of characters in Node BUTTON TEXT is out allowed limit” “Number of characters in Node BUTTON TEXT is out allowed limit”
  
Line 488: Line 488:
      * If the node is not present in input XML, the system will move on without crashing or returning error messages.       * If the node is not present in input XML, the system will move on without crashing or returning error messages. 
      * This node can be set only if the ATTACH SCRIPT BUTTON flag has value 1. If this node is present when this flag has value 0, the system will return the following message: “Script in Node BUTTON SCRIPT cannot be attached if ATTACH SCRIPT BUTTON has value 0”      * This node can be set only if the ATTACH SCRIPT BUTTON flag has value 1. If this node is present when this flag has value 0, the system will return the following message: “Script in Node BUTTON SCRIPT cannot be attached if ATTACH SCRIPT BUTTON has value 0”
-     * Note that CPQ does not support adding a new script over API call. Product Administration API can add only those scripts that have already been defined in CPQ.If the provided name for a script does not exist in CPQ, the system will return the following message: “Script Name in node BUTTON SCRIPT ATTACHED/ BUTTON SCRIPT is not found in CPQ”+     * Note that SAP CPQ does not support adding a new script over API call. Product Administration API can add only those scripts that have already been defined in SAP CPQ. If the provided name for a script does not exist in SAP CPQ, the system will return the following message: “Script Name in node BUTTON SCRIPT ATTACHED/ BUTTON SCRIPT is not found in SAP CPQ”
  
 ==== Rank ==== ==== Rank ====
Line 504: Line 504:
 ===== "Is First Value Preselected" in Attribute ===== ===== "Is First Value Preselected" in Attribute =====
  
-As part of standard CPQ behavior, the first value of any attribute is always preselected.+As part of standard SAP CPQ behavior, the first value of any attribute is always preselected.
  
 To override the default settings, add the following child node to <Value> input XML node. The full XPATH should look this way:  To override the default settings, add the following child node to <Value> input XML node. The full XPATH should look this way: 
Line 534: Line 534:
 **Error messages** **Error messages**
  
-     * If the node is not present in input XML, the system would move on without crashing or returning any error messages; no selection will be made as a result. If the product display type is Simple, or if this node has been omitted, the system will keep the current API behavior. In all other cases the system will behave as it has been defined in this document. +     * If the node is not present in input XML, the system would move on without crashing or returning any error messages; no selection will be made as a result. If the product display type is Simple, or if this node has been omitted, the system will keep the current API behavior. In all other casesthe system will behave as it has been defined in this document. 
      * If the node is empty on product update the system will not update this field.       * If the node is empty on product update the system will not update this field. 
      * If a value sent in this node is not support, the system will return the following error message: “Value in Node PRESELECTED is not supported”      * If a value sent in this node is not support, the system will return the following error message: “Value in Node PRESELECTED is not supported”
Line 545: Line 545:
 {{:appendixd:product_administration:display_to_user.png|}}  {{:appendixd:product_administration:display_to_user.png|}} 
  
-     * All value sent within one attribute are set as "Displayed to user."+     * All values sent within one attribute are set as "Displayed to user."
      * Attribute Values omitted from Product XML are not displayed to end users.        * Attribute Values omitted from Product XML are not displayed to end users.  
    
Line 584: Line 584:
  
      * If the node is not present in input XML, the system will return the following error message: “Node SYSTEM ID is required”      * If the node is not present in input XML, the system will return the following error message: “Node SYSTEM ID is required”
-     * If the tab sent from the external system cannot be found in CPQ, the system will create it. The Tab default rank is added by the system, and it is 10. +     * If the tab sent from the external system cannot be found in SAP CPQ, the system will create it. The Tab default rank is added by the system, and it is 10. 
      * On product update, if a certain tab is omitted in product xml of a certain product, that tab will be removed from that product.       * On product update, if a certain tab is omitted in product xml of a certain product, that tab will be removed from that product. 
  
Line 612: Line 612:
 //Products/Product/Tabs/Tab/LayoutTemplate// //Products/Product/Tabs/Tab/LayoutTemplate//
  
-Supported values are string values. This value is the name of the tab's configuration. To set tab layout template over API call, that file must have already been created in CPQ; otherwise the table will not be added to the system. +Supported values are string values. This value is the name of the tab's configuration. To set tab layout template over API call, that file must have already been created in SAP CPQ; otherwise the table will not be added to the system. 
  
 This node is required.  This node is required. 
Line 647: Line 647:
      * If the node is not present in input XML, the system will move on without crashing or returning error messages.      * If the node is not present in input XML, the system will move on without crashing or returning error messages.
      * If the node is empty on product Update, the system will remove all text present in this field.      * If the node is empty on product Update, the system will remove all text present in this field.
-     * If the provided input contains text that is longer than that supported by the system, CPQ system will return the following message: “Number of characters in Node TAB VISIBILITY CONDITION is out allowed limit”+     * If the provided input contains text that is longer than that supported by the system, SAP CPQ system will return the following message: “Number of characters in Node TAB VISIBILITY CONDITION is out allowed limit”
      * This node can be set only if the “Visibility permission” flag has value 2. If this node is present for the remaining 2 possibilities, the system will return the following message:      * This node can be set only if the “Visibility permission” flag has value 2. If this node is present for the remaining 2 possibilities, the system will return the following message:
 “Node TAB VISIBILITY CONDITION is not supported for provided permission type” “Node TAB VISIBILITY CONDITION is not supported for provided permission type”
Line 689: Line 689:
      * If the node is not present in input XML, the system will move on without crashing or returning error messages.      * If the node is not present in input XML, the system will move on without crashing or returning error messages.
      * If a value sent in this node is not supported, the system will return the following error message: “Value in Node TABS/TAB /ATTRIBUTES/ATTRIBUTE/NAME is not supported”      * If a value sent in this node is not supported, the system will return the following error message: “Value in Node TABS/TAB /ATTRIBUTES/ATTRIBUTE/NAME is not supported”
-     * On product update, if certain attribute is omitted in product XML of a certain product (tab logic), that attribute will be removed from the tab of that product. +     * On product update, if certain attribute is omitted in product XML of a certain product (tab logic), that attribute will be removed from the tab of that product. 
  
 __Rank__ __Rank__
Line 746: Line 746:
 **Error messages** **Error messages**
  
-     * If the node is not present in input XML, the system will move on without crashing or returning  error messages.+     * If the node is not present in input XML, the system will move on without crashing or returning error messages.
      * If a value sent in this node is not supported, the system will return the following error message: “Value in Node RESPONDER ATTRIBUTES/ATTRIBUTES/ATTRIBUTE/NAME is not supported”      * If a value sent in this node is not supported, the system will return the following error message: “Value in Node RESPONDER ATTRIBUTES/ATTRIBUTES/ATTRIBUTE/NAME is not supported”
-     * On product update, if a certain attribute  is omitted in product XML of a certain product (responder logic), that attribute will be removed from the responder of that product. +     * On product update, if a certain attribute is omitted in product XML of a certain product (responder logic), that attribute will be removed from the responder of that product. 
 __Rank__ __Rank__
    
Line 836: Line 836:
      * If the node is not present in input XML, the system will move on without crashing or returning error messages.      * If the node is not present in input XML, the system will move on without crashing or returning error messages.
      * If the node is empty on product Update, the system will not add a script.       * If the node is empty on product Update, the system will not add a script. 
-     * If, on product update, a script is omitted form the list of scripts attached to the Button, the system will remove it from the product.  +     * If, on product update, a script is omitted from the list of scripts attached to the Button, the system will remove it from the product.  
-     * CPQ does not support adding new scripts over API call. Product administration API can only add scripts already defined in CPQ.  +     * SAP CPQ does not support adding new scripts over API call. Product administration API can only add scripts already defined in SAP CPQ.  
-     * If the provided script name does not exist in CPQ, the system will return the following message: “Script Name in node GLOBAL SCRIPTS/SCRIPT/NAME is not found in CPQ”+     * If the provided script name does not exist in SAP CPQ, the system will return the following message: “Script Name in node GLOBAL SCRIPTS/SCRIPT/NAME is not found in SAP CPQ”
  
 __2. Rank__ __2. Rank__
You are here: SAP Sales Cloud CPQ Online HelpSAP CPQ APISimple Product Administration Web MethodPRODUCT ADMINISTRATION WEB METHOD