English
资源说明：Mule Cloud Connector for Magento
Mule Magento Cloud Connector
============================
Mule Cloud connector to Magento
Installation
------------
The connector can either be installed for all applications running within the Mule instance or can be setup to be used
for a single application.
*All Applications*
Download the connector from the link above and place the resulting jar file in
/lib/user directory of the Mule installation folder.
*Single Application*
To make the connector available only to single application then place it in the
lib directory of the application otherwise if using Maven to compile and deploy
your application the following can be done:
Add the connector's maven repo to your pom.xml:
muleforge-releases
MuleForge Snapshot Repository
https://repository.muleforge.org/release/
default
Add the connector as a dependency to your project. This can be done by adding
the following under the dependencies element in the pom.xml file of the
application:
org.mule.modules
mule-module-magento
1.3-SNAPSHOT
Configuration
-------------
You can configure the connector as follows:
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|orderId|the order increment id|no||
|itemsQuantities|a map containing an entry per each (orderItemId, quantity) pair|no||
|comment|an optional comment|yes||
|sendEmail|if an email must be sent after shipment creation|yes|false|
|includeCommentInEmail|if the comment must be sent in the email|yes|false|
Returns new shipment's id
Get Order
---------
Answers the order properties for the given orderId
Example:
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|customerId|the customer|no||
|attributes|the address attributes|no||
Returns new customer address id
Create Customer
---------------
Creates a customer with the given attributes
Example:
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|attributes|the attributes of the new customer|no||
Returns new customer id
Delete Customer
---------------
Deletes a customer given its id
Example:
customer_name
customer_last_name
customer_age
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|customerId||no||
|attributeNames|the attributes to retrieve. Not empty|no||
Returns attributes map
Get Customer Address
--------------------
Answers the customer address attributes
Example:
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|customerId|the target customer to update|no||
|attributes|the attributes map|no||
Update Customer Address
-----------------------
Updates the given map of customer address attributes, for the given customer address
Example:
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|addressId|the customer address to update|no||
|attributes|the address attributes to update|no||
List Stock Items
----------------
Retrieve stock data by product ids
Example:
1560
JJFO986
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|productIdOrSkus|a not empty list of product ids or skus whose attributes to list|no||
Returns list of stock items attributes
Update Stock Item
-----------------
Update product stock data given its id or sku
Example:
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|productIdOrSku|the product id or sku of the product to update|no||
|attributes||no||
List Directory Countries
------------------------
Answers the list of countries
Example:
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|productId|the id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id|yes||
|productSku|the sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku|yes||
|productIdOrSku|the id or sku of the product.|yes||
|attributes|the media attributes|yes||
|storeViewIdOrCode|the id or code of the target store. Left unspecified for using current store|yes||
|content|the image to upload. It may be a file, an input stream or a byte array|no||
|mimeType|the mimetype|no||*JPEG*, *GIF*, *PNG*
|baseFileName|the base name of the new remote image|yes||
Returns new image filename
Delete Product Attribute Media
------------------------------
Removes a product image. See catalog-product-attribute-media-remove SOAP
method.
Example:
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|productId|the id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id|yes||
|productSku|the sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku|yes||
|productIdOrSku|the id or sku of the product.|yes||
|fileName|the name of the remote media file to update|no||
|attributes||no||
|storeViewIdOrCode|the id or code of the target store. Left unspecified for using current store|yes||
Update Product Attribute Tier Price
-----------------------------------
Updates a single product tier price. See catalog-product-attribute-tier-price-update
SOAP method.
Example:
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|type|the link type|no||
|productId|the id of the source product. Use it instead of productIdOrSku in case you are sure the source product identifier is a product id|yes||
|productSku|the sku of the source product. Use it instead of productIdOrSku in case you are sure the source product identifier is a product sku|yes||
|productIdOrSku|the id or sku of the source product.|yes||
|linkedProductIdOrSku|the destination product id or sku.|no||
|attributes|the link attributes|no||
List Category Products
----------------------
Lists product of a given category. See catalog-category-assignedProducts SOAP method.
Example:
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|categoryId|the category to update|no||
|attributes|the category new attributes|no||
|storeViewIdOrCode|the id or code of the target store. Left unspecified for using current store|yes||
Update Category Product
-----------------------
Updates a category product
Example:
1560
10036
9868
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|productIdOrSkus||no||
Returns list of attributes
Update Inventory Stock Item
---------------------------
Updates an stock inventory item
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|productId|the id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id|yes||
|productSku|the sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku|yes||
|productIdOrSku|the id or sku of the product.|yes||
|attributes|the new attributes of the stock item|no||
Create Product
--------------
Creates a new product
Example:
keyboard_distribution_type
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|productId|the id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id|yes||
|productSku|the sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku|yes||
|productIdOrSku|the id or sku of the product.|yes||
|storeViewIdOrCode|the id or code of the target store. Left unspecified for using current store|yes||
|attributesNames||yes||
|additionalAttributeNames|the list of non standard attributes to be returned in the additionalAttributes attribute|yes||
Returns attributes
List Products
-------------
Retrieve products list by filters. See catalog-product-list SOAP method.
Example:
| attribute | description | optional | default value | possible values |
|:-----------|:-----------|:---------|:--------------|:----------------|
|config-ref|Specify which configuration to use for this invocation|yes||
|productId|the id of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product id|yes||
|productSku|the sku of the product. Use it instead of productIdOrSku in case you are sure the product identifier is a product sku|yes||
|productIdOrSku|the id or sku of the product.|yes||
|attributes|the not empty map of product attributes to update|no||
|storeViewIdOrCode|the id or code of the target store. Left unspecified for using current store|yes||
本源码包内暂不包含可直接显示的源代码文件，请下载源码包。
