org.mule.modules

mule-module-magento

config

Namespace	http://www.mulesoft.org/schema/mule/magento
Schema Location	http://www.mulesoft.org/schema/mule/magento/current/mule-magento.xsd (View Schema)
Schema Version	1.1
Minimum Mule Version	3.4

Module Overview

Magento is a feature-rich eCommerce platform built on open-source technology that provides online merchants with great and control over the look, content and functionality of their eCommerce store.

Summary

Configuration
<magento:config> Configure an instance of this module

Message Processors
<magento:add-category-product> Assign product to category.
<magento:add-order-comment> Adds a comment to the given order id
<magento:add-order-invoice-comment> Adds a comment to the given order's invoice
<magento:add-order-shipment-comment> Adds a comment to the shipment.
<magento:add-order-shipment-track> Adds a new tracking number
<magento:add-product-link> Links two products, given its source and destination productIdOrSku.
<magento:add-shopping-cart-coupon> Adds a coupon code for a shopping cart (quote).
<magento:add-shopping-cart-product> Adds one or more products to the shopping cart (quote).
<magento:cancel-order> Cancels an order
<magento:cancel-order-invoice> Cancels an order's invoice
<magento:capture-order-invoice> Captures and invoice
<magento:create-category> Creates a new category.
<magento:create-customer> Creates a customer with the given attributes
<magento:create-customer-address> Creates a new address for the given customer using the given address attributes
<magento:create-order-invoice> Creates an invoice for the given order
<magento:create-order-shipment> Creates a shipment for order
<magento:create-product> Creates a new product
<magento:create-product-attribute-media> Creates a new product media.
<magento:create-shopping-cart> Creates an empty shopping cart.
<magento:create-shopping-cart-order> Creates an order from a shopping cart (quote).
<magento:delete-category> Deletes a category.
<magento:delete-category-product> Remove a product assignment.
<magento:delete-customer> Deletes a customer given its id
<magento:delete-customer-address> Deletes a Customer Address
<magento:delete-order-shipment-track> Deletes the given track of the given order's shipment
<magento:delete-product> Deletes a product.
<magento:delete-product-attribute-media> Removes a product image.
<magento:delete-product-link> Deletes a product's link.
<magento:get-catalog-current-store-view> Answers the current default catalog store view id for this session
<magento:get-category> Answers category attributes.
<magento:get-category-tree> Answers the category tree.
<magento:get-customer> Answers customer attributes for the given id.
<magento:get-customer-address> Answers the customer address attributes
<magento:get-info-shopping-cart> Retrieves full information about the shopping cart (quote).
<magento:get-order> Answers the order properties for the given orderId
<magento:get-order-invoice> Retrieves order invoice information
<magento:get-order-shipment> Retrieves the order shipment attributes
<magento:get-order-shipment-carriers> Retrieves the order shipment carriers.
<magento:get-product> Answers a product's specified attributes.
<magento:get-product-attribute-media> Lists linked products to the given product and for the given link type.
<magento:get-product-special-price> Answers a product special price.
<magento:hold-order> Puts order on hold.
<magento:list-category-attribute-options> Retrieves attribute options.
<magento:list-category-attributes> Retrieve product image types.
<magento:list-category-levels> Answers levels of categories for a website, store view and parent category
<magento:list-category-products> Lists product of a given category.
<magento:list-customer-addresses> Lists the customer address for a given customer id
<magento:list-customer-groups> Lists all the customer groups
<magento:list-customers> Answers a list of customer attributes for the given filter expression.
<magento:list-directory-countries> Answers the list of countries
<magento:list-directory-regions> Answers a list of regions for the given county
<magento:list-inventory-stock-items> Lists inventory stock items.
<magento:list-orders> Lists order attributes that match the given filtering expression.
<magento:list-orders-invoices> Lists order invoices that match the given filtering expression
<magento:list-orders-shipments> Lists order shipment atrributes that match the given optional filtering expression
<magento:list-product-attribute-media> Retrieves product image list.
<magento:list-product-attribute-media-types> Retrieve product image types.
<magento:list-product-attribute-options> Answers the product attribute options.
<magento:list-product-attribute-sets> Retrieves product attribute sets.
<magento:list-product-attribute-tier-prices> Retrieve product tier prices.
<magento:list-product-attributes> Retrieves product attributes list.
<magento:list-product-link> Lists linked products to the given product and for the given link type
<magento:list-product-link-attributes> Lists all the attributes for the given product link type
<magento:list-product-link-types> Answers product link types
<magento:list-product-types> Answers product types.
<magento:list-products> Retrieve products list by filters.
<magento:list-shopping-cart-licenses> Retrieves the website license agreement for the quote according to the website (store).
<magento:list-shopping-cart-payment-methods> Retrieves a list of available payment methods for a shopping cart (quote).
<magento:list-shopping-cart-products> Retrieves the list of products in the shopping cart (quote).
<magento:list-shopping-cart-shipping-methods> Retrieves the list of available shipping methods for a shopping cart (quote).
<magento:list-shopping-cart-totals> Retrieves total prices for a shopping cart (quote).
<magento:list-stock-items> Retrieve stock data by product ids
<magento:move-category> Move category in tree.
<magento:move-shopping-cart-product-to-customer-quote> Moves products from the current quote to a customer quote.
<magento:remove-shopping-cart-coupon> Removes a coupon code from a shopping cart (quote).
<magento:remove-shopping-cart-product> Removes one or several products from a shopping cart (quote).
<magento:set-shopping-cart-customer> Adds information about the customer to a shopping cart (quote).
<magento:set-shopping-cart-customer-addresses> Sets the customer addresses in the shopping cart (quote).
<magento:set-shopping-cart-payment-method> Sets a payment method for a shopping cart (quote), cart must not be empty.
<magento:set-shopping-cart-shipping-method> Retrieves a shipping method for a shopping cart (quote).
<magento:unhold-order> Releases order
<magento:update-category> Updates a category.
<magento:update-category-attribute-store-view> Set the default catalog store view for this session
<magento:update-category-product> Updates a category product.
<magento:update-customer> Updates the given customer attributes, for the given customer id.
<magento:update-customer-address> Updates the given map of customer address attributes, for the given customer address
<magento:update-inventory-stock-item> Updates an stock inventory item
<magento:update-product> Updates a product.
<magento:update-product-attribute-media> Updates product media.
<magento:update-product-attribute-tier-price> Updates a single product tier price.
<magento:update-product-link> Update product link
<magento:update-product-special-price> Sets a product special price.
<magento:update-shopping-cart-product> Updates one or several products in the shopping cart (quote).
<magento:update-stock-item> Update product stock data given its id or sku
<magento:void-order-invoice> Voids an invoice

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:magento="http://www.mulesoft.org/schema/mule/magento"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/magento
               http://www.mulesoft.org/schema/mule/magento/current/mule-magento.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <magento:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
username		The user name to access Magento Web Services	String	/	UTF-8
password		The password to access Magento Web Services	String	/	UTF-8
address		The address to access Magento Web Services	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <magento:config>
         <reconnect count="5" frequency="1000"/>
    </magento:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<magento:add-category-product>

Assign product to category. See catalog-category-assignProduct SOAP method

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
categoryId	The category where the given product will be added	int	/
productId	Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku	Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the product.	String	/	UTF-8
position	The position of this product	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:add-order-comment>

Adds a comment to the given order id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
orderId		The order id	String	/	UTF-8
status		The comment status	String	/	UTF-8
comment		The comment	String	/	UTF-8
sendEmail	false	Optional. If an email must be sent after shipment creation	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:add-order-invoice-comment>

Adds a comment to the given order's invoice

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
invoiceId		The invoice id	String	/	UTF-8
comment		The comment to add	String	/	UTF-8
sendEmail	false	Optional. If an email must be sent after shipment creation	boolean	/
includeCommentInEmail	false	Optional. If the comment must be sent in the email	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:add-order-shipment-comment>

Adds a comment to the shipment.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
shipmentId		The shipment's increment id	String	/	UTF-8
comment		The comment to add	String	/	UTF-8
sendEmail	false	Optional. If an email must be sent after shipment creation	boolean	/
includeCommentInEmail	false	Optional. If the comment must be sent in the email	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:add-order-shipment-track>

Adds a new tracking number

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
shipmentId	The shipment id	String	/	UTF-8
carrierCode	The new track's carrier code	String	/	UTF-8
title	The new track's title	String	/	UTF-8
trackId	The new track's id	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
int	the new track's id

<magento:add-product-link>

Links two products, given its source and destination productIdOrSku.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		The product type	String	/	UTF-8
productId		Optional. The id of the source product. Use it instead of productIdOrSku in case you are sure the source product identifier is a product id	Integer	/
productSku		Optional. The sku of the source product. Use it instead of productIdOrSku in case you are sure the source product identifier is a product sku	String	/	UTF-8
productIdOrSku		Optional. The id or sku of the source product.	String	/	UTF-8
linkedProductIdOrSku		The destination product id or sku.	String	/	UTF-8
productLinkEntity	#[payload]	Optional. The link attributes	CatalogProductLinkEntity	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:add-shopping-cart-coupon>

Adds a coupon code for a shopping cart (quote). The shopping cart must not be empty. The shopping cart must be created with a storeId for this operation to work.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
couponCode	Coupon code	String	/	UTF-8
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
boolean	True if the coupon code is added

<magento:add-shopping-cart-product>

Adds one or more products to the shopping cart (quote).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:products>	#[payload]	Optional. Products data	List<ShoppingCartProductEntity>

Returns

Return Type	Description
boolean	True on success (if the product is added to the shopping cart)

<magento:cancel-order>

Cancels an order

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
orderId	The order to cancel	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:cancel-order-invoice>

Cancels an order's invoice

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
invoiceId	The invoice id	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:capture-order-invoice>

Captures and invoice

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
invoiceId	The invoice to capture	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:create-category>

Creates a new category. See catalog-category-create SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
parentId		The parent category id	int	/
catalogCategoryEntity	#[payload]	Optional. The new category attributes	CatalogCategoryEntityCreate	/
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
int	the new category id

<magento:create-customer>

Creates a customer with the given attributes

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
customer	The attributes of the new customer	CustomerCustomerEntityToCreate	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
int	the new customer id

<magento:create-customer-address>

Creates a new address for the given customer using the given address attributes

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
customerId		The customer	int	/
customerAddress	#[payload]	Optional. The address attributes	CustomerAddressEntityCreate	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
int	a new customer address id

<magento:create-order-invoice>

Creates an invoice for the given order

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
orderId		The id of the order	String	/	UTF-8
comment		Optional. An optional comment	String	/	UTF-8
sendEmail	false	Optional. If an email must be sent after shipment creation	boolean	/
includeCommentInEmail	false	Optional. If the comment must be sent in the email	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:items-quantities>	#[payload]	Optional. OrderItemId quantity	List<OrderItemIdQty>

Returns

Return Type	Description
String	the new invoice's id

<magento:create-order-shipment>

Creates a shipment for order

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
orderId		The order increment id	String	/	UTF-8
comment		Optional. An optional comment	String	/	UTF-8
sendEmail	false	Optional. If an email must be sent after shipment creation	boolean	/
includeCommentInEmail	false	Optional. If the comment must be sent in the email	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:items-quantities>	#[payload]	Optional. OrderItemId quantity	List<OrderItemIdQty>

Returns

Return Type	Description
String	the new shipment's id

<magento:create-product>

Creates a new product

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		The new product's type	String	/	UTF-8
set		The new product's set	int	/
sku		The new product's sku	String	/	UTF-8
attributes	#[payload]	Optional. The standard attributes of the new product	CatalogProductCreateEntity	/
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:additional-attributes>		Optional. The non standard attributes of the new product	List<AssociativeEntity>

Returns

Return Type	Description
int	the new product's id

<magento:create-product-attribute-media>

Creates a new product media. See catalog-product-attribute-media-create SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
productId		Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku		Optional. The id or sku of the product.	String	/	UTF-8
catalogProductAttributeMediaEntity	#[payload]	Optional. The media attributes	CatalogProductAttributeMediaCreateEntity	/
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
payload		The image to upload. It may be a file, an input stream or a byte array	Object	/
mimeType		The mimetype	MediaMimeType	/
baseFileName		Optional. The base name of the new remote image	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
String	the new image filename

Exception Payloads

Payload Class	Description
FileNotFoundException	when the payload object is not a valid file

<magento:create-shopping-cart>

Creates an empty shopping cart. Store Id is optional, but some operations may not work correctly if isn't given in the cart creation.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
int	ID of the created empty shopping cart

<magento:create-shopping-cart-order>

Creates an order from a shopping cart (quote).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:licenses>		Optional. Website license ID	List<String>

Returns

Return Type	Description
String	result code of order creation

<magento:delete-category>

Deletes a category. See catalog-category-delete SOAP method

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
categoryId	The category to delete	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
boolean	if the category is deleted

<magento:delete-category-product>

Remove a product assignment. See catalog-category-removeProduct SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
categoryId	The category to delete	int	/
productId	Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku	Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the product.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
boolean	if the product is removed from the category

<magento:delete-customer>

Deletes a customer given its id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
customerId	The customer to delete	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
boolean	if the customer is deleted

<magento:delete-customer-address>

Deletes a Customer Address

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
addressId	The address id to delete	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
boolean	if the customer address is deleted

<magento:delete-order-shipment-track>

Deletes the given track of the given order's shipment

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
shipmentId	The target shipment id	String	/	UTF-8
trackId	The id of the track to delete	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
int	if the tracking number is removed from the shipment

<magento:delete-product>

Deletes a product. See catalog-product-delete SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
productId	Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku	Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the product.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
int	if the product is deleted

<magento:delete-product-attribute-media>

Removes a product image. See catalog-product-attribute-media-remove SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
productId	Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku	Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the product.	String	/	UTF-8
fileName	The remote media file to delete	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
int	if the image is removed from a product

<magento:delete-product-link>

Deletes a product's link.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
type	Link type	String	/	UTF-8
productId	Optional. The id of the source product. Use it instead of productIdOrSku in case you are sure the source product identifier is a product id	Integer	/
productSku	Optional. The sku of the source product. Use it instead of productIdOrSku in case you are sure the source product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the source product.	String	/	UTF-8
linkedProductIdOrSku	The linked product id or sku	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
String	if the link is removed from a product

<magento:get-catalog-current-store-view>

Answers the current default catalog store view id for this session

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
int	the current default store view id

<magento:get-category>

Answers category attributes. See catalog-category-info SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
categoryId	The category whose attributes will be retrieved	int	/
storeViewIdOrCode	Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:attribute-names>		The category attributes that will be retrieved	List<String>

Returns

Return Type	Description
CatalogCategoryInfo	the category attributes

<magento:get-category-tree>

Answers the category tree. See catalog-category-tree SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
parentId	The parent id	String	/	UTF-8
storeViewIdOrCode	Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
CatalogCategoryTree	a category tree attributes

<magento:get-customer>

Answers customer attributes for the given id. Only the selected attributes are retrieved

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
customerId	The id of the customer to retrieve	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:attribute-names>		The attributes to retrieve. Not empty	List<String>

Returns

Return Type	Description
CustomerCustomerEntity	the attributes map

<magento:get-customer-address>

Answers the customer address attributes

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
addressId	The id of the address	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
CustomerAddressEntityItem	the customer address attributes map

<magento:get-info-shopping-cart>

Retrieves full information about the shopping cart (quote).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping cart ID (quote ID)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
ShoppingCartInfoEntity	shopping cart info

<magento:get-order>

Answers the order properties for the given orderId

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
orderId	The order whose properties to fetch	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
SalesOrderEntity	a string-object map of order properties

<magento:get-order-invoice>

Retrieves order invoice information

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
invoiceId	The target invoiceId	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
SalesOrderInvoiceEntity	the invoice attributes

<magento:get-order-shipment>

Retrieves the order shipment attributes

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
shipmentId	The id of the shipment	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
SalesOrderShipmentEntity	the shipment attributes

<magento:get-order-shipment-carriers>

Retrieves the order shipment carriers.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
orderId	The target order id	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<Carrier>	a list of `Carrier` object

<magento:get-product>

Answers a product's specified attributes. At least one of attributNames or additionalAttributeNames must be non null and non empty. See catalog-product-info SOAP method

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
productId	Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku	Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the product.	String	/	UTF-8
storeViewIdOrCode	Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:attributes-names>		Optional. The list of standard attributes to be returned	List<String>
<magento:additional-attribute-names>		Optional. The list of non standard attributes to be returned in the additionalAttributes attribute	List<String>

Returns

Return Type	Description
CatalogProductReturnEntity	the attributes

<magento:get-product-attribute-media>

Lists linked products to the given product and for the given link type.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
productId	Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku	Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the product.	String	/	UTF-8
fileName	The name of the file	String	/	UTF-8
storeViewIdOrCode	Optional. The store view id or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
CatalogProductImageEntity	the list of links to the product

<magento:get-product-special-price>

Answers a product special price. See catalog-product-getSpecialPrice SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
productId	Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku	Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the product.	String	/	UTF-8
storeViewIdOrCode	Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
CatalogProductReturnEntity	the product special price attributes

<magento:hold-order>

Puts order on hold. This operation can be reverted with unholdOrder.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
orderId	The order to put on hold state	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:list-category-attribute-options>

Retrieves attribute options. See catalog-category-attribute-options SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
attributeId	The target attribute whose options will be retrieved	String	/	UTF-8
storeViewIdOrCode	Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogAttributeOptionEntity>	the list of category attribute options

<magento:list-category-attributes>

Retrieve product image types. See catalog-product-attribute-media-types SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogAttributeEntity>	the list of category attributes

<magento:list-category-levels>

Answers levels of categories for a website, store view and parent category

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
website	Optional. The website	String	/	UTF-8
storeViewIdOrCode	Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
parentCategoryId	Optional. The parent category of the categories that will be listed	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogCategoryEntityNoChildren>	the list of categories attributes

<magento:list-category-products>

Lists product of a given category. See catalog-category-assignedProducts SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
categoryId	The category	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogAssignedProduct>	the listing of category products

<magento:list-customer-addresses>

Lists the customer address for a given customer id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
customerId	The id of the customer	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CustomerAddressEntityItem>	a listing of addresses

<magento:list-customer-groups>

Lists all the customer groups

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CustomerGroupEntity>	a listing of groups attributes

<magento:list-customers>

Answers a list of customer attributes for the given filter expression.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
filter	Optional. Optional filtering expression - one or more comma-separated unary or binary predicates, one for each filter, in the form filterType(attributeName, value), for binary filters or filterType(attributeName), for unary filters, where filterType is istrue, isfalse or any of the Magento standard filters. Non-numeric values need to be escaped using simple quotes.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CustomerCustomerEntity>	the list of attributes map

<magento:list-directory-countries>

Answers the list of countries

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<DirectoryCountryEntity>	a collection of countries attributes

<magento:list-directory-regions>

Answers a list of regions for the given county

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
countryId	The country code, in ISO2 or ISO3 format	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<DirectoryRegionEntity>	the collection of regions attributes

<magento:list-inventory-stock-items>

Lists inventory stock items.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:product-id-or-skus>		The list of product ids and/or skus whose attributes will be retrieved	List<String>

Returns

Return Type	Description
List<CatalogInventoryStockItemEntity>	the list of attributes

<magento:list-orders>

Lists order attributes that match the given filtering expression.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
filter	Optional. Optional filtering expression - one or more comma-separated unary or binary predicates, one for each filter, in the form filterType(attributeName, value), for binary filters or filterType(attributeName), for unary filters, where filterType is istrue, isfalse or any of the Magento standard filters. Non-numeric values need to be escaped using simple quotes.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<SalesOrderListEntity>	a list of string-object maps

<magento:list-orders-invoices>

Lists order invoices that match the given filtering expression

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
filter	Optional. Optional filtering expression - one or more comma-separated unary or binary predicates, one for each filter, in the form filterType(attributeName, value), for binary filters or filterType(attributeName), for unary filters, where filterType is istrue, isfalse or any of the Magento standard filters. Non-numeric values need to be escaped using simple quotes.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<SalesOrderInvoiceEntity>	list of string-object maps order attributes

<magento:list-orders-shipments>

Lists order shipment atrributes that match the given optional filtering expression

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
filter	Optional. Optional filtering expression - one or more comma-separated unary or binary predicates, one for each filter, in the form filterType(attributeName, value), for binary filters or filterType(attributeName), for unary filters, where filterType is istrue, isfalse or any of the Magento standard filters. Non-numeric values need to be escaped using simple quotes.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<SalesOrderShipmentEntity>	list of string-object map order shipments attributes

<magento:list-product-attribute-media>

Retrieves product image list. See catalog-product-attribute-media-list SOAP method

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
productId	Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku	Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the product.	String	/	UTF-8
storeViewIdOrCode	Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogProductImageEntity>	the list of product images attributes

<magento:list-product-attribute-media-types>

Retrieve product image types. See catalog-product-attribute-media-types SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
setId	The setId	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogProductAttributeMediaTypeEntity>	the list of attribute media types

<magento:list-product-attribute-options>

Answers the product attribute options. See catalog-product-attribute-options SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
attributeId	The target attribute whose options will be listed	String	/	UTF-8
storeViewIdOrCode	Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogAttributeOptionEntity>	the attributes list

<magento:list-product-attribute-sets>

Retrieves product attribute sets. See catalog-product-attribute-set-list SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogProductAttributeSetEntity>	The list of product attributes sets

<magento:list-product-attribute-tier-prices>

Retrieve product tier prices. See catalog-product-attribute-tier-price-info SOAP Method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
productId	Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku	Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the product.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogProductTierPriceEntity>	the list of product attributes

<magento:list-product-attributes>

Retrieves product attributes list. See catalog-product-attribute-list SOAP methods

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
setId	The set id	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogAttributeEntity>	the list of product attributes

<magento:list-product-link>

Lists linked products to the given product and for the given link type

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
type	The link type	String	/	UTF-8
productId	Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku	Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the product.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogProductLinkEntity>	the list of links to the product

<magento:list-product-link-attributes>

Lists all the attributes for the given product link type

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
type	The product type	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogProductLinkAttributeEntity>	the listing of product attributes

<magento:list-product-link-types>

Answers product link types

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<String>	the list of product link types

<magento:list-product-types>

Answers product types. See catalog-product-type-list SOAP method

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogProductTypeEntity>	the list of product types

<magento:list-products>

Retrieve products list by filters. See catalog-product-list SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
filter	Optional. Optional filtering expression - one or more comma-separated unary or binary predicates, one for each filter, in the form filterType(attributeName, value), for binary filters or filterType(attributeName), for unary filters, where filterType is istrue, isfalse or any of the Magento standard filters. Non-numeric values need to be escaped using simple quotes.	String	/	UTF-8
storeViewIdOrCode	Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogProductEntity>	the list of product attributes that match the given optional filtering expression

<magento:list-shopping-cart-licenses>

Retrieves the website license agreement for the quote according to the website (store). Store id must be given in cart creation.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<ShoppingCartLicenseEntity>	licences for the shopping cart

<magento:list-shopping-cart-payment-methods>

Retrieves a list of available payment methods for a shopping cart (quote).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
ShoppingCartPaymentMethodResponseEntityArray	Payment methods available

<magento:list-shopping-cart-products>

Retrieves the list of products in the shopping cart (quote).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<CatalogProductEntity>	products in the shopping cart.

<magento:list-shopping-cart-shipping-methods>

Retrieves the list of available shipping methods for a shopping cart (quote).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<ShoppingCartShippingMethodEntity>	Shipping methods available

<magento:list-shopping-cart-totals>

Retrieves total prices for a shopping cart (quote).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping cart ID (quote identifier)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
List<ShoppingCartTotalsEntity>	shopping cart total prices

<magento:list-stock-items>

Retrieve stock data by product ids

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:product-id-or-skus>		A not empty list of product ids or skus whose attributes to list	List<String>

Returns

Return Type	Description
List<CatalogInventoryStockItemEntity>	a list of stock items attributes

<magento:move-category>

Move category in tree. See catalog-category-move SOAP method. Please make sure that you are not moving category to any of its own children. There are no extra checks to prevent doing it through webservices API, and you won’t be able to fix this from admin interface then .

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
categoryId	The id of the category to be moved	int	/
parentId	The new parent category id	int	/
afterId	Optional. An optional category id for use as reference in the positioning of the moved category	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:move-shopping-cart-product-to-customer-quote>

Moves products from the current quote to a customer quote.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:products>		Products data	List<ShoppingCartProductEntity>

Returns

Return Type	Description
boolean	True if the product is moved to customer quote

<magento:remove-shopping-cart-coupon>

Removes a coupon code from a shopping cart (quote).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
boolean	True if the coupon code is removed

<magento:remove-shopping-cart-product>

Removes one or several products from a shopping cart (quote).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:products>	#[payload]	Optional. Products data	List<ShoppingCartProductEntity>

Returns

Return Type	Description
boolean	True if the product is removed

<magento:set-shopping-cart-customer>

Adds information about the customer to a shopping cart (quote).

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
quoteId		Shopping Cart ID (quote ID)	int	/
customer	#[payload]	Optional. Cuestomer data	ShoppingCartCustomerEntity	/
storeId		Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
boolean	True if information is added

<magento:set-shopping-cart-customer-addresses>

Sets the customer addresses in the shopping cart (quote). Don't set a coupon to the cart before using this method, the address won't be set.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:shopping-cart-customer-addresses>	#[payload]	Optional. Addresses data (mode is required for each address and should be either "shipping" or "billing")	List<ShoppingCartCustomerAddressEntity>

Returns

Return Type	Description
boolean	True if information is added

<magento:set-shopping-cart-payment-method>

Sets a payment method for a shopping cart (quote), cart must not be empty.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
quoteId		Shopping Cart ID (quote ID)	int	/
shoppingCartPaymentMethod	#[payload]	Optional. Payment mehthod data	ShoppingCartPaymentMethodEntity	/
storeId		Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
boolean	True on success

<magento:set-shopping-cart-shipping-method>

Retrieves a shipping method for a shopping cart (quote).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
method	Shipping method code	String	/	UTF-8
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Returns

Return Type	Description
boolean	True if the shipping method is retrieved

<magento:unhold-order>

Releases order

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
orderId	The id of the order to remove from hold state	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:update-category>

Updates a category. See catalog-category-update SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
categoryId		The category to update	int	/
catalogCategoryEntity	#[payload]	Optional. The category new attributes	CatalogCategoryEntityCreate	/
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:update-category-attribute-store-view>

Set the default catalog store view for this session

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
storeViewIdOrCode	The id or code of the target store. Left unspecified for using current store the id or code of the store view to set as default for this session	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:update-category-product>

Updates a category product.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
categoryId	The category id	int	/
productId	Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku	Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the product.	String	/	UTF-8
position	The category position for ordering the category inside its level	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:update-customer>

Updates the given customer attributes, for the given customer id. Password can not be updated using this method

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
customerId		The target customer to update	int	/
customer	#[payload]	Optional. The customer attributes	CustomerCustomerEntityToCreate	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:update-customer-address>

Updates the given map of customer address attributes, for the given customer address

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
addressId	The customer address to update	int	/
customerAddress	The address attributes to update	CustomerAddressEntityCreate	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:update-inventory-stock-item>

Updates an stock inventory item

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
productId		Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku		Optional. The id or sku of the product.	String	/	UTF-8
catalogInventoryStockItem	#[payload]	Optional. The new attributes of the stock item	CatalogInventoryStockItemUpdateEntity	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:update-product>

Updates a product. At least one of attributes or additionalAttributes must be non null and non empty. See catalog-category-updateProduct SOAP method

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
productId		Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku		Optional. The id or sku of the product.	String	/	UTF-8
catalogProductEntity	#[payload]	Optional. Standard product attributes to update	CatalogProductCreateEntity	/
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:additional-attributes>		Optional. Non standard product attributes to update	List<AssociativeEntity>

<magento:update-product-attribute-media>

Updates product media. See catalog-product-attribute-media-update

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
productId		Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku		Optional. The id or sku of the product.	String	/	UTF-8
fileName		The name of the remote media file to update	String	/	UTF-8
catalogProductAttributeMediaEntity	#[payload]	Optional. The attributes to update	CatalogProductAttributeMediaCreateEntity	/
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:update-product-attribute-tier-price>

Updates a single product tier price. See catalog-product-attribute-tier-price-update SOAP method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
productId		Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku		Optional. The id or sku of the product.	String	/	UTF-8
catalogProductTierPriceEntity	#[payload]	Optional. The tier price to update.	CatalogProductTierPriceEntity	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:update-product-link>

Update product link

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		The link type	String	/	UTF-8
productId		Optional. The id of the source product. Use it instead of productIdOrSku in case you are sure the source product identifier is a product id	Integer	/
productSku		Optional. The sku of the source product. Use it instead of productIdOrSku in case you are sure the source product identifier is a product sku	String	/	UTF-8
productIdOrSku		Optional. The id or sku of the source product.	String	/	UTF-8
linkedProductIdOrSku		The destination product id or sku.	String	/	UTF-8
catalogProductLinkEntity	#[payload]	Optional. The link attributes	CatalogProductLinkEntity	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:update-product-special-price>

Sets a product special price. See catalog-product-setSpecialPrice SOAP method

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
productId	Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id	Integer	/
productSku	Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku	String	/	UTF-8
productIdOrSku	Optional. The id or sku of the product.	String	/	UTF-8
specialPrice	The special price to set	String	/	UTF-8
fromDate	Optional. Optional start date of the special price period	String	/	UTF-8
toDate	Optional. Optional end date of the special price period	String	/	UTF-8
storeViewIdOrCode	Optional. The id or code of the target store. Left unspecified for using current store	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:update-shopping-cart-product>

Updates one or several products in the shopping cart (quote).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
quoteId	Shopping Cart ID (quote ID)	int	/
storeId	Optional. Store view ID or code	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<magento:products>	#[payload]	Optional. Products data	List<ShoppingCartProductEntity>

Returns

Return Type	Description
boolean	True if the product is updated

<magento:update-stock-item>

Update product stock data given its id or sku

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
productIdOrSku		The product id or sku of the product to update	String	/	UTF-8
stockItem	#[payload]	Optional. The attributes to update	CatalogInventoryStockItemUpdateEntity	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. The user name to access Magento Web Services	String	/	UTF-8
password		Optional. The password to access Magento Web Services	String	/	UTF-8
address		Optional. The address to access Magento Web Services	String	/	UTF-8

<magento:void-order-invoice>

Voids an invoice

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
invoiceId	The invoice id	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. The user name to access Magento Web Services	String	/	UTF-8
password	Optional. The password to access Magento Web Services	String	/	UTF-8
address	Optional. The address to access Magento Web Services	String	/	UTF-8