SOAP Parts API with Web Services 1.0

Overview

You can generate a skeleton input for each operation of the parts WSDL, which contains the following operations:

• addParts
• getParts
• updateParts
• modifyParts
• deleteParts

For each operation, there are 3 fields that are always required in the header:

• sessionID
• category: Security
• schemaLocation

Parts SOAP API Details

SOAP API	Description	Required Input Variables	Success Response Variables	Failure Response Variables
addParts	Adds a part. It expects input of all the part details and returns the status whether the part was successfully added or not.	sessionId category schemaLocation part_number	status: success message	exceptionCode exceptionMessage
getParts	Returns the part details of parts which are searched based on the given criteria (one or multiple).	sessionId category schemaLocation field value comparator	status: success message   parts eachRecord part_number	exceptionCode exceptionMessage
updateParts	Update the details of the specified part number. The return specifies whether the operation was successful.	sessionID category schemaLocation part_number	status: success message	exceptionCode exceptionMessage
modifyParts	The "modifyParts" action will insert or update a part based on the part number. The "modifyParts" action will add a new part if the specified part number does not exist in the Oracle CPQ parts data. When the specified part number exists, the existing part is modified.	category schemaLocation part_number	status success message	exceptionCode exceptionMessa
		Update Example <bm:modifyParts xmlns:bm="urn:soap.bigmachines.com"> <bm:Parts> <bm:each_record> <bm:part_number>part186342</bm:part_number> <bm:direct_buy>1</bm:direct_buy> <bm:part_display_number>Part Display 1</bm:part_display_number> <bm:price> <bm:USD>10</bm:USD> </bm:price> </bm:each_record> </bm:Parts> </bm:modifyParts>
		Insert Example <urn:modify> <bm:Parts> <bm:each_record> <bm:part_number>newpart</bm:part_number> <bm:direct_buy>1</bm:direct_buy> <bm:part_display_number>Part Display 1</bm:part_display_number> <bm:price> <bm:USD>1</bm:USD> </bm:price> </bm:each_record> </bm:Parts> </bm:modifyParts>
deleteParts	Deletes a specific part. The part(s) deletes are based on one or more specified criteria.	sessionId category schemaLocation field value comparator	status: success message	exceptionCode exceptionMessage

---

Administration

Accessing User WSDL and Generating Skeleton Input

1. Navigate from Admin Home Page > Integration Platform > Web Services.
2. Click the Parts tab.
3. Select an API from the drop-down menu.
4. Enter a Part Number.
5. Click Generate Input to retrieve the skeleton.

---

Sample Parts APIs

addParts - Input SOAP XML

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header>
    <bm:userInfo xmlns:bm="urn:soap.bigmachines.com">
      <bm:sessionId>BADEA7F1C53874276177D250E729DCA5</bm:sessionId>
    </bm:userInfo>
    <bm:category xmlns:bm="urn:soap.bigmachines.com">Parts</bm:category>
    <bm:xsdInfo xmlns:bm="urn:soap.bigmachines.com">
      <bm:schemaLocation>https://pm.bigmachines.com/bmfsweb/pm/schema/v1_0/parts/Parts.xsd</bm:schemaLocation>
    </bm:xsdInfo>
  </soapenv:Header>
  <soapenv:Body>
    <bm:addParts xmlns:bm="urn:soap.bigmachines.com">
      <bm:Parts>
        <bm:each_record>
          <bm:part_number>RAM-128</bm:part_number>
          <bm:direct_buy>1</bm:direct_buy>
          <bm:description>
            <bm:en>128 GB RAM 1333MHz</bm:en>
            <bm:nl_NL/>
            <bm:de/>
            <bm:ja_JP/>
          </bm:description>
          <bm:units>
            <bm:en/>
            <bm:nl_NL/>
            <bm:de/>
            <bm:ja_JP/>
          </bm:units>
          <bm:lead_time>-1</bm:lead_time>
          <bm:_part_custom_field1>Memory</bm:_part_custom_field1>
          <bm:_part_custom_field2>840</bm:_part_custom_field2>
          <bm:_part_custom_field3>5</bm:_part_custom_field3>
          <bm:_part_custom_field4/>
          <bm:_part_custom_field5>1400.0</bm:_part_custom_field5>
          <bm:_part_custom_field6>0.0</bm:_part_custom_field6>
          <bm:_part_custom_field8>Hardware</bm:_part_custom_field8>
          <bm:partner_part_id/>
          <bm:partner_std_pbook_entry_id/>
          <bm:last_integration_time/>
          <bm:price>
            <bm:USD>1400</bm:USD>
            <bm:EUR>1076</bm:EUR>
            <bm:GBP>904</bm:GBP>
            <bm:AUD>1409</bm:AUD>
            <bm:JPY>109017</bm:JPY>
            <bm:ESP/>
          </bm:price>
        </bm:each_record>
      </bm:Parts>
    </bm:addParts>
  </soapenv:Body>
</soapenv:Envelope>

---

updateParts - Input SOAP XML

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header>
    <bm:userInfo xmlns:bm="urn:soap.bigmachines.com">
      <bm:sessionId>BADEA7F1C53874276177D250E729DCA5</bm:sessionId>
    </bm:userInfo>
    <bm:category xmlns:bm="urn:soap.bigmachines.com">Parts</bm:category>
    <bm:xsdInfo xmlns:bm="urn:soap.bigmachines.com">
      <bm:schemaLocation>https://pm.bigmachines.com/bmfsweb/pm/schema/v1_0/parts/Parts.xsd</bm:schemaLocation>
    </bm:xsdInfo>
  </soapenv:Header>
  <soapenv:Body>
    <bm:updateParts xmlns:bm="urn:soap.bigmachines.com">
      <bm:Parts>
        <bm:each_record>
          <bm:part_number>RAM-128</bm:part_number>
          <bm:direct_buy>1</bm:direct_buy>
          <bm:description>
            <bm:en>128 GB RAM 1333MHz</bm:en>
            <bm:nl_NL/>
            <bm:de/>
            <bm:ja_JP/>
          </bm:description>
          <bm:units>
            <bm:en/>
            <bm:nl_NL/>
            <bm:de/>
            <bm:ja_JP/>
          </bm:units>
          <bm:lead_time>-1</bm:lead_time>
          <bm:_part_custom_field1>Memory</bm:_part_custom_field1>
          <bm:_part_custom_field2>840</bm:_part_custom_field2>
          <bm:_part_custom_field3>5</bm:_part_custom_field3>
          <bm:_part_custom_field4/>
          <bm:_part_custom_field5>1400.0</bm:_part_custom_field5>
          <bm:_part_custom_field6>0.0</bm:_part_custom_field6>
          <bm:_part_custom_field8>Hardware</bm:_part_custom_field8>
          <bm:partner_part_id/>
          <bm:partner_std_pbook_entry_id/>
          <bm:last_integration_time/>
          <bm:price>
            <bm:USD>1400</bm:USD>
            <bm:EUR>1076</bm:EUR>
            <bm:GBP>904</bm:GBP>
            <bm:AUD>1409</bm:AUD>
            <bm:JPY>109017</bm:JPY>
            <bm:ESP/>
          </bm:price>
        </bm:each_record>
      </bm:Parts>
    </bm:updateParts>
  </soapenv:Body>
</soapenv:Envelope>

---

getParts - Input SOAP XML

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header>
    <bm:userInfo xmlns:bm="urn:soap.bigmachines.com">
      <bm:sessionId>BADEA7F1C53874276177D250E729DCA5</bm:sessionId>
    </bm:userInfo>
    <bm:category xmlns:bm="urn:soap.bigmachines.com">Parts</bm:category>
    <bm:xsdInfo xmlns:bm="urn:soap.bigmachines.com">
      <bm:schemaLocation>https://pm.bigmachines.com/bmfsweb/pm/schema/v1_0/parts/Parts.xsd</bm:schemaLocation>
    </bm:xsdInfo>
  </soapenv:Header>
  <soapenv:Body>
    <bm:getParts xmlns:bm="urn:soap.bigmachines.com">
      <bm:Parts>
        <bm:criteria>
          <bm:field>part_number</bm:field>
          <bm:value>RAM-128</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>direct_buy</bm:field>
          <bm:value>1</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>description</bm:field>
          <bm:value>128 GB RAM 1333MHz</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>units</bm:field>
          <bm:value/>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>date_added</bm:field>
          <bm:value>2010-11-23 11:06:24</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>date_modified</bm:field>
          <bm:value>2012-03-24 05:11:45</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>lead_time</bm:field>
          <bm:value>-1</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field1</bm:field>
          <bm:value>Memory</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field2</bm:field>
          <bm:value>840</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field3</bm:field>
          <bm:value>5</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field4</bm:field>
          <bm:value/>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field5</bm:field>
          <bm:value>1400.0</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field6</bm:field>
          <bm:value>0.0</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field8</bm:field>
          <bm:value>Hardware</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>partner_part_id</bm:field>
          <bm:value/>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>partner_std_pbook_entry_id</bm:field>
          <bm:value/>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
      </bm:Parts>
    </bm:getParts>
  </soapenv:Body>
</soapenv:Envelope>

---

deleteParts - Input SOAP XML

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header>
    <bm:userInfo xmlns:bm="urn:soap.bigmachines.com">
      <bm:sessionId>BADEA7F1C53874276177D250E729DCA5</bm:sessionId>
    </bm:userInfo>
    <bm:category xmlns:bm="urn:soap.bigmachines.com">Parts</bm:category>
    <bm:xsdInfo xmlns:bm="urn:soap.bigmachines.com">
      <bm:schemaLocation>https://pm.bigmachines.com/bmfsweb/pm/schema/v1_0/parts/Parts.xsd</bm:schemaLocation>
    </bm:xsdInfo>
  </soapenv:Header>
  <soapenv:Body>
    <bm:deleteParts xmlns:bm="urn:soap.bigmachines.com">
      <bm:Parts>
        <bm:criteria>
          <bm:field>part_number</bm:field>
          <bm:value>RAM-128</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>direct_buy</bm:field>
          <bm:value>1</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>description</bm:field>
          <bm:value>128 GB RAM 1333MHz</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>units</bm:field>
          <bm:value/>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>date_added</bm:field>
          <bm:value>2010-11-23 11:06:24</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>date_modified</bm:field>
          <bm:value>2012-03-24 05:11:45</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>lead_time</bm:field>
          <bm:value>-1</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field1</bm:field>
          <bm:value>Memory</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field2</bm:field>
          <bm:value>840</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field3</bm:field>
          <bm:value>5</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field4</bm:field>
          <bm:value/>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field5</bm:field>
          <bm:value>1400.0</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field6</bm:field>
          <bm:value>0.0</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>_part_custom_field8</bm:field>
          <bm:value>Hardware</bm:value>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>partner_part_id</bm:field>
          <bm:value/>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
        <bm:criteria>
          <bm:field>partner_std_pbook_entry_id</bm:field>
          <bm:value/>
          <bm:comparator>=</bm:comparator>
        </bm:criteria>
      </bm:Parts>
    </bm:deleteParts>
  </soapenv:Body>
</soapenv:Envelope>

---

Notes

Related Topics

See Also