Summary: Methods | [Expand All]
public interface

MagentoCatalogClient

org.mule.module.magento.api.catalog.MagentoCatalogClient<ExceptionType extends java.lang.Exception>
Known Indirect Subclasses

Summary

Public Methods
abstract void addCategoryProduct(int categoryId, ProductIdentifier productId, String position)
Assign product to category.
abstract void addProductLink(String type, ProductIdentifier productId, String linkedProductIdOrSku, CatalogProductLinkEntity attributes)
Links two products
abstract int createCategory(int parentId, CatalogCategoryEntityCreate attributes, String storeView)
Creates a new category.
abstract int createProduct(String type, int set, String sku, CatalogProductCreateEntity attributes, List<AssociativeEntity> additionalAttributes, String storeView)
Creates a new product
abstract String createProductAttributeMedia(ProductIdentifier productId, CatalogProductAttributeMediaCreateEntity attributes, InputStream content, MediaMimeType mimeType, String baseFileName, String storeView)
Creates a new product media.
abstract boolean deleteCategory(int categoryId)
Deletes a category.
abstract boolean deleteCategoryProduct(int categoryId, ProductIdentifier productId)
Remove a product assignment.
abstract int deleteProduct(ProductIdentifier productId)
Deletes a product.
abstract int deleteProductAttributeMedia(ProductIdentifier productId, String file)
Removes a product image.
abstract String deleteProductLink(String type, ProductIdentifier productId, String linkedProductIdOrSku)
Deletes a product's link
abstract int getCatalogCurrentStoreView()
Answers the current default catalog store view id for this session
abstract CatalogCategoryInfo getCategory(int categoryId, String storeView, List<String> attributeNames)
Answers category attributes.
abstract CatalogCategoryTree getCategoryTree(String parentId, String storeView)
Retrieve hierarchical tree.
abstract CatalogProductReturnEntity getProduct(ProductIdentifier productId, String storeView, List<String> attributeNames, List<String> additionalAttributeNames)
Answers a product's specified attributes.
abstract CatalogProductImageEntity getProductAttributeMedia(ProductIdentifier productId, String file, String storeView)
Answers product image attributes.
abstract CatalogProductReturnEntity getProductSpecialPrice(ProductIdentifier productId, String storeView)
Answers a product special price.
abstract List<CatalogAttributeOptionEntity> listCategoryAttributeOptions(String attributeId, String storeView)
Retrieves attribute options.
abstract List<CatalogAttributeEntity> listCategoryAttributes()
Retrieves category attributes.
abstract List<CatalogCategoryEntityNoChildren> listCategoryLevels(String website, String storeView, String parentCategory)
Answers levels of categories for a website, store view and parente category@return
abstract List<CatalogAssignedProduct> listCategoryProducts(int categoryId)
Lists product of a given category.
abstract List<CatalogInventoryStockItemEntity> listInventoryStockItems(List<String> products)
abstract List<CatalogProductImageEntity> listProductAttributeMedia(ProductIdentifier productId, String storeViewIdOrCode)
Retrieves product image list.
abstract List<CatalogProductAttributeMediaTypeEntity> listProductAttributeMediaTypes(int setId)
Retrieve product image types.
abstract List<CatalogAttributeOptionEntity> listProductAttributeOptions(String attributeId, String storeView)
Answers the product attribute options.
abstract List<CatalogProductAttributeSetEntity> listProductAttributeSets()
Retrieves product attribute sets.
abstract List<CatalogProductTierPriceEntity> listProductAttributeTierPrices(ProductIdentifier productId)
Retrieve product tier prices.
abstract List<CatalogAttributeEntity> listProductAttributes(int setId)
Retrieves product attributes list.
abstract List<CatalogProductLinkEntity> listProductLink(String type, ProductIdentifier productId)
Lists linked products to the given product and for the given link type
abstract List<CatalogProductLinkAttributeEntity> listProductLinkAttributes(String type)
Lists all the attributes for the given product link type
abstract List<String> listProductLinkTypes()
Retrieve product link types
abstract List<CatalogProductTypeEntity> listProductTypes()
Retrieves product types.
abstract List<CatalogProductEntity> listProducts(String filters, String storeView)
Retrieve products list by filters See catalog-product-list SOAP method.
abstract void moveCategory(int categoryId, int parentId, String afterId)
Move category in tree.
abstract void updateCatalogCurrentStoreView(String storeViewIdOrCode)
Set the default catalog store view for this session
abstract void updateCategory(int categoryId, CatalogCategoryEntityCreate attributes, String storeView)
Updates a category.
abstract void updateCategoryProduct(int categoryId, ProductIdentifier productId, String position)
abstract void updateInventoryStockItem(ProductIdentifier productId, CatalogInventoryStockItemUpdateEntity attributes)
Updates an stock inventory item
abstract void updateProduct(ProductIdentifier productId, CatalogProductCreateEntity attributes, List<AssociativeEntity> additionalAttributes, String storeView)
Updates a product.
abstract void updateProductAttributeMedia(ProductIdentifier productId, String fileName, CatalogProductAttributeMediaCreateEntity attributes, String storeView)
Updates product media.
abstract void updateProductAttributeTierPrice(ProductIdentifier productId, CatalogProductTierPriceEntity attributes)
Updates a single product tier price.
abstract void updateProductLink(String type, ProductIdentifier productId, String linkedProduct, CatalogProductLinkEntity attributes)
Update product link
abstract void updateProductSpecialPrice(ProductIdentifier productId, String specialPrice, String fromDate, String toDate, String storeView)
Sets a product special price.

Public Methods

public abstract void addCategoryProduct (int categoryId, ProductIdentifier productId, String position)

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

Parameters
categoryId
productId
position
Throws
Exception

public abstract void addProductLink (String type, ProductIdentifier productId, String linkedProductIdOrSku, CatalogProductLinkEntity attributes)

Links two products

Parameters
type The product type
productId
linkedProductIdOrSku
attributes The link attributes
Throws
Exception

public abstract int createCategory (int parentId, CatalogCategoryEntityCreate attributes, String storeView)

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

Parameters
parentId
attributes
storeView
Returns
  • the new category id
Throws
Exception

public abstract int createProduct (String type, int set, String sku, CatalogProductCreateEntity attributes, List<AssociativeEntity> additionalAttributes, String storeView)

Creates a new product

Parameters
type The new product's type
set The new product's set
sku The new product's sku
attributes The standard attributes of the new product
additionalAttributes The non standard attributes of the new product
storeView
Returns
  • the new product's id
Throws
Exception

public abstract String createProductAttributeMedia (ProductIdentifier productId, CatalogProductAttributeMediaCreateEntity attributes, InputStream content, MediaMimeType mimeType, String baseFileName, String storeView)

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

Parameters
productId
attributes
content
mimeType
baseFileName
storeView
Returns
  • the new image filename
Throws
Exception

public abstract boolean deleteCategory (int categoryId)

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

Parameters
categoryId
Returns
  • if the category is deleted
Throws
Exception

public abstract boolean deleteCategoryProduct (int categoryId, ProductIdentifier productId)

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

Parameters
categoryId
productId
Returns
  • if the product is removed from the category
Throws
Exception

public abstract int deleteProduct (ProductIdentifier productId)

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

Parameters
productId The product identifier
Returns
  • if the product is deleted
Throws
Exception

public abstract int deleteProductAttributeMedia (ProductIdentifier productId, String file)

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

Parameters
productId
file
Returns
  • if the image is removed from a product
Throws
Exception

public abstract String deleteProductLink (String type, ProductIdentifier productId, String linkedProductIdOrSku)

Deletes a product's link

Parameters
type Link type
productId
linkedProductIdOrSku
Returns
  • if the link is removed from a product
Throws
Exception

public abstract int getCatalogCurrentStoreView ()

Answers the current default catalog store view id for this session

Returns
  • the current default store view id
Throws
Exception

public abstract CatalogCategoryInfo getCategory (int categoryId, String storeView, List<String> attributeNames)

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

Parameters
categoryId
storeView
attributeNames
Returns
  • the category attributes
Throws
Exception

public abstract CatalogCategoryTree getCategoryTree (String parentId, String storeView)

Retrieve hierarchical tree. See catalog-category-tree SOAP method.

Parameters
parentId
storeView
Throws
Exception

public abstract CatalogProductReturnEntity getProduct (ProductIdentifier productId, String storeView, List<String> attributeNames, List<String> additionalAttributeNames)

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.

Parameters
productId
storeView
attributeNames The list of standard attributes to be returned
additionalAttributeNames The list of non standard attributes to be returned in the additionalAttributes attribute
Returns
  • the product attributes
Throws
Exception

public abstract CatalogProductImageEntity getProductAttributeMedia (ProductIdentifier productId, String file, String storeView)

Answers product image attributes. See catalog-product-attribute-media-info SOAP method

Parameters
productId
file
storeView
Returns
  • the product attributes
Throws
Exception

public abstract CatalogProductReturnEntity getProductSpecialPrice (ProductIdentifier productId, String storeView)

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

Parameters
productId
storeView
Throws
Exception

public abstract List<CatalogAttributeOptionEntity> listCategoryAttributeOptions (String attributeId, String storeView)

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

Parameters
attributeId
storeView
Returns
  • the list of attributes
Throws
Exception

public abstract List<CatalogAttributeEntity> listCategoryAttributes ()

Retrieves category attributes. See catalog-category-attribute-list SOAP method.

Returns
  • the list of attributes
Throws
Exception

public abstract List<CatalogCategoryEntityNoChildren> listCategoryLevels (String website, String storeView, String parentCategory)

Answers levels of categories for a website, store view and parente category@return

Parameters
website
storeView
parentCategory
Throws
Exception

public abstract List<CatalogAssignedProduct> listCategoryProducts (int categoryId)

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

Parameters
categoryId
Returns
  • the listing of category products
Throws
Exception

public abstract List<CatalogInventoryStockItemEntity> listInventoryStockItems (List<String> products)

Parameters
products
Throws
Exception

public abstract List<CatalogProductImageEntity> listProductAttributeMedia (ProductIdentifier productId, String storeViewIdOrCode)

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

Parameters
productId
storeViewIdOrCode
Throws
Exception

public abstract List<CatalogProductAttributeMediaTypeEntity> listProductAttributeMediaTypes (int setId)

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

Parameters
setId
Throws
Exception

public abstract List<CatalogAttributeOptionEntity> listProductAttributeOptions (String attributeId, String storeView)

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

Parameters
attributeId
storeView
Returns
  • the attributes list
Throws
Exception

public abstract List<CatalogProductAttributeSetEntity> listProductAttributeSets ()

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

Returns
  • The list of product attributes sets
Throws
Exception

public abstract List<CatalogProductTierPriceEntity> listProductAttributeTierPrices (ProductIdentifier productId)

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

Parameters
productId
Returns
  • the list of product attributes
Throws
Exception

public abstract List<CatalogAttributeEntity> listProductAttributes (int setId)

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

Parameters
setId
Returns
  • the list of product attributes
Throws
Exception

public abstract List<CatalogProductLinkEntity> listProductLink (String type, ProductIdentifier productId)

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

Parameters
type The link type
productId The linked product
Returns
  • the list of links to the product
Throws
Exception

public abstract List<CatalogProductLinkAttributeEntity> listProductLinkAttributes (String type)

Lists all the attributes for the given product link type

Parameters
type The product type
Returns
  • the listing of product attributes
Throws
Exception

public abstract List<String> listProductLinkTypes ()

Retrieve product link types

Returns
  • the list of product link types
Throws
Exception

public abstract List<CatalogProductTypeEntity> listProductTypes ()

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

Returns
  • the list of product types
Throws
Exception

public abstract List<CatalogProductEntity> listProducts (String filters, String storeView)

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

Parameters
filters An optional filtering expression
storeView
Returns
  • the list of product attributes that match the given optional filtering expression
Throws
Exception

public abstract void moveCategory (int categoryId, int parentId, String afterId)

Move category in tree. See catalog-category-move SOAP method. NOTE 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

Parameters
categoryId
parentId
afterId
Throws
Exception

public abstract void updateCatalogCurrentStoreView (String storeViewIdOrCode)

Set the default catalog store view for this session

Parameters
storeViewIdOrCode The id or code of the store view to set as default for this session
Throws
Exception

public abstract void updateCategory (int categoryId, CatalogCategoryEntityCreate attributes, String storeView)

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

Parameters
categoryId
attributes
storeView
Throws
Exception

public abstract void updateCategoryProduct (int categoryId, ProductIdentifier productId, String position)

Parameters
categoryId
productId
position
Throws
Exception

public abstract void updateInventoryStockItem (ProductIdentifier productId, CatalogInventoryStockItemUpdateEntity attributes)

Updates an stock inventory item

Parameters
productId
attributes
Throws
Exception

public abstract void updateProduct (ProductIdentifier productId, CatalogProductCreateEntity attributes, List<AssociativeEntity> additionalAttributes, String storeView)

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

Parameters
productId
attributes Standard product attributes to update
additionalAttributes Non standard product attributes to update
storeView
Throws
Exception

public abstract void updateProductAttributeMedia (ProductIdentifier productId, String fileName, CatalogProductAttributeMediaCreateEntity attributes, String storeView)

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

Parameters
productId
fileName
attributes
storeView
Throws
Exception

public abstract void updateProductAttributeTierPrice (ProductIdentifier productId, CatalogProductTierPriceEntity attributes)

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

Parameters
productId
attributes
Throws
Exception

public abstract void updateProductLink (String type, ProductIdentifier productId, String linkedProduct, CatalogProductLinkEntity attributes)

Update product link

Parameters
type
productId
linkedProduct
attributes
Throws
Exception

public abstract void updateProductSpecialPrice (ProductIdentifier productId, String specialPrice, String fromDate, String toDate, String storeView)

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

Parameters
productId
specialPrice
fromDate
toDate
storeView
Throws
Exception