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
int catalogProductAttributeCurrentStore(String sessionId, String storeView)
Set/Get current store view
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
int catalogProductAttributeMediaRemove(String sessionId, String product, String file, String productIdentifierType)
Remove product image
CatalogProductAttributeMediaTypeEntity[] catalogProductAttributeMediaTypes(String sessionId, String setId)
Retrieve product image types
int 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
CatalogProductAttributeSetEntity[] catalogProductAttributeSetList(String sessionId)
Retrieve product attribute sets
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
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
int catalogProductDelete(String sessionId, String product, String productIdentifierType)
Delete 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
String 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
String catalogProductLinkRemove(String sessionId, String type, String product, String linkedProduct, String productIdentifierType)
Remove product link
String[] catalogProductLinkTypes(String sessionId)
Retrieve product link types
String 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
int catalogProductSetSpecialPrice(String sessionId, String product, String specialPrice, String fromDate, String toDate, String storeView, String productIdentifierType)
Update product special price
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
ExistsFaltureEntity[] resourceFaults(String resourceName, String sessionId)
List of resource faults
ApiEntity[] resources(String sessionId)
List of available resources
int salesOrderAddComment(String sessionId, String orderIncrementId, String status, String comment, String notify)
Add comment to order
int salesOrderCancel(String sessionId, String orderIncrementId)
Cancel order
int salesOrderHold(String sessionId, String orderIncrementId)
Hold order
SalesOrderEntity salesOrderInfo(String sessionId, String orderIncrementId)
Retrieve order information
String salesOrderInvoiceAddComment(String sessionId, String invoiceIncrementId, String comment, String email, String includeComment)
Add new comment to shipment
String salesOrderInvoiceCancel(String sessionId, String invoiceIncrementId)
Cancel invoice
String 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
String salesOrderInvoiceVoid(String sessionId, String invoiceIncrementId)
Void invoice
SalesOrderListEntity[] salesOrderList(String sessionId, Filters filters)
Retrieve list of orders by filters
int 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
int salesOrderShipmentRemoveTrack(String sessionId, String shipmentIncrementId, String trackId)
Remove tracking number
int 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
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 int catalogProductAttributeCurrentStore (String sessionId, String storeView)

Set/Get current store view

Parameters
sessionId
storeView
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 int 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 int 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 CatalogProductAttributeSetEntity[] catalogProductAttributeSetList (String sessionId)

Retrieve product attribute sets

Parameters
sessionId
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 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 int catalogProductDelete (String sessionId, String product, String productIdentifierType)

Delete product

Parameters
sessionId
product
productIdentifierType
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 String 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 String 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 String 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 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 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 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 int salesOrderAddComment (String sessionId, String orderIncrementId, String status, String comment, String notify)

Add comment to order

Parameters
sessionId
orderIncrementId
status
comment
notify
Throws
RemoteException

public int salesOrderCancel (String sessionId, String orderIncrementId)

Cancel order

Parameters
sessionId
orderIncrementId
Throws
RemoteException

public int 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 String 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 String salesOrderInvoiceCancel (String sessionId, String invoiceIncrementId)

Cancel invoice

Parameters
sessionId
invoiceIncrementId
Throws
RemoteException

public String 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 String 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 int 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 int salesOrderShipmentRemoveTrack (String sessionId, String shipmentIncrementId, String trackId)

Remove tracking number

Parameters
sessionId
shipmentIncrementId
trackId
Throws
RemoteException

public int 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

Protected Methods

protected Call createCall ()

Throws
RemoteException