SOAP Price Book Association API with Web Services 1.0
Overview
You can generate a skeleton input for each operation of the Price Book Associations WSDL, which contains 5 operations:
- add
- update
- get
- delete
- deleteAll
For each operation, there are 3 fields that are always required in the header:
- sessionID
- category: Security
- schemaLocation
| SOAP API | Description | Required Input Variables | Success Response Variables | Failure Response Variables |
|---|---|---|---|---|
| add | Supports adding Price Book associations; assuming both the Price Books and parts exist in the system. |
sessionID category schemaLocation price_book_var_name part_number
|
status: success message
|
exceptionCode exceptionMessage |
| get |
Supports getting specific associations based on desired criteria. Note: Multiple criterion will be joined with an 'AND' in the query, so try to specify a single criterion. A part number is required. |
sessionID category schemaLocation price_book_var_name field value comparator |
status: success message
PriceBookAssocs:
each_record
|
exceptionCode exceptionMessage |
| update | Updates an association between a given Price Book and a part. A part number is required. |
sessionID category schemaLocation price_book_var_name part_number |
status: success message
|
exceptionCode exceptionMessage |
| delete |
Supports the deletion of associations based on desired criteria. Note: Multiple criterion will be joined with an 'AND' in the query, so try to specify a single criterion. A part number is required. |
sessionID category schemaLocation price_book_var_name field value comparator |
status: success message
|
exceptionCode exceptionMessage |
| deleteAll | Supports deleting all Price Book associations for a Price Book. |
sessionID category schemaLocation price_book_var_name |
status: success message |
exceptionCode exceptionMessage |
Administration
Accessing Users WSDL and Generating Skeleton Input
- Navigate from: Admin Home Page > Integration Platform > Web Services.
- Click the Price Book Assocs tab.
- Select an API from the drop-down menu.
- Choose a Price Book from the drop-down menu.
- Click Generate Input to retrieve the skeleton.
Sample Price Book APIs
<?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>A99EA9EA9FFC03C02AF30373A60CFD60</bm:sessionId>
</bm:userInfo>
<bm:category xmlns:bm="urn:soap.bigmachines.com">Price Book Assocs</bm:category>
<bm:xsdInfo xmlns:bm="urn:soap.bigmachines.com">
<bm:schemaLocation>https://pm.bigmachines.com/bmfsweb/pm/schema/v1_0/pricebooks/PriceBookAssocs.xsd</bm:schemaLocation>
</bm:xsdInfo>
</soapenv:Header>
<soapenv:Body>
<bm:add xmlns:bm="urn:soap.bigmachines.com">
<bm:PriceBookAssocs bm:price_book_var_name="westCoastPricing"/>
</bm:add>
</soapenv:Body>
</soapenv:Envelope>
You must enter a Part Number before clicking Generate Input
<?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>A99EA9EA9FFC03C02AF30373A60CFD60</bm:sessionId>
</bm:userInfo>
<bm:category xmlns:bm="urn:soap.bigmachines.com">Price Book Assocs</bm:category>
<bm:xsdInfo xmlns:bm="urn:soap.bigmachines.com">
<bm:schemaLocation>https://pm.bigmachines.com/bmfsweb/pm/schema/v1_0/pricebooks/PriceBookAssocs.xsd</bm:schemaLocation>
</bm:xsdInfo>
</soapenv:Header>
<soapenv:Body>
<bm:get xmlns:bm="urn:soap.bigmachines.com">
<bm:PriceBookAssocs bm:price_book_var_name="westCoastPricing">
<bm:criteria>
<bm:field>part_number</bm:field><bm:value>RAM-128</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:PriceBookAssocs>
</bm:get>
</soapenv:Body>
</soapenv:Envelope>
You must enter a Part Number before clicking Generate Input.
<?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>A99EA9EA9FFC03C02AF30373A60CFD60</bm:sessionId>
</bm:userInfo>
<bm:category xmlns:bm="urn:soap.bigmachines.com">Price Book Assocs</bm:category>
<bm:xsdInfo xmlns:bm="urn:soap.bigmachines.com">
<bm:schemaLocation>https://pm.bigmachines.com/bmfsweb/pm/schema/v1_0/pricebooks/PriceBookAssocs.xsd</bm:schemaLocation>
</bm:xsdInfo>
</soapenv:Header>
<soapenv:Body>
<bm:update xmlns:bm="urn:soap.bigmachines.com">
<bm:PriceBookAssocs bm:price_book_var_name="westCoastPricing"/>
</bm:update>
</soapenv:Body>
</soapenv:Envelope>
You must enter a Part Number before clicking Generate Input.
<?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>A99EA9EA9FFC03C02AF30373A60CFD60</bm:sessionId>
</bm:userInfo>
<bm:category xmlns:bm="urn:soap.bigmachines.com">Price Book Assocs</bm:category>
<bm:xsdInfo xmlns:bm="urn:soap.bigmachines.com">
<bm:schemaLocation>https://pm.bigmachines.com/bmfsweb/pm/schema/v1_0/pricebooks/PriceBookAssocs.xsd</bm:schemaLocation>
</bm:xsdInfo>
</soapenv:Header>
<soapenv:Body>
<bm:delete xmlns:bm="urn:soap.bigmachines.com">
<bm:PriceBookAssocs bm:price_book_var_name="westCoastPricing">
<bm:criteria>
<bm:field>part_number</bm:field><bm:value>RAM-128</bm:value><bm:comparator>=</bm:comparator>
</bm:criteria>
</bm:PriceBookAssocs>
</bm:delete>
</soapenv:Body>
</soapenv:Envelope>
<?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>A99EA9EA9FFC03C02AF30373A60CFD60</bm:sessionId>
</bm:userInfo>
<bm:category xmlns:bm="urn:soap.bigmachines.com">Price Book Assocs</bm:category>
<bm:xsdInfo xmlns:bm="urn:soap.bigmachines.com">
<bm:schemaLocation>https://pm.bigmachines.com/bmfsweb/pm/schema/v1_0/pricebooks/PriceBookAssocs.xsd</bm:schemaLocation>
</bm:xsdInfo>
</soapenv:Header>
<soapenv:Body>
<bm:deleteAll xmlns:bm="urn:soap.bigmachines.com">
<bm:PriceBookAssocs bm:price_book_var_name="westCoastPricing"/>
</bm:deleteAll>
</soapenv:Body>
</soapenv:Envelope>
