public interface

Mage_Api_Model_Server_V2_HandlerPortType

implements Remote
com.magento.api.Mage_Api_Model_Server_V2_HandlerPortType
Known Indirect Subclasses

Summary

Public Methods
abstract boolean catalogCategoryAssignProduct(String sessionId, int categoryId, String product, String position, String productIdentifierType)
Assign product to category
abstract CatalogAssignedProduct[] catalogCategoryAssignedProducts(String sessionId, int categoryId)
Retrieve list of assigned products
abstract int catalogCategoryAttributeCurrentStore(String sessionId, String storeView)
Set/Get current store view
abstract CatalogAttributeEntity[] catalogCategoryAttributeList(String sessionId)
Retrieve category attributes
abstract CatalogAttributeOptionEntity[] catalogCategoryAttributeOptions(String sessionId, String attributeId, String storeView)
Retrieve attribute options
abstract int catalogCategoryCreate(String sessionId, int parentId, CatalogCategoryEntityCreate categoryData, String storeView)
Create new category and return its id.
abstract int catalogCategoryCurrentStore(String sessionId, String storeView)
Set_Get current store view
abstract boolean catalogCategoryDelete(String sessionId, int categoryId)
Delete category
abstract CatalogCategoryInfo catalogCategoryInfo(String sessionId, int categoryId, String storeView, String[] attributes)
Retrieve hierarchical tree of categories.
abstract CatalogCategoryEntityNoChildren[] catalogCategoryLevel(String sessionId, String website, String storeView, String parentCategory)
Retrieve hierarchical tree of categories.
abstract boolean catalogCategoryMove(String sessionId, int categoryId, int parentId, String afterId)
Move category in tree
abstract boolean catalogCategoryRemoveProduct(String sessionId, int categoryId, String product, String productIdentifierType)
Remove product assignment from category
abstract CatalogCategoryTree catalogCategoryTree(String sessionId, String parentId, String storeView)
Retrieve hierarchical tree of categories.
abstract boolean catalogCategoryUpdate(String sessionId, int categoryId, CatalogCategoryEntityCreate categoryData, String storeView)
Update category
abstract boolean catalogCategoryUpdateProduct(String sessionId, int categoryId, String product, String position, String productIdentifierType)
Update assigned product
abstract CatalogInventoryStockItemEntity[] catalogInventoryStockItemList(String sessionId, String[] products)
Retrieve stock data by product ids
abstract int catalogInventoryStockItemUpdate(String sessionId, String product, CatalogInventoryStockItemUpdateEntity data)
Update product stock data
abstract int catalogProductAttributeCurrentStore(String sessionId, String storeView)
Set/Get current store view
abstract CatalogAttributeEntity[] catalogProductAttributeList(String sessionId, int setId)
Retrieve attribute list
abstract String catalogProductAttributeMediaCreate(String sessionId, String product, CatalogProductAttributeMediaCreateEntity data, String storeView, String productIdentifierType)
Upload new product image
abstract int catalogProductAttributeMediaCurrentStore(String sessionId, String storeView)
Set/Get current store view
abstract CatalogProductImageEntity catalogProductAttributeMediaInfo(String sessionId, String product, String file, String storeView, String productIdentifierType)
Retrieve product image data
abstract CatalogProductImageEntity[] catalogProductAttributeMediaList(String sessionId, String product, String storeView, String productIdentifierType)
Retrieve product image list
abstract int catalogProductAttributeMediaRemove(String sessionId, String product, String file, String productIdentifierType)
Remove product image
abstract CatalogProductAttributeMediaTypeEntity[] catalogProductAttributeMediaTypes(String sessionId, String setId)
Retrieve product image types
abstract int catalogProductAttributeMediaUpdate(String sessionId, String product, String file, CatalogProductAttributeMediaCreateEntity data, String storeView, String productIdentifierType)
Update product image
abstract CatalogAttributeOptionEntity[] catalogProductAttributeOptions(String sessionId, String attributeId, String storeView)
Retrieve attribute options
abstract CatalogProductAttributeSetEntity[] catalogProductAttributeSetList(String sessionId)
Retrieve product attribute sets
abstract CatalogProductTierPriceEntity[] catalogProductAttributeTierPriceInfo(String sessionId, String product, String productIdentifierType)
Retrieve product tier prices
abstract int catalogProductAttributeTierPriceUpdate(String sessionId, String product, CatalogProductTierPriceEntity[] tier_price, String productIdentifierType)
Update product tier prices
abstract int catalogProductCreate(String sessionId, String type, String set, String sku, CatalogProductCreateEntity productData, String storeView)
Create new product and return product id
abstract int catalogProductCurrentStore(String sessionId, String storeView)
Set/Get current store view
abstract int catalogProductDelete(String sessionId, String product, String productIdentifierType)
Delete product
abstract CatalogProductReturnEntity catalogProductGetSpecialPrice(String sessionId, String product, String storeView, String productIdentifierType)
Get product special price data
abstract CatalogProductReturnEntity catalogProductInfo(String sessionId, String product, String storeView, CatalogProductRequestAttributes attributes, String productIdentifierType)
Retrieve product
abstract String catalogProductLinkAssign(String sessionId, String type, String product, String linkedProduct, CatalogProductLinkEntity data, String productIdentifierType)
Assign product link
abstract CatalogProductLinkAttributeEntity[] catalogProductLinkAttributes(String sessionId, String type)
Retrieve product link type attributes
abstract CatalogProductLinkEntity[] catalogProductLinkList(String sessionId, String type, String product, String productIdentifierType)
Retrieve linked products
abstract String catalogProductLinkRemove(String sessionId, String type, String product, String linkedProduct, String productIdentifierType)
Remove product link
abstract String[] catalogProductLinkTypes(String sessionId)
Retrieve product link types
abstract String catalogProductLinkUpdate(String sessionId, String type, String product, String linkedProduct, CatalogProductLinkEntity data, String productIdentifierType)
Update product link
abstract CatalogProductEntity[] catalogProductList(String sessionId, Filters filters, String storeView)
Retrieve products list by filters
abstract int catalogProductSetSpecialPrice(String sessionId, String product, String specialPrice, String fromDate, String toDate, String storeView, String productIdentifierType)
Update product special price
abstract CatalogProductTypeEntity[] catalogProductTypeList(String sessionId)
Retrieve product types
abstract boolean catalogProductUpdate(String sessionId, String product, CatalogProductCreateEntity productData, String storeView, String productIdentifierType)
Update product
abstract int customerAddressCreate(String sessionId, int customerId, CustomerAddressEntityCreate addressData)
Create customer address
abstract boolean customerAddressDelete(String sessionId, int addressId)
Delete customer address
abstract CustomerAddressEntityItem customerAddressInfo(String sessionId, int addressId)
Retrieve customer address data
abstract CustomerAddressEntityItem[] customerAddressList(String sessionId, int customerId)
Retrieve customer addresses
abstract boolean customerAddressUpdate(String sessionId, int addressId, CustomerAddressEntityCreate addressData)
Update customer address data
abstract int customerCustomerCreate(String sessionId, CustomerCustomerEntityToCreate customerData)
Create customer
abstract boolean customerCustomerDelete(String sessionId, int customerId)
Delete customer
abstract CustomerCustomerEntity customerCustomerInfo(String sessionId, int customerId, String[] attributes)
Retrieve customer data
abstract CustomerCustomerEntity[] customerCustomerList(String sessionId, Filters filters)
Retrieve customers
abstract boolean customerCustomerUpdate(String sessionId, int customerId, CustomerCustomerEntityToCreate customerData)
Update customer data
abstract CustomerGroupEntity[] customerGroupList(String sessionId)
Retrieve customer groups
abstract DirectoryCountryEntity[] directoryCountryList(String sessionId)
List of countries
abstract DirectoryRegionEntity[] directoryRegionList(String sessionId, String country)
List of regions in specified country
abstract boolean endSession(String sessionId)
End web service session
abstract GiftMessageResponse giftMessageSetForQuote(String sessionId, String quoteId, GiftMessageEntity giftMessage, String storeId)
Set a gift message to the cart
abstract GiftMessageResponse giftMessageSetForQuoteItem(String sessionId, String quoteItemId, GiftMessageEntity giftMessage, String storeId)
Setting a gift messages to the quote item
abstract GiftMessageResponse[] giftMessageSetForQuoteProduct(String sessionId, String quoteId, GiftMessageAssociativeProductsEntity[] productsAndMessages, String storeId)
Setting a gift messages to the quote items by products
abstract ExistsFaltureEntity[] globalFaults(String sessionId)
List of global faults
abstract String login(String username, String apiKey)
Login user and retrive session id
abstract ExistsFaltureEntity[] resourceFaults(String resourceName, String sessionId)
List of resource faults
abstract ApiEntity[] resources(String sessionId)
List of available resources
abstract int salesOrderAddComment(String sessionId, String orderIncrementId, String status, String comment, String notify)
Add comment to order
abstract int salesOrderCancel(String sessionId, String orderIncrementId)
Cancel order
abstract int salesOrderHold(String sessionId, String orderIncrementId)
Hold order
abstract SalesOrderEntity salesOrderInfo(String sessionId, String orderIncrementId)
Retrieve order information
abstract String salesOrderInvoiceAddComment(String sessionId, String invoiceIncrementId, String comment, String email, String includeComment)
Add new comment to shipment
abstract String salesOrderInvoiceCancel(String sessionId, String invoiceIncrementId)
Cancel invoice
abstract String salesOrderInvoiceCapture(String sessionId, String invoiceIncrementId)
Capture invoice
abstract String salesOrderInvoiceCreate(String sessionId, String invoiceIncrementId, OrderItemIdQty[] itemsQty, String comment, String email, String includeComment)
Create new invoice for order
abstract SalesOrderInvoiceEntity salesOrderInvoiceInfo(String sessionId, String invoiceIncrementId)
Retrieve invoice information
abstract SalesOrderInvoiceEntity[] salesOrderInvoiceList(String sessionId, Filters filters)
Retrieve list of invoices by filters
abstract String salesOrderInvoiceVoid(String sessionId, String invoiceIncrementId)
Void invoice
abstract SalesOrderListEntity[] salesOrderList(String sessionId, Filters filters)
Retrieve list of orders by filters
abstract int salesOrderShipmentAddComment(String sessionId, String shipmentIncrementId, String comment, String email, String includeInEmail)
Add new comment to shipment
abstract int salesOrderShipmentAddTrack(String sessionId, String shipmentIncrementId, String carrier, String title, String trackNumber)
Add new tracking number
abstract String salesOrderShipmentCreate(String sessionId, String orderIncrementId, OrderItemIdQty[] itemsQty, String comment, int email, int includeComment)
Create new shipment for order
abstract AssociativeEntity[] salesOrderShipmentGetCarriers(String sessionId, String orderIncrementId)
Retrieve list of allowed carriers for order
abstract SalesOrderShipmentEntity salesOrderShipmentInfo(String sessionId, String shipmentIncrementId)
Retrieve shipment information
abstract SalesOrderShipmentEntity[] salesOrderShipmentList(String sessionId, Filters filters)
Retrieve list of shipments by filters
abstract int salesOrderShipmentRemoveTrack(String sessionId, String shipmentIncrementId, String trackId)
Remove tracking number
abstract int salesOrderUnhold(String sessionId, String orderIncrementId)
Unhold order
abstract boolean shoppingCartCouponAdd(String sessionId, int quoteId, String couponCode, String storeId)
Add coupon code for shopping cart
abstract boolean shoppingCartCouponRemove(String sessionId, int quoteId, String storeId)
Remove coupon code from shopping cart
abstract int shoppingCartCreate(String sessionId, String storeId)
Create shopping cart
abstract boolean shoppingCartCustomerAddresses(String sessionId, int quoteId, ShoppingCartCustomerAddressEntity[] customer, String storeId)
Set customer's addresses in shopping cart
abstract boolean shoppingCartCustomerSet(String sessionId, int quoteId, ShoppingCartCustomerEntity customer, String storeId)
Set customer for shopping cart
abstract ShoppingCartInfoEntity shoppingCartInfo(String sessionId, int quoteId, String storeId)
Retrieve information about shopping cart
abstract ShoppingCartLicenseEntity[] shoppingCartLicense(String sessionId, int quoteId, String storeId)
Get terms and conditions
abstract String shoppingCartOrder(String sessionId, int quoteId, String storeId, String[] licenses)
Create an order from shopping cart
abstract ShoppingCartPaymentMethodResponseEntityArray shoppingCartPaymentList(String sessionId, int quoteId, String storeId)
Get list of available payment methods
abstract boolean shoppingCartPaymentMethod(String sessionId, int quoteId, ShoppingCartPaymentMethodEntity method, String storeId)
Set payment method
abstract boolean shoppingCartProductAdd(String sessionId, int quoteId, ShoppingCartProductEntity[] products, String storeId)
Add product(s) to shopping cart
abstract CatalogProductEntity[] shoppingCartProductList(String sessionId, int quoteId, String storeId)
Get list of products in shopping cart
abstract boolean shoppingCartProductMoveToCustomerQuote(String sessionId, int quoteId, ShoppingCartProductEntity[] products, String storeId)
Move product(s) to customer quote
abstract boolean shoppingCartProductRemove(String sessionId, int quoteId, ShoppingCartProductEntity[] products, String storeId)
Remove product(s) from shopping cart
abstract boolean shoppingCartProductUpdate(String sessionId, int quoteId, ShoppingCartProductEntity[] products, String storeId)
Update product(s) quantities in shopping cart
abstract ShoppingCartShippingMethodEntity[] shoppingCartShippingList(String sessionId, int quoteId, String storeId)
Get list of available shipping methods
abstract boolean shoppingCartShippingMethod(String sessionId, int quoteId, String method, String storeId)
Set shipping method
abstract ShoppingCartTotalsEntity[] shoppingCartTotals(String sessionId, int quoteId, String storeId)
Get total prices for shopping cart
abstract String startSession()
Start web service session

Public Methods

public abstract 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 abstract CatalogAssignedProduct[] catalogCategoryAssignedProducts (String sessionId, int categoryId)

Retrieve list of assigned products

Parameters
sessionId
categoryId
Throws
RemoteException

public abstract int catalogCategoryAttributeCurrentStore (String sessionId, String storeView)

Set/Get current store view

Parameters
sessionId
storeView
Throws
RemoteException

public abstract CatalogAttributeEntity[] catalogCategoryAttributeList (String sessionId)

Retrieve category attributes

Parameters
sessionId
Throws
RemoteException

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

Retrieve attribute options

Parameters
sessionId
attributeId
storeView
Throws
RemoteException

public abstract 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 abstract int catalogCategoryCurrentStore (String sessionId, String storeView)

Set_Get current store view

Parameters
sessionId
storeView
Throws
RemoteException

public abstract boolean catalogCategoryDelete (String sessionId, int categoryId)

Delete category

Parameters
sessionId
categoryId
Throws
RemoteException

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

Retrieve hierarchical tree of categories.

Parameters
sessionId
categoryId
storeView
attributes
Throws
RemoteException

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

Retrieve hierarchical tree of categories.

Parameters
sessionId
website
storeView
parentCategory
Throws
RemoteException

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

Move category in tree

Parameters
sessionId
categoryId
parentId
afterId
Throws
RemoteException

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

Remove product assignment from category

Parameters
sessionId
categoryId
product
productIdentifierType
Throws
RemoteException

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

Retrieve hierarchical tree of categories.

Parameters
sessionId
parentId
storeView
Throws
RemoteException

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

Update category

Parameters
sessionId
categoryId
categoryData
storeView
Throws
RemoteException

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

Update assigned product

Parameters
sessionId
categoryId
product
position
productIdentifierType
Throws
RemoteException

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

Retrieve stock data by product ids

Parameters
sessionId
products
Throws
RemoteException

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

Update product stock data

Parameters
sessionId
product
data
Throws
RemoteException

public abstract int catalogProductAttributeCurrentStore (String sessionId, String storeView)

Set/Get current store view

Parameters
sessionId
storeView
Throws
RemoteException

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

Retrieve attribute list

Parameters
sessionId
setId
Throws
RemoteException

public abstract 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 abstract int catalogProductAttributeMediaCurrentStore (String sessionId, String storeView)

Set/Get current store view

Parameters
sessionId
storeView
Throws
RemoteException

public abstract 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 abstract CatalogProductImageEntity[] catalogProductAttributeMediaList (String sessionId, String product, String storeView, String productIdentifierType)

Retrieve product image list

Parameters
sessionId
product
storeView
productIdentifierType
Throws
RemoteException

public abstract int catalogProductAttributeMediaRemove (String sessionId, String product, String file, String productIdentifierType)

Remove product image

Parameters
sessionId
product
file
productIdentifierType
Throws
RemoteException

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

Retrieve product image types

Parameters
sessionId
setId
Throws
RemoteException

public abstract 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 abstract CatalogAttributeOptionEntity[] catalogProductAttributeOptions (String sessionId, String attributeId, String storeView)

Retrieve attribute options

Parameters
sessionId
attributeId
storeView
Throws
RemoteException

public abstract CatalogProductAttributeSetEntity[] catalogProductAttributeSetList (String sessionId)

Retrieve product attribute sets

Parameters
sessionId
Throws
RemoteException

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

Retrieve product tier prices

Parameters
sessionId
product
productIdentifierType
Throws
RemoteException

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

Update product tier prices

Parameters
sessionId
product
tier_price
productIdentifierType
Throws
RemoteException

public abstract 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 abstract int catalogProductCurrentStore (String sessionId, String storeView)

Set/Get current store view

Parameters
sessionId
storeView
Throws
RemoteException

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

Delete product

Parameters
sessionId
product
productIdentifierType
Throws
RemoteException

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

Get product special price data

Parameters
sessionId
product
storeView
productIdentifierType
Throws
RemoteException

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

Retrieve product

Parameters
sessionId
product
storeView
attributes
productIdentifierType
Throws
RemoteException

public abstract 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 abstract CatalogProductLinkAttributeEntity[] catalogProductLinkAttributes (String sessionId, String type)

Retrieve product link type attributes

Parameters
sessionId
type
Throws
RemoteException

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

Retrieve linked products

Parameters
sessionId
type
product
productIdentifierType
Throws
RemoteException

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

Remove product link

Parameters
sessionId
type
product
linkedProduct
productIdentifierType
Throws
RemoteException

public abstract String[] catalogProductLinkTypes (String sessionId)

Retrieve product link types

Parameters
sessionId
Throws
RemoteException

public abstract 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 abstract CatalogProductEntity[] catalogProductList (String sessionId, Filters filters, String storeView)

Retrieve products list by filters

Parameters
sessionId
filters
storeView
Throws
RemoteException

public abstract 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 abstract CatalogProductTypeEntity[] catalogProductTypeList (String sessionId)

Retrieve product types

Parameters
sessionId
Throws
RemoteException

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

Update product

Parameters
sessionId
product
productData
storeView
productIdentifierType
Throws
RemoteException

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

Create customer address

Parameters
sessionId
customerId
addressData
Throws
RemoteException

public abstract boolean customerAddressDelete (String sessionId, int addressId)

Delete customer address

Parameters
sessionId
addressId
Throws
RemoteException

public abstract CustomerAddressEntityItem customerAddressInfo (String sessionId, int addressId)

Retrieve customer address data

Parameters
sessionId
addressId
Throws
RemoteException

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

Retrieve customer addresses

Parameters
sessionId
customerId
Throws
RemoteException

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

Update customer address data

Parameters
sessionId
addressId
addressData
Throws
RemoteException

public abstract int customerCustomerCreate (String sessionId, CustomerCustomerEntityToCreate customerData)

Create customer

Parameters
sessionId
customerData
Throws
RemoteException

public abstract boolean customerCustomerDelete (String sessionId, int customerId)

Delete customer

Parameters
sessionId
customerId
Throws
RemoteException

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

Retrieve customer data

Parameters
sessionId
customerId
attributes
Throws
RemoteException

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

Retrieve customers

Parameters
sessionId
filters
Throws
RemoteException

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

Update customer data

Parameters
sessionId
customerId
customerData
Throws
RemoteException

public abstract CustomerGroupEntity[] customerGroupList (String sessionId)

Retrieve customer groups

Parameters
sessionId
Throws
RemoteException

public abstract DirectoryCountryEntity[] directoryCountryList (String sessionId)

List of countries

Parameters
sessionId
Throws
RemoteException

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

List of regions in specified country

Parameters
sessionId
country
Throws
RemoteException

public abstract boolean endSession (String sessionId)

End web service session

Parameters
sessionId
Throws
RemoteException

public abstract 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 abstract 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 abstract 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 abstract ExistsFaltureEntity[] globalFaults (String sessionId)

List of global faults

Parameters
sessionId
Throws
RemoteException

public abstract String login (String username, String apiKey)

Login user and retrive session id

Parameters
username
apiKey
Throws
RemoteException

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

List of resource faults

Parameters
resourceName
sessionId
Throws
RemoteException

public abstract ApiEntity[] resources (String sessionId)

List of available resources

Parameters
sessionId
Throws
RemoteException

public abstract 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 abstract int salesOrderCancel (String sessionId, String orderIncrementId)

Cancel order

Parameters
sessionId
orderIncrementId
Throws
RemoteException

public abstract int salesOrderHold (String sessionId, String orderIncrementId)

Hold order

Parameters
sessionId
orderIncrementId
Throws
RemoteException

public abstract SalesOrderEntity salesOrderInfo (String sessionId, String orderIncrementId)

Retrieve order information

Parameters
sessionId
orderIncrementId
Throws
RemoteException

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

Cancel invoice

Parameters
sessionId
invoiceIncrementId
Throws
RemoteException

public abstract String salesOrderInvoiceCapture (String sessionId, String invoiceIncrementId)

Capture invoice

Parameters
sessionId
invoiceIncrementId
Throws
RemoteException

public abstract 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 abstract SalesOrderInvoiceEntity salesOrderInvoiceInfo (String sessionId, String invoiceIncrementId)

Retrieve invoice information

Parameters
sessionId
invoiceIncrementId
Throws
RemoteException

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

Retrieve list of invoices by filters

Parameters
sessionId
filters
Throws
RemoteException

public abstract String salesOrderInvoiceVoid (String sessionId, String invoiceIncrementId)

Void invoice

Parameters
sessionId
invoiceIncrementId
Throws
RemoteException

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

Retrieve list of orders by filters

Parameters
sessionId
filters
Throws
RemoteException

public abstract 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 abstract 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 abstract 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 abstract AssociativeEntity[] salesOrderShipmentGetCarriers (String sessionId, String orderIncrementId)

Retrieve list of allowed carriers for order

Parameters
sessionId
orderIncrementId
Throws
RemoteException

public abstract SalesOrderShipmentEntity salesOrderShipmentInfo (String sessionId, String shipmentIncrementId)

Retrieve shipment information

Parameters
sessionId
shipmentIncrementId
Throws
RemoteException

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

Retrieve list of shipments by filters

Parameters
sessionId
filters
Throws
RemoteException

public abstract int salesOrderShipmentRemoveTrack (String sessionId, String shipmentIncrementId, String trackId)

Remove tracking number

Parameters
sessionId
shipmentIncrementId
trackId
Throws
RemoteException

public abstract int salesOrderUnhold (String sessionId, String orderIncrementId)

Unhold order

Parameters
sessionId
orderIncrementId
Throws
RemoteException

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

Add coupon code for shopping cart

Parameters
sessionId
quoteId
couponCode
storeId
Throws
RemoteException

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

Remove coupon code from shopping cart

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

public abstract int shoppingCartCreate (String sessionId, String storeId)

Create shopping cart

Parameters
sessionId
storeId
Throws
RemoteException

public abstract 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 abstract boolean shoppingCartCustomerSet (String sessionId, int quoteId, ShoppingCartCustomerEntity customer, String storeId)

Set customer for shopping cart

Parameters
sessionId
quoteId
customer
storeId
Throws
RemoteException

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

Retrieve information about shopping cart

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

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

Get terms and conditions

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

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

Create an order from shopping cart

Parameters
sessionId
quoteId
storeId
licenses
Throws
RemoteException

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

Get list of available payment methods

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

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

Set payment method

Parameters
sessionId
quoteId
method
storeId
Throws
RemoteException

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

Add product(s) to shopping cart

Parameters
sessionId
quoteId
products
storeId
Throws
RemoteException

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

Get list of products in shopping cart

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

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

Move product(s) to customer quote

Parameters
sessionId
quoteId
products
storeId
Throws
RemoteException

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

Remove product(s) from shopping cart

Parameters
sessionId
quoteId
products
storeId
Throws
RemoteException

public abstract 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 abstract ShoppingCartShippingMethodEntity[] shoppingCartShippingList (String sessionId, int quoteId, String storeId)

Get list of available shipping methods

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

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

Set shipping method

Parameters
sessionId
quoteId
method
storeId
Throws
RemoteException

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

Get total prices for shopping cart

Parameters
sessionId
quoteId
storeId
Throws
RemoteException

public abstract String startSession ()

Start web service session

Throws
RemoteException