Differences

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

appendixd:additemsdatawebmethod:additemsdatainputparameters [2011/07/11 10:51]
aquandt
appendixd:additemsdatawebmethod:additemsdatainputparameters [2011/07/11 10:51] (current)
Line 1: Line 1:
 +====== Add Items Data - Input Parameters ======
 +
 +^**Tag**^**Data Type**^**Description**^**Required**^**Comments**^
 +|Username|String (20)|Only CPQ users can execute this function. CPQ user is defined in CPQ admin.|Yes|Username of API user|
 +|Password|String (25)|Only CPQ users can execute this function. Password is defined in CPQ admin.|Yes|Password of API user|
 +|OrderID|Number (8)|Order# (8-digit number)|Yes|CPQ System quotation number|
 +|ERPOrderID|String (255)|External System (ERP) Order Number assigned to the CPQ OrderID|No|  |
 +|ItemObjects|XML|Object passing Item(s) Data|Yes|The Items Object XML structure is shown below|
 +
 +===== ItemObjects XML definition =====
 +
 +
 +^**Element Name**^**Data Type**^**Description**^**Required**^**Comments**^
 +|ItemObjects|  |Only CPQ users can execute this function. CPQ user is defined in CPQ admin.|Yes||
 +|ItemObject|  |There will be one ItemObject node for each Item on the order  function. Password is defined in CPQ admin.   |Yes|If Order has 3 Items, there will be 3 <ItemObject> nodes |
 +|ItemID|Number (5)|Order Item Number|Yes||
 +|ItemDetail|String (255)|There will be one ItemDetail node for each qty for the Item   |Yes|If the Item qty is 5, there will be 5 <ItemDetail> nodes |
 +|ItemSequence|Number (8)|Item Sequence Number|Yes|  |
 +|SerialNumberEach|String (255)|(Phantom/SubItem) Serial Number|No|  |
 +|TrackingNumber|String (255)|Tracking Number|No|  |
 +|TrackingURL|String (255)|Tracking URL|No|  |
 +|EstimatedShipDate|Date|Estimated Ship Date|No|  |
 +|ActualShipDate|Date|Actual Ship Date|No|  |
 +|LicenseKeyNumber|String (255)|License Key Assigned to the Item Sequence Level (Phantom/SubItem)  |No|  |
 +|MiscItemDetail01|String (255)|Miscellaneous Data Element for Item Detail level  |No|  |
 +|MiscItemDetail02|String (255)|Miscellaneous Data Element for Item Detail level  |No|  |
 +|MiscItemDetail03|String (255)|Miscellaneous Data Element for Item Detail level  |No|  |
 +|MiscItemDetail04|String (255)|Miscellaneous Data Element for Item Detail level  |No|  |
 +|MiscItemDetail05|String (255)|Miscellaneous Data Element for Item Detail level  |No|  |
 +
 +===== Input XML Example =====
 +
 +<code XML>
 +<ItemObjects>
 +  <ItemObject>
 +    <ItemID>1</ItemID>
 +    <ItemDetail>
 +      <ItemSequence>6845</ItemSequence>
 +      <SerialNumberEach>
 +        WEBKD982</SerialNumber>
 +        <TrackingNumber>1Z0E35F4M375139076</TrackingNumber>
 +        <TrackingURL>
 +          http://wwwapps.ups.com/etracking/tracking.cgi?TypeOfInquiryN
 +  umber=T&AcceptUPSLicenseAgreement=yes&InquiryNumber1=1Z0E35F4M3751
 +          39076
 +        </TrackingURL>
 +        <EstimatedShipDate>02/15/2007</EstimatedShipDate>
 +        <ActualShipDate>02/12/2007</ActualShipDate>
 +        <LicenseKeyNumber>
 +          ABC-333-DEF-4546YUZ
 +        </LicenseKeyNumber>
 +      </ItemDetail>
 +    <ItemDetail>
 +      <ItemSequence>0240</ItemSequence>
 +      <SerialNumberEach>
 +        UIE65432</SerialNumber>
 +        <TrackingNumber>1Z0E35F4M37763189076</TrackingNumber>
 +        <TrackingURL>
 +          http://wwwapps.ups.com/etracking/tracking.cgi?TypeOfInquiryN
 +  umber=T&AcceptUPSLicenseAgreement=yes&InquiryNumber1=1Z0E35F4M3776
 +          3189076
 +        </TrackingURL>
 +        <EstimatedShipDate> 02/15/2007</EstimatedShipDate>
 +        <ActualShipDate>02/12/2007</ActualShipDate>
 +        <LicenseKeyNumber></LicenseKeyNumber>
 +      </ItemDetail>
 +  </ItemObject>
 +  <ItemObject>
 +    <ItemID>2</ItemID<ItemDetail>
 +      <ItemSequence>0320</ItemSequence>
 +      <SerialNumberEach>
 +        WER56432</SerialNumber>
 +        <TrackingNumber>1Z0E35F4M39433489076</TrackingNumber>
 +        <TrackingURL>
 +          http://wwwapps.ups.com/etracking/tracking.cgi?TypeOfInquiryN
 +  umber=T&AcceptUPSLicenseAgreement=yes&InquiryNumber1=1Z0E35F4M3943
 +          3489076
 +        </TrackingURL>
 +        <EstimatedShipDate>01/29/2007</EstimatedShipDate>
 +        <ActualShipDate>02/26/2007</ActualShipDate>
 +        <LicenseKeyNumber> </LicenseKeyNumber>
 +      </ItemDetail>
 +  </ItemObject>
 +</ItemObjects>
 +</code>
 +
  
You are here: SAP Sales Cloud CPQ Online HelpSAP CPQ APIAdd Items Data Web MethodAdd Items Data - Input Parameters