Summary: Configuration | Message Processors

org.mule.modules

mule-module-magento

1.4.2

Namespace	http://www.mulesoft.org/schema/mule/magento
Schema Location	http://www.mulesoft.org/schema/mule/magento/1.1/mule-magento.xsd
Version	1.1
Minimum Mule Version	3.2

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: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: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-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-stock-items> Retrieve stock data by product ids
<magento:move-category> Move category in tree.
<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-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/1.1/mule-magento.xsd">

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

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necesary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:string	address		The address to access Magento Web Services
xs:string	password		The password to access Magento Web Services
xs:string	username		The user name to access Magento Web Services

Message Processors

<magento:add-category-product>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
categoryId		The category where the given product will be added
productId		Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.
position		The position of this product

Child Elements

<magento:add-order-comment>

Adds a comment to the given order id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
orderId		The order id
status		The comment status
comment		The comment
sendEmail		Optional. If an email must be sent after shipment creation

Child Elements

<magento:add-order-invoice-comment>

Adds a comment to the given order's invoice

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
invoiceId		The invoice id
comment		The comment to add
sendEmail		Optional. If an email must be sent after shipment creation
includeCommentInEmail		Optional. If the comment must be sent in the email

Child Elements

<magento:add-order-shipment-comment>

Adds a comment to the shipment.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
shipmentId		The shipment's increment id
comment		The comment to add
sendEmail		Optional. If an email must be sent after shipment creation
includeCommentInEmail		Optional. If the comment must be sent in the email

Child Elements

<magento:add-order-shipment-track>

Adds a new tracking number

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
shipmentId		The shipment id
carrierCode		The new track's carrier code
title		The new track's title
trackId		The new track's id

Child Elements

Return Payload

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
config-ref		Optional. Specify which configuration to use.
type		The product type
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
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
productIdOrSku		Optional. The id or sku of the source product.
linkedProductIdOrSku		The destination product id or sku.

Child Elements

<magento:attributes> Optional. The link attributes

<magento:cancel-order>

Cancels an order

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
orderId		The order to cancel

Child Elements

<magento:cancel-order-invoice>

Cancels an order's invoice

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
invoiceId		The invoice id

Child Elements

<magento:capture-order-invoice>

Captures and invoice

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
invoiceId		The invoice to capture

Child Elements

<magento:create-category>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
parentId		The parent category id
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

<magento:attributes> The new category attributes

Return Payload

the new category id

<magento:create-customer>

Creates a customer with the given attributes

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

<magento:attributes> The attributes of the new customer

Return Payload

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
config-ref		Optional. Specify which configuration to use.
customerId		The customer

Child Elements

<magento:attributes> The address attributes

Return Payload

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
config-ref		Optional. Specify which configuration to use.
orderId		The id of the order
comment		Optional. An optional comment
sendEmail		Optional. If an email must be sent after shipment creation
includeCommentInEmail		Optional. If the comment must be sent in the email

Child Elements

<magento:itemsQuantities> A map containing an entry per each (orderItemId, quantity) pair

Return Payload

the new invoice's id

<magento:create-order-shipment>

Creates a shipment for order

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
orderId		The order increment id
comment		Optional. An optional comment
sendEmail		Optional. If an email must be sent after shipment creation
includeCommentInEmail		Optional. If the comment must be sent in the email

Child Elements

<magento:itemsQuantities> A map containing an entry per each (orderItemId, quantity) pair

Return Payload

the new shipment's id

<magento:create-product>

Creates a new product

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		The new product's type
set		The new product's set
sku		The new product's sku
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

<magento:attributes> Optional. The standard attributes of the new product
<magento:additionalAttributes> Optional. The non standard attributes of the new product

Return Payload

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
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store
payload		The image to upload. It may be a file, an input stream or a byte array
mimeType		The mimetype
baseFileName		Optional. The base name of the new remote image

Child Elements

<magento:attributes> Optional. The media attributes

Return Payload

the new image filename

Exception Payload

FileNotFoundException

<magento:delete-category>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
categoryId		The category to delete

Child Elements

<magento:delete-category-product>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
categoryId		The category to delete
productId		Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.

Child Elements

<magento:delete-customer>

Deletes a customer given its id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
customerId		The customer to delete

Child Elements

<magento:delete-customer-address>

Deletes a Customer Address

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
addressId		The address id to delete

Child Elements

<magento:delete-order-shipment-track>

Deletes the given track of the given order's shipment

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
shipmentId		The target shipment id
trackId		The id of the track to delete

Child Elements

<magento:delete-product>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.

Child Elements

<magento:delete-product-attribute-media>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.
fileName		The remote media file to delete

Child Elements

<magento:delete-product-link>

Deletes a product's link.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Link type
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
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
productIdOrSku		Optional. The id or sku of the source product.
linkedProductIdOrSku		The linked product id or sku

Child Elements

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

Answers the current default catalog store view id for this session

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

Return Payload

the current default store view id

<magento:get-category>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
categoryId		The category whose attributes will be retrieved
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

<magento:attributeNames> The category attributes that will be retrieved

Return Payload

the category attributes

<magento:get-category-tree>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
parentId		The parent id
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.
customerId		The id of the customer to retrieve

Child Elements

<magento:attributeNames> The attributes to retrieve. Not empty

Return Payload

the attributes map

<magento:get-customer-address>

Answers the customer address attributes

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
addressId		The id of the address

Child Elements

Return Payload

the customer address attributes map

<magento:get-order>

Answers the order properties for the given orderId

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
orderId		The order whose properties to fetch

Child Elements

Return Payload

a string-object map of order properties

<magento:get-order-invoice>

Retrieves order invoice information

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
invoiceId		The target invoiceId

Child Elements

Return Payload

the invoice attributes

<magento:get-order-shipment>

Retrieves the order shipment attributes

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
shipmentId		The id of the shipment

Child Elements

Return Payload

the shipment attributes

<magento:get-order-shipment-carriers>

Retrieves the order shipment carriers.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
orderId		The target order id

Child Elements

Return Payload

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	Default Value	Description
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

<magento:attributesNames> Optional. The list of standard attributes to be returned
<magento:additionalAttributeNames> Optional. The list of non standard attributes to be returned in the additionalAttributes attribute

Return Payload

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	Default Value	Description
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.
fileName		The name of the file
storeViewIdOrCode		Optional. The store view id or code

Child Elements

Return Payload

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	Default Value	Description
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.
orderId		The order to put on hold state

Child Elements

<magento:list-category-attribute-options>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
attributeId		The target attribute whose options will be retrieved
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.
website		Optional. The website
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store
parentCategoryId		Optional. The parent category of the categories that will be listed

Child Elements

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.
categoryId		The category

Child Elements

Return Payload

the listing of category products

<magento:list-customer-addresses>

Lists the customer address for a given customer id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
customerId		The id of the customer

Child Elements

Return Payload

a listing of addresses

<magento:list-customer-groups>

Lists all the customer groups

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

Return Payload

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	Default Value	Description
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.

Child Elements

Return Payload

the list of attributes map

<magento:list-directory-countries>

Answers the list of countries

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

Return Payload

a collection of countries attributes

<magento:list-directory-regions>

Answers a list of regions for the given county

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
countryId		The country code, in ISO2 or ISO3 format

Child Elements

Return Payload

the collection of regions attributes

<magento:list-inventory-stock-items>

Lists inventory stock items.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

<magento:productIdOrSkus> The list of product ids and/or skus whose attributes will be retrieved

Return Payload

the list of attributes

<magento:list-orders>

Lists order attributes that match the given filtering expression.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
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.

Child Elements

Return Payload

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	Default Value	Description
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.

Child Elements

Return Payload

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	Default Value	Description
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.

Child Elements

Return Payload

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	Default Value	Description
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.
setId		The setId

Child Elements

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.
attributeId		The target attribute whose options will be listed
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

Return Payload

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	Default Value	Description
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.

Child Elements

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.
setId		The set id

Child Elements

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		The link type
productId		Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.

Child Elements

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		The product type

Child Elements

Return Payload

the listing of product attributes

<magento:list-product-link-types>

Answers product link types

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

Return Payload

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	Default Value	Description
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.
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

Return Payload

the list of product attributes that match the given optional filtering expression

<magento:list-stock-items>

Retrieve stock data by product ids

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

<magento:productIdOrSkus> A not empty list of product ids or skus whose attributes to list

Return Payload

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	Default Value	Description
config-ref		Optional. Specify which configuration to use.
categoryId		The id of the category to be moved
parentId		The new parent category id
afterId		Optional. An optional category id for use as reference in the positioning of the moved category

Child Elements

<magento:unhold-order>

Releases order

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
orderId		The id of the order to remove from hold state

Child Elements

<magento:update-category>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
categoryId		The category to update
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

<magento:attributes> The category new attributes

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

Set the default catalog store view for this session

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
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

Child Elements

<magento:update-category-product>

Updates a category product.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
categoryId		The category id
productId		Optional. The id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.
position		The category position for ordering the category inside its level

Child Elements

<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
config-ref		Optional. Specify which configuration to use.
customerId		The target customer to update

Child Elements

<magento:attributes> The attributes map

<magento:update-customer-address>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
addressId		The customer address to update

Child Elements

<magento:attributes> The address attributes to update

<magento:update-inventory-stock-item>

Updates an stock inventory item

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.

Child Elements

<magento:attributes> The new attributes of the stock item

<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
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

<magento:attributes> Optional. The map of standard product attributes to update
<magento:additionalAttributes> Optional. The map of non standard product attributes to update

<magento:update-product-attribute-media>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.
fileName		The name of the remote media file to update
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

<magento:attributes> The attributes to update

<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
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.

Child Elements

<magento:attributes> The tier price to update.

<magento:update-product-link>

Update product link

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		The link type
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
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
productIdOrSku		Optional. The id or sku of the source product.
linkedProductIdOrSku		The destination product id or sku.

Child Elements

<magento:attributes> The link attributes

<magento:update-product-special-price>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
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
productSku		Optional. The sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku
productIdOrSku		Optional. The id or sku of the product.
specialPrice		The special price to set
fromDate		Optional. Optional start date of the special price period
toDate		Optional. Optional end date of the special price period
storeViewIdOrCode		Optional. The id or code of the target store. Left unspecified for using current store

Child Elements

<magento:update-stock-item>

Update product stock data given its id or sku

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
productIdOrSku		The product id or sku of the product to update

Child Elements

<magento:attributes> The attributes to update

<magento:void-order-invoice>

Voids an invoice

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
invoiceId		The invoice id