SOAP Commerce API with Web Services 1.0

Overview

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

createTransaction
addToTransaction
removeFromTransaction
updateTransaction
getTransaction
exportFileAttachments
importFileAttachments

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

sessionID
category: Security
schemaLocation

The commerce APIs provide functionality that is available through the regular bulk upload of the Asset Manager or the Real Time API provided through middleware. In addition, they will provide the ability to create a new transaction (both with and without line items).

Commerce SOAP API Details

SOAP API	Description	Required Input Variables	Success Response Variables	Failure Response Variables
createTransaction	Supports the create of a commerce transaction without line items, as well as transactions with non-configurable line items from a specified process. For all transactions that need to be created with configurable line items, the configuration SOAP API will have to be invoked. This will return the Transaction ID.	sessionID category schemaLocation process_var_name var_name attribute	status: success message transactionID transaction action_date	exceptionCode exceptionMessage
addToTransaction	Adds a new items to an existing transaction. It performs the "Add from Catalog" action. The request message specifies the process, document and action on the document, along with the items to be added as parameters of the operation.	transactionID sessionID category schemaLocation process_var_name var_name attribute document_number document_var_name To add a part: All input variables above part quantity price_book_var_name	status: success message transaction action_data	exceptionCode exceptionMessage
removeFromTransaction	Removes an item from an existing transaction. It performs the "Remove Line Items" action. The input parameters include the document ID, document number, process name and document name. They are wrapped in a specific structure described below.	transaction ID sessionID category schemaLocation process_var_name document_number document_var_name	status: success message	exceptionCode exceptionMessage
updateTransaction	Updates an existing transaction. It performs all "Modify" type actions, as well as the "Auto-fill" action. It does not support the 'Create Document' action.	transactionID sessionID category schemaLocation id process_var_name	status: success message	exceptionCode exceptionMessage
getTransaction	Returns the transaction based on the Transaction ID, which is provided as input parameter. The API returns the transaction XML. Note it does not return RTE or HTML attributes, which can be obtained with REST APIs. Refer to Commerce REST APIs	transactionID sessionID category schemaLocation id var_name attribute	status: success message transaction action_data	exceptionCode exceptionMessage
exportFileAttachment	Export a file attachment using one of two methods to stream the data via SOAP: inline base64 content in a SOAP message or binary stream with MIME containers via MTOM transmission. These methods provide read/write of multiple attributes at once per transaction. This API can only be used by FullAccess users with Permission to Modify Users. There are two modes available for use: Content: Retrieves the content of the attached field(s). Metadata: Retrieves the file information or metadata for the references fields.	sessionID category schemaLocation mode document_number variable_name process_var_name id	status: success message id attachments	exceptionCode exceptionMessage
importFileAttachment	Import a file attachment using one of two methods to stream the data via SOAP: inline base64 content in a SOAP message or binary stream with MIME containers via MTOM transmission. These methods provide read/write of multiple attributes at once per transaction. This API can only be used by FullAccess users with Permission to Modify Users. There are two modes available for use: Update: Attaches a files, or a set of files, to the transaction. Delete: Removes a file from the file attachment attribute.	sessionID category schemaLocation mode document_number variable_name filename process_var_name id	status: success message	exceptionCode exceptionMessage

Returning Specific Attributes in Commerce APIs

Administration

Accessing Users WSDL and Generating Skeleton Input

Line items must start with numerical sequence

What	Description
Scope	Blank line item attributes for every line item might only be necessary when Update Transaction is used with the _update_line_items action. For other actions, an empty <bm:sub_documents> tag is enough.
Cause	An Update Transaction SOAP call contains data for specific line items.
Solution 1	The document number is mandatory for every line item. Every line item's document number must be passed to the SOAP call, even for line items that do not require any updating. Simply pass these line items with the document number and blank attribute tags.
Solution 2	Make the SOAP call with a line-level action (as opposed to a Quote-level action), which does not require all line items on the quote to be "considered" when parsing the input data. However, this approach is not going to work if you need to update quote level attributes based on the updated line item attributes (for example, pricing subtotals).