Customer Administration - Output Parameters

TagData TypeDescriptionRequiredComments
ResultXMLThis function will generate XML document as result of the performed actionsYesResult is always generated

XML definition

Element NameData TypeDescriptionRequiredComments
Result Y
StatusString(10)OK if passed values are verified and all sent customers successfully passed requested action, otherwise NOKY
MessageString (500)Message generated by CPQY
Errors NIf any error occurs this node will contain info about it.
Error Y
ErrorCodeString(50)Error codeY
DescriptionString(500)Error description messageY
CustomerString(1000)Xml containing all data for Customer that caused an errorY

Result XML Examples

Example for the successful customer creation

<?xml version="1.0" encoding="utf-8"?>
<Result>
  <Status>OK</Status>
  <Message>All Customers added</Message>
</Result>


Example for the missing id and ExternalId

<?xml version="1.0" encoding="utf-8"?>
<Result>
  <Status>NOK</Status>
  <Message>Update failed</Message>
  <Errors>
    <Error>
            <ErrorCode>xxxxxxx</ErrorCode>
            <Description>More than one customer found with provided search values</Description>
<Customer>
                        <Id></Id>
                        <ExternalId></ExternalId>
                        <FirstName>Tomas</FirstName>
                        <LastName>Johanson</LastName>
                        <Company>Procter &amp; Gamble Company, The</Company>
            <CustomerType></CustomerType>
                        <Address1>Procter &amp; Gamble Plaza</Address1>
                        <Address2></Address2>
                        <City>Cincinnati</City>
                        <Province></Province>
                        <StateAbbrev>OH</StateAbbrev>
                        <ZipCode>45402</ZipCode>
                        <CountryAbbrev>US</CountryAbbrev>
                        <TerritoryName></TerritoryName>
                        <BusinessPhone>(513) 698-6421</BusinessPhone>
                        <BusinessFax>(513) 983-4381</BusinessFax>
                        <EMail></EMail>
<OwnerID></OwnerID>
                        <OwnerUserName></OwnerUserName>
                        <CRMAccountId>0036000000332fg</CRMAccountId>
                        <CRMContactId>0016000000F3432</CRMContactId>
            </Customer>
    </Error>
<Error>
            <ErrorCode>yyyyyyy</ErrorCode>
            <Description>No Customer found with provided search values.</Description>
<Customer>
                        <Id>23</Id>
                        <ExternalId></ExternalId>
                        <FirstName>Mark</FirstName>
                        <LastName>Huges</LastName>
                        <Company>Procter &amp; Gamble Company, The</Company>
                        <CustomerType></CustomerType>
                        <Address1>Procter &amp; Gamble Plaza</Address1>
                        <Address2></Address2>
                        <City>Cincinnati</City>
                        <Province></Province>
                        <StateAbbrev>OH</StateAbbrev>
                        <ZipCode>45402</ZipCode>
                        <CountryAbbrev>US</CountryAbbrev>
                        <TerritoryName></TerritoryName>
                        <BusinessPhone>(513) 698-6421</BusinessPhone>
                        <BusinessFax>(513) 983-4381</BusinessFax>
                        <EMail></EMail>
                        <OwnerID></OwnerID>
                        <OwnerUserName></OwnerUserName>
                        <CRMAccountId>0036000000332fg</CRMAccountId>
                        <CRMContactId>0016000000F3432</CRMContactId>
            </Customer>
    </Error>   
  </Errors>
</Result>
You are here: SAP Sales Cloud CPQ Online HelpSAP CPQ APICustomer Administration Web MethodCustomer Administration - Output Parameters