public class

Mage_Api_Model_Server_V2_HandlerBindingStub

extends Stub
implements Mage_Api_Model_Server_V2_HandlerPortType
java.lang.Object
   ↳ org.apache.axis.client.Stub
     ↳ com.magento.api.Mage_Api_Model_Server_V2_HandlerBindingStub

Summary

[Expand]
Inherited Constants
From interface javax.xml.rpc.Stub
Fields
static OperationDesc[] _operations
private Vector cachedDeserFactories
private Vector cachedSerClasses
private Vector cachedSerFactories
private Vector cachedSerQNames
[Expand]
Inherited Fields
From class org.apache.axis.client.Stub
Public Constructors
Mage_Api_Model_Server_V2_HandlerBindingStub()
Mage_Api_Model_Server_V2_HandlerBindingStub(URL endpointURL, Service service)
Mage_Api_Model_Server_V2_HandlerBindingStub(Service service)
Public Methods
boolean catalogCategoryAssignProduct(String sessionId, int categoryId, String product, String position, String productIdentifierType)
Assign product to category
CatalogAssignedProduct[] catalogCategoryAssignedProducts(String sessionId, int categoryId)
Retrieve list of assigned products
int catalogCategoryAttributeCurrentStore(String sessionId, String storeView)
Set/Get current store view
CatalogAttributeEntity[] catalogCategoryAttributeList(String sessionId)
Retrieve category attributes
CatalogAttributeOptionEntity[] catalogCategoryAttributeOptions(String sessionId, String attributeId, String storeView)
Retrieve attribute options
int catalogCategoryCreate(String sessionId, int parentId, CatalogCategoryEntityCreate categoryData, String storeView)
Create new category and return its id.
int catalogCategoryCurrentStore(String sessionId, String storeView)
Set_Get current store view
boolean catalogCategoryDelete(String sessionId, int categoryId)
Delete category
CatalogCategoryInfo catalogCategoryInfo(String sessionId, int categoryId, String storeView, String[] attributes)
Retrieve hierarchical tree of categories.
CatalogCategoryEntityNoChildren[] catalogCategoryLevel(String sessionId, String website, String storeView, String parentCategory)
Retrieve hierarchical tree of categories.
boolean catalogCategoryMove(String sessionId, int categoryId, int parentId, String afterId)
Move category in tree
boolean catalogCategoryRemoveProduct(String sessionId, int categoryId, String product, String productIdentifierType)
Remove product assignment from category
CatalogCategoryTree catalogCategoryTree(String sessionId, String parentId, String storeView)
Retrieve hierarchical tree of categories.
boolean catalogCategoryUpdate(String sessionId, int categoryId, CatalogCategoryEntityCreate categoryData, String storeView)
Update category
boolean catalogCategoryUpdateProduct(String sessionId, int categoryId, String product, String position, String productIdentifierType)
Update assigned product
CatalogInventoryStockItemEntity[] catalogInventoryStockItemList(String sessionId, String[] products)
Retrieve stock data by product ids
int catalogInventoryStockItemUpdate(String sessionId, String product, CatalogInventoryStockItemUpdateEntity data)
Update product stock data
boolean catalogProductAttributeAddOption(String sessionId, String attribute, CatalogProductAttributeOptionEntityToAdd data)
Add option to attribute
int catalogProductAttributeCreate(String sessionId, CatalogProductAttributeEntityToCreate data)
Create new attribute
int catalogProductAttributeCurrentStore(String sessionId, String storeView)
Set/Get current store view
CatalogProductAttributeEntity catalogProductAttributeInfo(String sessionId, String attribute)
Get full information about attribute with list of options
CatalogAttributeEntity[] catalogProductAttributeList(String sessionId, int setId)
Retrieve attribute list
String catalogProductAttributeMediaCreate(String sessionId, String product, CatalogProductAttributeMediaCreateEntity data, String storeView, String productIdentifierType)
Upload new product image
int catalogProductAttributeMediaCurrentStore(String sessionId, String storeView)
Set/Get current store view
CatalogProductImageEntity catalogProductAttributeMediaInfo(String sessionId, String product, String file, String storeView, String productIdentifierType)
Retrieve product image data
CatalogProductImageEntity[] catalogProductAttributeMediaList(String sessionId, String product, String storeView, String productIdentifierType)
Retrieve product image list
boolean catalogProductAttributeMediaRemove(String sessionId, String product, String file, String productIdentifierType)
Remove product image
CatalogProductAttributeMediaTypeEntity[] catalogProductAttributeMediaTypes(String sessionId, String setId)
Retrieve product image types
boolean catalogProductAttributeMediaUpdate(String sessionId, String product, String file, CatalogProductAttributeMediaCreateEntity data, String storeView, String productIdentifierType)
Update product image
CatalogAttributeOptionEntity[] catalogProductAttributeOptions(String sessionId, String attributeId, String storeView)
Retrieve attribute options
boolean catalogProductAttributeRemove(String sessionId, String attribute)
Delete attribute
boolean catalogProductAttributeRemoveOption(String sessionId, String attribute, String optionId)
Remove option from attribute
boolean catalogProductAttributeSetAttributeAdd(String sessionId, String attributeId, String attributeSetId, String attributeGroupId, String sortOrder)
Add attribute into attribute set
boolean catalogProductAttributeSetAttributeRemove(String sessionId, String attributeId, String attributeSetId)
Remove attribute from attribute set
int catalogProductAttributeSetCreate(String sessionId, String attributeSetName, String skeletonSetId)
Create product attribute set based on another set
int catalogProductAttributeSetGroupAdd(String sessionId, String attributeSetId, String groupName)
Create group within existing attribute set
boolean catalogProductAttributeSetGroupRemove(String sessionId, String attributeGroupId)
Remove group from attribute set
boolean catalogProductAttributeSetGroupRename(String sessionId, String groupId, String groupName)
Rename existing group
CatalogProductAttributeSetEntity[] catalogProductAttributeSetList(String sessionId)
Retrieve product attribute sets
boolean catalogProductAttributeSetRemove(String sessionId, String attributeSetId, String forceProductsRemove)
Remove product attribute set
CatalogProductTierPriceEntity[] catalogProductAttributeTierPriceInfo(String sessionId, String product, String productIdentifierType)
Retrieve product tier prices
int catalogProductAttributeTierPriceUpdate(String sessionId, String product, CatalogProductTierPriceEntity[] tier_price, String productIdentifierType)
Update product tier prices
CatalogAttributeOptionEntity[] catalogProductAttributeTypes(String sessionId)
Get list of possible attribute types
boolean catalogProductAttributeUpdate(String sessionId, String attribute, CatalogProductAttributeEntityToUpdate data)
Update attribute
int catalogProductCreate(String sessionId, String type, String set, String sku, CatalogProductCreateEntity productData, String storeView)
Create new product and return product id
int catalogProductCurrentStore(String sessionId, String storeView)
Set/Get current store view
boolean catalogProductCustomOptionAdd(String sessionId, String productId, CatalogProductCustomOptionToAdd data, String store)
Add new custom option into product
CatalogProductCustomOptionInfoEntity catalogProductCustomOptionInfo(String sessionId, String optionId, String store)
Get full information about custom option in product
CatalogProductCustomOptionListEntity[] catalogProductCustomOptionList(String sessionId, String productId, String store)
Retrieve list of product custom options
boolean catalogProductCustomOptionRemove(String sessionId, String optionId)
Remove custom option
CatalogProductCustomOptionTypesEntity[] catalogProductCustomOptionTypes(String sessionId)
Get list of available custom option types
boolean catalogProductCustomOptionUpdate(String sessionId, String optionId, CatalogProductCustomOptionToUpdate data, String store)
Update product custom option
boolean catalogProductCustomOptionValueAdd(String sessionId, String optionId, CatalogProductCustomOptionValueAddEntity[] data, String store)
Add new custom option values
CatalogProductCustomOptionValueInfoEntity catalogProductCustomOptionValueInfo(String sessionId, String valueId, String store)
Retrieve custom option value info
CatalogProductCustomOptionValueListEntity[] catalogProductCustomOptionValueList(String sessionId, String optionId, String store)
Retrieve custom option values list
boolean catalogProductCustomOptionValueRemove(String sessionId, String valueId)
Remove value from custom option
boolean catalogProductCustomOptionValueUpdate(String sessionId, String valueId, CatalogProductCustomOptionValueUpdateEntity data, String storeId)
Update custom option value
int catalogProductDelete(String sessionId, String product, String productIdentifierType)
Delete product
int catalogProductDownloadableLinkAdd(String sessionId, String productId, CatalogProductDownloadableLinkAddEntity resource, String resourceType, String store, String identifierType)
Add links to downloadable product
CatalogProductDownloadableLinkInfoEntity catalogProductDownloadableLinkList(String sessionId, String productId, String store, String identifierType)
Retrieve list of links and samples for downloadable product
boolean catalogProductDownloadableLinkRemove(String sessionId, String linkId, String resourceType)
Remove links and samples from downloadable product
CatalogProductReturnEntity catalogProductGetSpecialPrice(String sessionId, String product, String storeView, String productIdentifierType)
Get product special price data
CatalogProductReturnEntity catalogProductInfo(String sessionId, String product, String storeView, CatalogProductRequestAttributes attributes, String productIdentifierType)
Retrieve product
boolean catalogProductLinkAssign(String sessionId, String type, String product, String linkedProduct, CatalogProductLinkEntity data, String productIdentifierType)
Assign product link
CatalogProductLinkAttributeEntity[] catalogProductLinkAttributes(String sessionId, String type)
Retrieve product link type attributes
CatalogProductLinkEntity[] catalogProductLinkList(String sessionId, String type, String product, String productIdentifierType)
Retrieve linked products
boolean catalogProductLinkRemove(String sessionId, String type, String product, String linkedProduct, String productIdentifierType)
Remove product link
String[] catalogProductLinkTypes(String sessionId)
Retrieve product link types
boolean catalogProductLinkUpdate(String sessionId, String type, String product, String linkedProduct, CatalogProductLinkEntity data, String productIdentifierType)
Update product link
CatalogProductEntity[] catalogProductList(String sessionId, Filters filters, String storeView)
Retrieve products list by filters
CatalogAttributeEntity[] catalogProductListOfAdditionalAttributes(String sessionId, String productType, String attributeSetId)
Get list of additional attributes which are not in default create/update list
int catalogProductSetSpecialPrice(String sessionId, String product, String specialPrice, String fromDate, String toDate, String storeView, String productIdentifierType)
Update product special price
AssociativeEntity[] catalogProductTagAdd(String sessionId, CatalogProductTagAddEntity data)
Add tag(s) to product
CatalogProductTagInfoEntity catalogProductTagInfo(String sessionId, String tagId, String store)
Retrieve product tag info
CatalogProductTagListEntity[] catalogProductTagList(String sessionId, String productId, String store)
Retrieve list of tags by product
boolean catalogProductTagRemove(String sessionId, String tagId)
Remove product tag
boolean catalogProductTagUpdate(String sessionId, String tagId, CatalogProductTagUpdateEntity data, String store)
Update product tag
CatalogProductTypeEntity[] catalogProductTypeList(String sessionId)
Retrieve product types
boolean catalogProductUpdate(String sessionId, String product, CatalogProductCreateEntity productData, String storeView, String productIdentifierType)
Update product
int customerAddressCreate(String sessionId, int customerId, CustomerAddressEntityCreate addressData)
Create customer address
boolean customerAddressDelete(String sessionId, int addressId)
Delete customer address
CustomerAddressEntityItem customerAddressInfo(String sessionId, int addressId)
Retrieve customer address data
CustomerAddressEntityItem[] customerAddressList(String sessionId, int customerId)
Retrieve customer addresses
boolean customerAddressUpdate(String sessionId, int addressId, CustomerAddressEntityCreate addressData)
Update customer address data
int customerCustomerCreate(String sessionId, CustomerCustomerEntityToCreate customerData)
Create customer
boolean customerCustomerDelete(String sessionId, int customerId)
Delete customer
CustomerCustomerEntity customerCustomerInfo(String sessionId, int customerId, String[] attributes)
Retrieve customer data
CustomerCustomerEntity[] customerCustomerList(String sessionId, Filters filters)
Retrieve customers
boolean customerCustomerUpdate(String sessionId, int customerId, CustomerCustomerEntityToCreate customerData)
Update customer data
CustomerGroupEntity[] customerGroupList(String sessionId)
Retrieve customer groups
DirectoryCountryEntity[] directoryCountryList(String sessionId)
List of countries
DirectoryRegionEntity[] directoryRegionList(String sessionId, String country)
List of regions in specified country
boolean endSession(String sessionId)
End web service session
GiftMessageResponse giftMessageSetForQuote(String sessionId, String quoteId, GiftMessageEntity giftMessage, String storeId)
Set a gift message to the cart
GiftMessageResponse giftMessageSetForQuoteItem(String sessionId, String quoteItemId, GiftMessageEntity giftMessage, String storeId)
Setting a gift messages to the quote item
GiftMessageResponse[] giftMessageSetForQuoteProduct(String sessionId, String quoteId, GiftMessageAssociativeProductsEntity[] productsAndMessages, String storeId)
Setting a gift messages to the quote items by products
ExistsFaltureEntity[] globalFaults(String sessionId)
List of global faults
String login(String username, String apiKey)
Login user and retrive session id
MagentoInfoEntity magentoInfo(String sessionId)
Info about current Magento installation
ExistsFaltureEntity[] resourceFaults(String resourceName, String sessionId)
List of resource faults
ApiEntity[] resources(String sessionId)
List of available resources
boolean salesOrderAddComment(String sessionId, String orderIncrementId, String status, String comment, String notify)
Add comment to order
boolean salesOrderCancel(String sessionId, String orderIncrementId)
Cancel order
boolean salesOrderCreditmemoAddComment(String sessionId, String creditmemoIncrementId, String comment, int notifyCustomer, int includeComment)
Add new comment to shipment
boolean salesOrderCreditmemoCancel(String sessionId, String creditmemoIncrementId)
Cancel creditmemo
String salesOrderCreditmemoCreate(String sessionId, String creditmemoIncrementId, SalesOrderCreditmemoData creditmemoData, String comment, int notifyCustomer, int includeComment, String refundToStoreCreditAmount)
Create new creditmemo for order
SalesOrderCreditmemoEntity salesOrderCreditmemoInfo(String sessionId, String creditmemoIncrementId)
Retrieve creditmemo information
SalesOrderCreditmemoEntity[] salesOrderCreditmemoList(String sessionId, Filters filters)
Retrieve list of creditmemos by filters
boolean salesOrderHold(String sessionId, String orderIncrementId)
Hold order
SalesOrderEntity salesOrderInfo(String sessionId, String orderIncrementId)
Retrieve order information
boolean salesOrderInvoiceAddComment(String sessionId, String invoiceIncrementId, String comment, String email, String includeComment)
Add new comment to shipment
boolean salesOrderInvoiceCancel(String sessionId, String invoiceIncrementId)
Cancel invoice
boolean salesOrderInvoiceCapture(String sessionId, String invoiceIncrementId)
Capture invoice
String salesOrderInvoiceCreate(String sessionId, String invoiceIncrementId, OrderItemIdQty[] itemsQty, String comment, String email, String includeComment)
Create new invoice for order
SalesOrderInvoiceEntity salesOrderInvoiceInfo(String sessionId, String invoiceIncrementId)
Retrieve invoice information
SalesOrderInvoiceEntity[] salesOrderInvoiceList(String sessionId, Filters filters)
Retrieve list of invoices by filters
boolean salesOrderInvoiceVoid(String sessionId, String invoiceIncrementId)
Void invoice
SalesOrderListEntity[] salesOrderList(String sessionId, Filters filters)
Retrieve list of orders by filters
boolean salesOrderShipmentAddComment(String sessionId, String shipmentIncrementId, String comment, String email, String includeInEmail)
Add new comment to shipment
int salesOrderShipmentAddTrack(String sessionId, String shipmentIncrementId, String carrier, String title, String trackNumber)
Add new tracking number
String salesOrderShipmentCreate(String sessionId, String orderIncrementId, OrderItemIdQty[] itemsQty, String comment, int email, int includeComment)
Create new shipment for order
AssociativeEntity[] salesOrderShipmentGetCarriers(String sessionId, String orderIncrementId)
Retrieve list of allowed carriers for order
SalesOrderShipmentEntity salesOrderShipmentInfo(String sessionId, String shipmentIncrementId)
Retrieve shipment information
SalesOrderShipmentEntity[] salesOrderShipmentList(String sessionId, Filters filters)
Retrieve list of shipments by filters
boolean salesOrderShipmentRemoveTrack(String sessionId, String shipmentIncrementId, String trackId)
Remove tracking number
boolean salesOrderShipmentSendInfo(String sessionId, String shipmentIncrementId, String comment)
Send shipment info
boolean salesOrderUnhold(String sessionId, String orderIncrementId)
Unhold order
boolean shoppingCartCouponAdd(String sessionId, int quoteId, String couponCode, String storeId)
Add coupon code for shopping cart
boolean shoppingCartCouponRemove(String sessionId, int quoteId, String storeId)
Remove coupon code from shopping cart
int shoppingCartCreate(String sessionId, String storeId)
Create shopping cart
boolean shoppingCartCustomerAddresses(String sessionId, int quoteId, ShoppingCartCustomerAddressEntity[] customer, String storeId)
Set customer's addresses in shopping cart
boolean shoppingCartCustomerSet(String sessionId, int quoteId, ShoppingCartCustomerEntity customer, String storeId)
Set customer for shopping cart
ShoppingCartInfoEntity shoppingCartInfo(String sessionId, int quoteId, String storeId)
Retrieve information about shopping cart
ShoppingCartLicenseEntity[] shoppingCartLicense(String sessionId, int quoteId, String storeId)
Get terms and conditions
String shoppingCartOrder(String sessionId, int quoteId, String storeId, String[] licenses)
Create an order from shopping cart
ShoppingCartPaymentMethodResponseEntityArray shoppingCartPaymentList(String sessionId, int quoteId, String storeId)
Get list of available payment methods
boolean shoppingCartPaymentMethod(String sessionId, int quoteId, ShoppingCartPaymentMethodEntity method, String storeId)
Set payment method
boolean shoppingCartProductAdd(String sessionId, int quoteId, ShoppingCartProductEntity[] products, String storeId)
Add product(s) to shopping cart
CatalogProductEntity[] shoppingCartProductList(String sessionId, int quoteId, String storeId)
Get list of products in shopping cart
boolean shoppingCartProductMoveToCustomerQuote(String sessionId, int quoteId, ShoppingCartProductEntity[] products, String storeId)
Move product(s) to customer quote
boolean shoppingCartProductRemove(String sessionId, int quoteId, ShoppingCartProductEntity[] products, String storeId)
Remove product(s) from shopping cart
boolean shoppingCartProductUpdate(String sessionId, int quoteId, ShoppingCartProductEntity[] products, String storeId)
Update product(s) quantities in shopping cart
ShoppingCartShippingMethodEntity[] shoppingCartShippingList(String sessionId, int quoteId, String storeId)
Get list of available shipping methods
boolean shoppingCartShippingMethod(String sessionId, int quoteId, String method, String storeId)
Set shipping method
ShoppingCartTotalsEntity[] shoppingCartTotals(String sessionId, int quoteId, String storeId)
Get total prices for shopping cart
String startSession()
Start web service session
StoreEntity storeInfo(String sessionId, String storeId)
Store view info
StoreEntity[] storeList(String sessionId)
List of stores
Protected Methods
Call createCall()
[Expand]
Inherited Methods
From class org.apache.axis.client.Stub
From class java.lang.Object
From interface com.magento.api.Mage_Api_Model_Server_V2_HandlerPortType
From interface javax.xml.rpc.Stub

Fields

static OperationDesc[] _operations

private Vector cachedDeserFactories

private Vector cachedSerClasses

private Vector cachedSerFactories

private Vector cachedSerQNames

Public Constructors

public Mage_Api_Model_Server_V2_HandlerBindingStub ()

Throws
AxisFault

public Mage_Api_Model_Server_V2_HandlerBindingStub (URL endpointURL, Service service)

Parameters
endpointURL
service
Throws
AxisFault

public Mage_Api_Model_Server_V2_HandlerBindingStub (Service service)

Parameters
service
Throws
AxisFault

Public Methods

public boolean catalogCategoryAssignProduct (String sessionId, int categoryId, String product, String position, String productIdentifierType)

Assign product to category

Parameters
sessionId
categoryId
product
position
productIdentifierType
Throws
RemoteException

public CatalogAssignedProduct[] catalogCategoryAssignedProducts (String sessionId, int categoryId)

Retrieve list of assigned products

Parameters
sessionId
categoryId
Throws
RemoteException

public int catalogCategoryAttributeCurrentStore (String sessionId, String storeView)

Set/Get current store view

Parameters
sessionId
storeView
Throws
RemoteException

public CatalogAttributeEntity[] catalogCategoryAttributeList (String sessionId)

Retrieve category attributes

Parameters
sessionId
Throws
RemoteException

public CatalogAttributeOptionEntity[] catalogCategoryAttributeOptions (String sessionId, String attributeId, String storeView)

Retrieve attribute options

Parameters
sessionId
attributeId
storeView
Throws
RemoteException

public int catalogCategoryCreate (String sessionId, int parentId, CatalogCategoryEntityCreate categoryData, String storeView)

Create new category and return its id.

Parameters
sessionId
parentId
categoryData
storeView
Throws
RemoteException

public int catalogCategoryCurrentStore (String sessionId, String storeView)

Set_Get current store view

Parameters
sessionId
storeView
Throws
RemoteException

public boolean catalogCategoryDelete (String sessionId, int categoryId)

Delete category

Parameters
sessionId
categoryId
Throws
RemoteException

public CatalogCategoryInfo catalogCategoryInfo (String sessionId, int categoryId, String storeView, String[] attributes)

Retrieve hierarchical tree of categories.

Parameters
sessionId
categoryId
storeView
attributes
Throws
RemoteException

public CatalogCategoryEntityNoChildren[] catalogCategoryLevel (String sessionId, String website, String storeView, String parentCategory)

Retrieve hierarchical tree of categories.

Parameters
sessionId
website
storeView
parentCategory
Throws
RemoteException

public boolean catalogCategoryMove (String sessionId, int categoryId, int parentId, String afterId)

Move category in tree

Parameters
sessionId
categoryId
parentId
afterId
Throws
RemoteException

public boolean catalogCategoryRemoveProduct (String sessionId, int categoryId, String product, String productIdentifierType)

Remove product assignment from category

Parameters
sessionId
categoryId
product
productIdentifierType
Throws
RemoteException

public CatalogCategoryTree catalogCategoryTree (String sessionId, String parentId, String storeView)

Retrieve hierarchical tree of categories.

Parameters
sessionId
parentId
storeView
Throws
RemoteException

public boolean catalogCategoryUpdate (String sessionId, int categoryId, CatalogCategoryEntityCreate categoryData, String storeView)

Update category

Parameters
sessionId
categoryId
categoryData
storeView
Throws
RemoteException

public boolean catalogCategoryUpdateProduct (String sessionId, int categoryId, String product, String position, String productIdentifierType)

Update assigned product

Parameters
sessionId
categoryId
product
position
productIdentifierType
Throws
RemoteException

public CatalogInventoryStockItemEntity[] catalogInventoryStockItemList (String sessionId, String[] products)

Retrieve stock data by product ids

Parameters
sessionId
products
Throws
RemoteException

public int catalogInventoryStockItemUpdate (String sessionId, String product, CatalogInventoryStockItemUpdateEntity data)

Update product stock data

Parameters
sessionId
product
data
Throws
RemoteException

public boolean catalogProductAttributeAddOption (String sessionId, String attribute, CatalogProductAttributeOptionEntityToAdd data)

Add option to attribute

Parameters
sessionId
attribute
data
Throws
RemoteException

public int catalogProductAttributeCreate (String sessionId, CatalogProductAttributeEntityToCreate data)

Create new attribute

Parameters
sessionId
data
Throws
RemoteException

public int catalogProductAttributeCurrentStore (String sessionId, String storeView)

Set/Get current store view

Parameters
sessionId
storeView
Throws
RemoteException

public CatalogProductAttributeEntity catalogProductAttributeInfo (String sessionId, String attribute)

Get full information about attribute with list of options

Parameters
sessionId
attribute
Throws
RemoteException

public CatalogAttributeEntity[] catalogProductAttributeList (String sessionId, int setId)

Retrieve attribute list

Parameters
sessionId
setId
Throws
RemoteException

public String catalogProductAttributeMediaCreate (String sessionId, String product, CatalogProductAttributeMediaCreateEntity data, String storeView, String productIdentifierType)

Upload new product image

Parameters
sessionId
product
data
storeView
productIdentifierType
Throws
RemoteException

public int catalogProductAttributeMediaCurrentStore (String sessionId, String storeView)

Set/Get current store view

Parameters
sessionId
storeView
Throws
RemoteException

public CatalogProductImageEntity catalogProductAttributeMediaInfo (String sessionId, String product, String file, String storeView, String productIdentifierType)

Retrieve product image data

Parameters
sessionId
product
file
storeView
productIdentifierType
Throws
RemoteException

public CatalogProductImageEntity[] catalogProductAttributeMediaList (String sessionId, String product, String storeView, String productIdentifierType)

Retrieve product image list

Parameters
sessionId
product
storeView
productIdentifierType
Throws
RemoteException

public boolean catalogProductAttributeMediaRemove (String sessionId, String product, String file, String productIdentifierType)

Remove product image

Parameters
sessionId
product
file
productIdentifierType
Throws
RemoteException

public CatalogProductAttributeMediaTypeEntity[] catalogProductAttributeMediaTypes (String sessionId, String setId)

Retrieve product image types

Parameters
sessionId
setId
Throws
RemoteException

public boolean catalogProductAttributeMediaUpdate (String sessionId, String product, String file, CatalogProductAttributeMediaCreateEntity data, String storeView, String productIdentifierType)

Update product image

Parameters
sessionId
product
file
data
storeView
productIdentifierType
Throws
RemoteException

public CatalogAttributeOptionEntity[] catalogProductAttributeOptions (String sessionId, String attributeId, String storeView)

Retrieve attribute options

Parameters
sessionId
attributeId
storeView
Throws
RemoteException

public boolean catalogProductAttributeRemove (String sessionId, String attribute)

Delete attribute

Parameters
sessionId
attribute
Throws
RemoteException

public boolean catalogProductAttributeRemoveOption (String sessionId, String attribute, String optionId)

Remove option from attribute

Parameters
sessionId
attribute
optionId
Throws
RemoteException

public boolean catalogProductAttributeSetAttributeAdd (String sessionId, String attributeId, String attributeSetId, String attributeGroupId, String sortOrder)

Add attribute into attribute set

Parameters
sessionId
attributeId
attributeSetId
attributeGroupId
sortOrder
Throws
RemoteException

public boolean catalogProductAttributeSetAttributeRemove (String sessionId, String attributeId, String attributeSetId)

Remove attribute from attribute set

Parameters
sessionId
attributeId
attributeSetId
Throws
RemoteException

public int catalogProductAttributeSetCreate (String sessionId, String attributeSetName, String skeletonSetId)

Create product attribute set based on another set

Parameters
sessionId
attributeSetName
skeletonSetId
Throws
RemoteException

public int catalogProductAttributeSetGroupAdd (String sessionId, String attributeSetId, String groupName)

Create group within existing attribute set

Parameters
sessionId
attributeSetId
groupName
Throws
RemoteException

public boolean catalogProductAttributeSetGroupRemove (String sessionId, String attributeGroupId)

Remove group from attribute set

Parameters
sessionId
attributeGroupId
Throws
RemoteException

public boolean catalogProductAttributeSetGroupRename (String sessionId, String groupId, String groupName)

Rename existing group

Parameters
sessionId
groupId
groupName
Throws
RemoteException

public CatalogProductAttributeSetEntity[] catalogProductAttributeSetList (String sessionId)

Retrieve product attribute sets

Parameters
sessionId
Throws
RemoteException

public boolean catalogProductAttributeSetRemove (String sessionId, String attributeSetId, String forceProductsRemove)

Remove product attribute set

Parameters
sessionId
attributeSetId
forceProductsRemove
Throws
RemoteException

public CatalogProductTierPriceEntity[] catalogProductAttributeTierPriceInfo (String sessionId, String product, String productIdentifierType)

Retrieve product tier prices

Parameters
sessionId
product
productIdentifierType
Throws
RemoteException

public int catalogProductAttributeTierPriceUpdate (String sessionId, String product, CatalogProductTierPriceEntity[] tier_price, String productIdentifierType)

Update product tier prices

Parameters
sessionId
product
tier_price
productIdentifierType
Throws
RemoteException

public CatalogAttributeOptionEntity[] catalogProductAttributeTypes (String sessionId)

Get list of possible attribute types

Parameters
sessionId
Throws
RemoteException

public boolean catalogProductAttributeUpdate (String sessionId, String attribute, CatalogProductAttributeEntityToUpdate data)

Update attribute

Parameters
sessionId
attribute
data
Throws
RemoteException

public int catalogProductCreate (String sessionId, String type, String set, String sku, CatalogProductCreateEntity productData, String storeView)

Create new product and return product id

Parameters
sessionId
type
set
sku
productData
storeView
Throws
RemoteException

public int catalogProductCurrentStore (String sessionId, String storeView)

Set/Get current store view

Parameters
sessionId
storeView
Throws
RemoteException

public boolean catalogProductCustomOptionAdd (String sessionId, String productId, CatalogProductCustomOptionToAdd data, String store)

Add new custom option into product

Parameters
sessionId
productId
data
store
Throws
RemoteException

public CatalogProductCustomOptionInfoEntity catalogProductCustomOptionInfo (String sessionId, String optionId, String store)

Get full information about custom option in product

Parameters
sessionId
optionId
store
Throws
RemoteException

public CatalogProductCustomOptionListEntity[] catalogProductCustomOptionList (String sessionId, String productId, String store)

Retrieve list of product custom options

Parameters
sessionId
productId
store
Throws
RemoteException

public boolean catalogProductCustomOptionRemove (String sessionId, String optionId)

Remove custom option

Parameters
sessionId
optionId
Throws
RemoteException

public CatalogProductCustomOptionTypesEntity[] catalogProductCustomOptionTypes (String sessionId)

Get list of available custom option types

Parameters
sessionId
Throws
RemoteException

public boolean catalogProductCustomOptionUpdate (String sessionId, String optionId, CatalogProductCustomOptionToUpdate data, String store)

Update product custom option

Parameters
sessionId
optionId
data
store
Throws
RemoteException

public boolean catalogProductCustomOptionValueAdd (String sessionId, String optionId, CatalogProductCustomOptionValueAddEntity[] data, String store)

Add new custom option values

Parameters
sessionId
optionId
data
store
Throws
RemoteException

public CatalogProductCustomOptionValueInfoEntity catalogProductCustomOptionValueInfo (String sessionId, String valueId, String store)

Retrieve custom option value info

Parameters
sessionId
valueId
store
Throws
RemoteException

public CatalogProductCustomOptionValueListEntity[] catalogProductCustomOptionValueList (String sessionId, String optionId, String store)

Retrieve custom option values list

Parameters
sessionId
optionId
store
Throws
RemoteException

public boolean catalogProductCustomOptionValueRemove (String sessionId, String valueId)

Remove value from custom option

Parameters
sessionId
valueId
Throws
RemoteException

public boolean catalogProductCustomOptionValueUpdate (String sessionId, String valueId, CatalogProductCustomOptionValueUpdateEntity data, String storeId)

Update custom option value

Parameters
sessionId
valueId
data
storeId
Throws
RemoteException

public int catalogProductDelete (String sessionId, String product, String productIdentifierType)

Delete product

Parameters
sessionId
product
productIdentifierType
Throws
RemoteException

public int catalogProductDownloadableLinkAdd (String sessionId, String productId, CatalogProductDownloadableLinkAddEntity resource, String resourceType, String store, String identifierType)

Add links to downloadable product

Parameters
sessionId
productId
resource
resourceType
store
identifierType
Throws
RemoteException

public CatalogProductDownloadableLinkInfoEntity catalogProductDownloadableLinkList (String sessionId, String productId, String store, String identifierType)

Retrieve list of links and samples for downloadable product

Parameters
sessionId
productId
store
identifierType
Throws
RemoteException

public boolean catalogProductDownloadableLinkRemove (String sessionId, String linkId, String resourceType)

Remove links and samples from downloadable product

Parameters
sessionId
linkId
resourceType
Throws
RemoteException

public CatalogProductReturnEntity catalogProductGetSpecialPrice (String sessionId, String product, String storeView, String productIdentifierType)

Get product special price data

Parameters
sessionId
product
storeView
productIdentifierType
Throws
RemoteException

public CatalogProductReturnEntity catalogProductInfo (String sessionId, String product, String storeView, CatalogProductRequestAttributes attributes, String productIdentifierType)

Retrieve product

Parameters
sessionId
product
storeView
attributes
productIdentifierType
Throws
RemoteException

public boolean catalogProductLinkAssign (String sessionId, String type, String product, String linkedProduct, CatalogProductLinkEntity data, String productIdentifierType)

Assign product link

Parameters
sessionId
type
product
linkedProduct
data
productIdentifierType
Throws
RemoteException

public CatalogProductLinkAttributeEntity[] catalogProductLinkAttributes (String sessionId, String type)

Retrieve product link type attributes

Parameters
sessionId
type
Throws
RemoteException

public CatalogProductLinkEntity[] catalogProductLinkList (String sessionId, String type, String product, String productIdentifierType)

Retrieve linked products

Parameters
sessionId
type
product
productIdentifierType
Throws
RemoteException

public boolean catalogProductLinkRemove (String sessionId, String type, String product, String linkedProduct, String productIdentifierType)

Remove product link

Parameters
sessionId
type
product
linkedProduct
productIdentifierType
Throws
RemoteException

public String[] catalogProductLinkTypes (String sessionId)

Retrieve product link types

Parameters
sessionId
Throws
RemoteException

public boolean catalogProductLinkUpdate (String sessionId, String type, String product, String linkedProduct, CatalogProductLinkEntity data, String productIdentifierType)

Update product link

Parameters
sessionId
type
product
linkedProduct
data
productIdentifierType
Throws
RemoteException

public CatalogProductEntity[] catalogProductList (String sessionId, Filters filters, String storeView)

Retrieve products list by filters

Parameters
sessionId
filters
storeView
Throws
RemoteException

public CatalogAttributeEntity[] catalogProductListOfAdditionalAttributes (String sessionId, String productType, String attributeSetId)

Get list of additional attributes which are not in default create/update list

Parameters
sessionId
productType
attributeSetId
Throws
RemoteException

public int catalogProductSetSpecialPrice (String sessionId, String product, String specialPrice, String fromDate, String toDate, String storeView, String productIdentifierType)

Update product special price

Parameters
sessionId
product
specialPrice
fromDate
toDate
storeView
productIdentifierType
Throws
RemoteException

public AssociativeEntity[] catalogProductTagAdd (String sessionId, CatalogProductTagAddEntity data)

Add tag(s) to product

Parameters
sessionId
data
Throws
RemoteException

public CatalogProductTagInfoEntity catalogProductTagInfo (String sessionId, String tagId, String store)

Retrieve product tag info

Parameters
sessionId
tagId
store
Throws
RemoteException

public CatalogProductTagListEntity[] catalogProductTagList (String sessionId, String productId, String store)

Retrieve list of tags by product

Parameters
sessionId
productId
store
Throws
RemoteException

public boolean catalogProductTagRemove (String sessionId, String tagId)

Remove product tag

Parameters
sessionId
tagId
Throws
RemoteException

public boolean catalogProductTagUpdate (String sessionId, String tagId, CatalogProductTagUpdateEntity data, String store)

Update product tag

Parameters
sessionId
tagId
data
store
Throws
RemoteException

public CatalogProductTypeEntity[] catalogProductTypeList (String sessionId)

Retrieve product types

Parameters
sessionId
Throws
RemoteException

public boolean catalogProductUpdate (String sessionId, String product, CatalogProductCreateEntity productData, String storeView, String productIdentifierType)

Update product

Parameters
sessionId
product
productData
storeView
productIdentifierType
Throws
RemoteException

public int customerAddressCreate (String sessionId, int customerId, CustomerAddressEntityCreate addressData)

Create customer address

Parameters
sessionId
customerId
addressData
Throws
RemoteException

public boolean customerAddressDelete (String sessionId, int addressId)

Delete customer address

Parameters
sessionId
addressId
Throws
RemoteException

public CustomerAddressEntityItem customerAddressInfo (String sessionId, int addressId)

Retrieve customer address data

Parameters
sessionId
addressId
Throws
RemoteException

public CustomerAddressEntityItem[] customerAddressList (String sessionId, int customerId)

Retrieve customer addresses

Parameters
sessionId
customerId
Throws
RemoteException

public boolean customerAddressUpdate (String sessionId, int addressId, CustomerAddressEntityCreate addressData)

Update customer address data

Parameters
sessionId
addressId
addressData
Throws
RemoteException

public int customerCustomerCreate (String sessionId, CustomerCustomerEntityToCreate customerData)

Create customer

Parameters
sessionId
customerData
Throws
RemoteException

public boolean customerCustomerDelete (String sessionId, int customerId)

Delete customer

Parameters
sessionId
customerId
Throws
RemoteException

public CustomerCustomerEntity customerCustomerInfo (String sessionId, int customerId, String[] attributes)

Retrieve customer data

Parameters
sessionId
customerId
attributes
Throws
RemoteException

public CustomerCustomerEntity[] customerCustomerList (String sessionId, Filters filters)

Retrieve customers

Parameters
sessionId
filters
Throws
RemoteException

public boolean customerCustomerUpdate (String sessionId, int customerId, CustomerCustomerEntityToCreate customerData)

Update customer data

Parameters
sessionId
customerId
customerData
Throws
RemoteException

public CustomerGroupEntity[] customerGroupList (String sessionId)

Retrieve customer groups

Parameters
sessionId
Throws
RemoteException

public DirectoryCountryEntity[] directoryCountryList (String sessionId)

List of countries

Parameters
sessionId
Throws
RemoteException

public DirectoryRegionEntity[] directoryRegionList (String sessionId, String country)

List of regions in specified country

Parameters
sessionId
country
Throws
RemoteException

public boolean endSession (String sessionId)

End web service session

Parameters
sessionId
Throws
RemoteException

public GiftMessageResponse giftMessageSetForQuote (String sessionId, String quoteId, GiftMessageEntity giftMessage, String storeId)

Set a gift message to the cart

Parameters
sessionId
quoteId
giftMessage
storeId
Throws
RemoteException

public GiftMessageResponse giftMessageSetForQuoteItem (String sessionId, String quoteItemId, GiftMessageEntity giftMessage, String storeId)

Setting a gift messages to the quote item

Parameters
sessionId
quoteItemId
giftMessage
storeId
Throws
RemoteException

public GiftMessageResponse[] giftMessageSetForQuoteProduct (String sessionId, String quoteId, GiftMessageAssociativeProductsEntity[] productsAndMessages, String storeId)

Setting a gift messages to the quote items by products

Parameters
sessionId
quoteId
productsAndMessages
storeId
Throws
RemoteException

public ExistsFaltureEntity[] globalFaults (String sessionId)

List of global faults

Parameters
sessionId
Throws
RemoteException

public String login (String username, String apiKey)

Login user and retrive session id

Parameters
username
apiKey
Throws
RemoteException

public MagentoInfoEntity magentoInfo (String sessionId)

Info about current Magento installation

Parameters
sessionId
Throws
RemoteException

public ExistsFaltureEntity[] resourceFaults (String resourceName, String sessionId)

List of resource faults

Parameters
resourceName
sessionId
Throws
RemoteException

public ApiEntity[] resources (String sessionId)

List of available resources

Parameters
sessionId
Throws
RemoteException

public boolean salesOrderAddComment (String sessionId, String orderIncrementId, String status, String comment, String notify)

Add comment to order

Parameters
sessionId
orderIncrementId
status
comment
notify
Throws
RemoteException

public boolean salesOrderCancel (String sessionId, String orderIncrementId)

Cancel order

Parameters
sessionId
orderIncrementId
Throws
RemoteException

public boolean salesOrderCreditmemoAddComment (String sessionId, String creditmemoIncrementId, String comment, int notifyCustomer, int includeComment)

Add new comment to shipment

Parameters
sessionId
creditmemoIncrementId
comment
notifyCustomer
includeComment
Throws
RemoteException

public boolean salesOrderCreditmemoCancel (String sessionId, String creditmemoIncrementId)

Cancel creditmemo

Parameters
sessionId
creditmemoIncrementId
Throws
RemoteException

public String salesOrderCreditmemoCreate (String sessionId, String creditmemoIncrementId, SalesOrderCreditmemoData creditmemoData, String comment, int notifyCustomer, int includeComment, String refundToStoreCreditAmount)

Create new creditmemo for order

Parameters
sessionId
creditmemoIncrementId
creditmemoData
comment
notifyCustomer
includeComment
refundToStoreCreditAmount
Throws
RemoteException

public SalesOrderCreditmemoEntity salesOrderCreditmemoInfo (String sessionId, String creditmemoIncrementId)

Retrieve creditmemo information

Parameters
sessionId
creditmemoIncrementId
Throws
RemoteException

public SalesOrderCreditmemoEntity[] salesOrderCreditmemoList (String sessionId, Filters filters)

Retrieve list of creditmemos by filters

Parameters
sessionId
filters
Throws
RemoteException

public boolean salesOrderHold (String sessionId, String orderIncrementId)

Hold order

Parameters
sessionId
orderIncrementId
Throws
RemoteException

public SalesOrderEntity salesOrderInfo (String sessionId, String orderIncrementId)

Retrieve order information

Parameters
sessionId
orderIncrementId
Throws
RemoteException

public boolean salesOrderInvoiceAddComment (String sessionId, String invoiceIncrementId, String comment, String email, String includeComment)

Add new comment to shipment

Parameters
sessionId
invoiceIncrementId
comment
email
includeComment
Throws
RemoteException

public boolean salesOrderInvoiceCancel (String sessionId, String invoiceIncrementId)

Cancel invoice

Parameters
sessionId
invoiceIncrementId
Throws
RemoteException

public boolean salesOrderInvoiceCapture (String sessionId, String invoiceIncrementId)

Capture invoice

Parameters
sessionId
invoiceIncrementId
Throws
RemoteException

public String salesOrderInvoiceCreate (String sessionId, String invoiceIncrementId, OrderItemIdQty[] itemsQty, String comment, String email, String includeComment)

Create new invoice for order

Parameters
sessionId
invoiceIncrementId
itemsQty
comment
email
includeComment
Throws
RemoteException

public SalesOrderInvoiceEntity salesOrderInvoiceInfo (String sessionId, String invoiceIncrementId)

Retrieve invoice information

Parameters
sessionId
invoiceIncrementId
Throws
RemoteException

public SalesOrderInvoiceEntity[] salesOrderInvoiceList (String sessionId, Filters filters)

Retrieve list of invoices by filters

Parameters
sessionId
filters
Throws
RemoteException

public boolean salesOrderInvoiceVoid (String sessionId, String invoiceIncrementId)

Void invoice

Parameters
sessionId
invoiceIncrementId
Throws
RemoteException

public SalesOrderListEntity[] salesOrderList (String sessionId, Filters filters)

Retrieve list of orders by filters

Parameters
sessionId
filters
Throws
RemoteException

public boolean salesOrderShipmentAddComment (String sessionId, String shipmentIncrementId, String comment, String email, String includeInEmail)

Add new comment to shipment

Parameters
sessionId
shipmentIncrementId
comment
email
includeInEmail
Throws
RemoteException

public int salesOrderShipmentAddTrack (String sessionId, String shipmentIncrementId, String carrier, String title, String trackNumber)

Add new tracking number

Parameters
sessionId
shipmentIncrementId
carrier
title
trackNumber
Throws
RemoteException

public String salesOrderShipmentCreate (String sessionId, String orderIncrementId, OrderItemIdQty[] itemsQty, String comment, int email, int includeComment)

Create new shipment for order

Parameters
sessionId
orderIncrementId
itemsQty
comment
email
includeComment
Throws
RemoteException

public AssociativeEntity[] salesOrderShipmentGetCarriers (String sessionId, String orderIncrementId)

Retrieve list of allowed carriers for order

Parameters
sessionId
orderIncrementId
Throws
RemoteException

public SalesOrderShipmentEntity salesOrderShipmentInfo (String sessionId, String shipmentIncrementId)

Retrieve shipment information

Parameters
sessionId
shipmentIncrementId
Throws
RemoteException

public SalesOrderShipmentEntity[] salesOrderShipmentList (String sessionId, Filters filters)

Retrieve list of shipments by filters

Parameters
sessionId
filters
Throws
RemoteException

public boolean salesOrderShipmentRemoveTrack (String sessionId, String shipmentIncrementId, String trackId)

Remove tracking number

Parameters
sessionId
shipmentIncrementId
trackId
Throws
RemoteException

public boolean salesOrderShipmentSendInfo (String sessionId, String shipmentIncrementId, String comment)

Send shipment info

Parameters
sessionId
shipmentIncrementId
comment
Throws
RemoteException

public boolean salesOrderUnhold (String sessionId, String orderIncrementId)

Unhold order

Parameters
sessionId
orderIncrementId
Throws
RemoteException

public boolean shoppingCartCouponAdd (String sessionId, int quoteId, String couponCode, String storeId)

Add coupon code for shopping cart

Parameters
sessionId
quoteId
couponCode
storeId
Throws
RemoteException

public boolean shoppingCartCouponRemove (String sessionId, int quoteId, String storeId)

Remove coupon code from shopping cart

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

public int shoppingCartCreate (String sessionId, String storeId)

Create shopping cart

Parameters
sessionId
storeId
Throws
RemoteException

public boolean shoppingCartCustomerAddresses (String sessionId, int quoteId, ShoppingCartCustomerAddressEntity[] customer, String storeId)

Set customer's addresses in shopping cart

Parameters
sessionId
quoteId
customer
storeId
Throws
RemoteException

public boolean shoppingCartCustomerSet (String sessionId, int quoteId, ShoppingCartCustomerEntity customer, String storeId)

Set customer for shopping cart

Parameters
sessionId
quoteId
customer
storeId
Throws
RemoteException

public ShoppingCartInfoEntity shoppingCartInfo (String sessionId, int quoteId, String storeId)

Retrieve information about shopping cart

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

public ShoppingCartLicenseEntity[] shoppingCartLicense (String sessionId, int quoteId, String storeId)

Get terms and conditions

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

public String shoppingCartOrder (String sessionId, int quoteId, String storeId, String[] licenses)

Create an order from shopping cart

Parameters
sessionId
quoteId
storeId
licenses
Throws
RemoteException

public ShoppingCartPaymentMethodResponseEntityArray shoppingCartPaymentList (String sessionId, int quoteId, String storeId)

Get list of available payment methods

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

public boolean shoppingCartPaymentMethod (String sessionId, int quoteId, ShoppingCartPaymentMethodEntity method, String storeId)

Set payment method

Parameters
sessionId
quoteId
method
storeId
Throws
RemoteException

public boolean shoppingCartProductAdd (String sessionId, int quoteId, ShoppingCartProductEntity[] products, String storeId)

Add product(s) to shopping cart

Parameters
sessionId
quoteId
products
storeId
Throws
RemoteException

public CatalogProductEntity[] shoppingCartProductList (String sessionId, int quoteId, String storeId)

Get list of products in shopping cart

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

public boolean shoppingCartProductMoveToCustomerQuote (String sessionId, int quoteId, ShoppingCartProductEntity[] products, String storeId)

Move product(s) to customer quote

Parameters
sessionId
quoteId
products
storeId
Throws
RemoteException

public boolean shoppingCartProductRemove (String sessionId, int quoteId, ShoppingCartProductEntity[] products, String storeId)

Remove product(s) from shopping cart

Parameters
sessionId
quoteId
products
storeId
Throws
RemoteException

public boolean shoppingCartProductUpdate (String sessionId, int quoteId, ShoppingCartProductEntity[] products, String storeId)

Update product(s) quantities in shopping cart

Parameters
sessionId
quoteId
products
storeId
Throws
RemoteException

public ShoppingCartShippingMethodEntity[] shoppingCartShippingList (String sessionId, int quoteId, String storeId)

Get list of available shipping methods

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

public boolean shoppingCartShippingMethod (String sessionId, int quoteId, String method, String storeId)

Set shipping method

Parameters
sessionId
quoteId
method
storeId
Throws
RemoteException

public ShoppingCartTotalsEntity[] shoppingCartTotals (String sessionId, int quoteId, String storeId)

Get total prices for shopping cart

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

public String startSession ()

Start web service session

Throws
RemoteException

public StoreEntity storeInfo (String sessionId, String storeId)

Store view info

Parameters
sessionId
storeId
Throws
RemoteException

public StoreEntity[] storeList (String sessionId)

List of stores

Parameters
sessionId
Throws
RemoteException

Protected Methods

protected Call createCall ()

Throws
RemoteException