Overview
You can generate a skeleton input for each operation in the Price Book Associations WSDL, which contains the following operations:
- add
- update
- get
- delete
- deleteAll
For each operation, the following fields are always required in the header:
-
UsernameToken
- Username
- Password Type
- category: Security
- schemaLocation
Price Book Associations SOAP API Details
For all SOAP APIs, the Failure Response Variables are exceptionCode and exceptionMessage.
| SOAP API | Description | Required Input Variables | Success Response Variables |
|---|---|---|---|
| add | Supports adding Price Book Associations. Assumes both the Price Books and the parts exist in the system. |
|
|
| 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. |
|
|
| update | Updates an association between a given Price Book and a part. A part number is required. |
|
|
| 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. |
|
|
| deleteAll | Supports deleting all Price Book Associations for a Price Book. |
|
|
Administration
Accessing Price Book Associations WSDL and Generating Skeleton Input
- Click Admin to go to the Admin Home Page.
-
Click Web Services in the Integration Platform section.
The Web Services Test page opens.
- Confirm that the Web Service Version is 2.0.
- Click the Price Book Assocs tab.
- Select an API from the drop-down.
- Choose a Price Book from the drop-down.
-
Click Generate Input to retrieve the skeleton.
For more information on the body of the Price Book Associations Web Service, and for code examples, see the topic SOAP Price Book Association API with Web Services 1.0. With the exception of the header, the Web Services 1.0 code examples are valid in Web Services 2.0.
Header Information for Web Services 2.0
For each API, the body of the SOAP XML is the same as it was for Web Services 1.0. This is the information contained between the <soapenv:Body> and </soapenv:Body> tags.
| Comment | Header: Web Services 1.0 | Header: Web Services 2.0 |
|---|---|---|
| No change | <soapenv:Header> | <soapenv:Header> |
| New tags |
<wsse:Security xmlns:wsse= "http://docs.oasis-open.org/wss/2004/ |
|
| New user information replaces sessionId |
<bm:userInfo . . . >
</bm:userInfo> |
<wsse:UsernameToken wsu:Id="UsernameToken-2">
</wsse:UsernameToken> |
| This is now in the URL, with the unique end point specified. | <bm:category xmlns:bm="urn:soap.bigmachines.com"> Commerce </bm:category> |
Now reflected in the SOAP Server URL field. |
| No longer needed |
<bm:xsdInfo . . . . . </bm:xsdInfo> |
|
| Ending the new authentication |
</wsse:Security> |
|
| No change | </soapenv:Header> | </soapenv:Header> |
