| 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
boolean
|
catalogProductAttributeAddOption(String sessionId, String attribute, CatalogProductAttributeOptionEntityToAdd data)
Add option to attribute
|
|
abstract
int
|
catalogProductAttributeCreate(String sessionId, CatalogProductAttributeEntityToCreate data)
Create new attribute
|
|
abstract
int
|
catalogProductAttributeCurrentStore(String sessionId, String storeView)
Set/Get current store view
|
|
abstract
CatalogProductAttributeEntity
|
catalogProductAttributeInfo(String sessionId, String attribute)
Get full information about attribute with list of options
|
|
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
boolean
|
catalogProductAttributeMediaRemove(String sessionId, String product, String file, String productIdentifierType)
Remove product image
|
|
abstract
CatalogProductAttributeMediaTypeEntity[]
|
catalogProductAttributeMediaTypes(String sessionId, String setId)
Retrieve product image types
|
|
abstract
boolean
|
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
boolean
|
catalogProductAttributeRemove(String sessionId, String attribute)
Delete attribute
|
|
abstract
boolean
|
catalogProductAttributeRemoveOption(String sessionId, String attribute, String optionId)
Remove option from attribute
|
|
abstract
boolean
|
catalogProductAttributeSetAttributeAdd(String sessionId, String attributeId, String attributeSetId, String attributeGroupId, String sortOrder)
Add attribute into attribute set
|
|
abstract
boolean
|
catalogProductAttributeSetAttributeRemove(String sessionId, String attributeId, String attributeSetId)
Remove attribute from attribute set
|
|
abstract
int
|
catalogProductAttributeSetCreate(String sessionId, String attributeSetName, String skeletonSetId)
Create product attribute set based on another set
|
|
abstract
int
|
catalogProductAttributeSetGroupAdd(String sessionId, String attributeSetId, String groupName)
Create group within existing attribute set
|
|
abstract
boolean
|
catalogProductAttributeSetGroupRemove(String sessionId, String attributeGroupId)
Remove group from attribute set
|
|
abstract
boolean
|
catalogProductAttributeSetGroupRename(String sessionId, String groupId, String groupName)
Rename existing group
|
|
abstract
CatalogProductAttributeSetEntity[]
|
catalogProductAttributeSetList(String sessionId)
Retrieve product attribute sets
|
|
abstract
boolean
|
catalogProductAttributeSetRemove(String sessionId, String attributeSetId, String forceProductsRemove)
Remove product attribute set
|
|
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
CatalogAttributeOptionEntity[]
|
catalogProductAttributeTypes(String sessionId)
Get list of possible attribute types
|
|
abstract
boolean
|
catalogProductAttributeUpdate(String sessionId, String attribute, CatalogProductAttributeEntityToUpdate data)
Update attribute
|
|
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
boolean
|
catalogProductCustomOptionAdd(String sessionId, String productId, CatalogProductCustomOptionToAdd data, String store)
Add new custom option into product
|
|
abstract
CatalogProductCustomOptionInfoEntity
|
catalogProductCustomOptionInfo(String sessionId, String optionId, String store)
Get full information about custom option in product
|
|
abstract
CatalogProductCustomOptionListEntity[]
|
catalogProductCustomOptionList(String sessionId, String productId, String store)
Retrieve list of product custom options
|
|
abstract
boolean
|
catalogProductCustomOptionRemove(String sessionId, String optionId)
Remove custom option
|
|
abstract
CatalogProductCustomOptionTypesEntity[]
|
catalogProductCustomOptionTypes(String sessionId)
Get list of available custom option types
|
|
abstract
boolean
|
catalogProductCustomOptionUpdate(String sessionId, String optionId, CatalogProductCustomOptionToUpdate data, String store)
Update product custom option
|
|
abstract
boolean
|
catalogProductCustomOptionValueAdd(String sessionId, String optionId, CatalogProductCustomOptionValueAddEntity[] data, String store)
Add new custom option values
|
|
abstract
CatalogProductCustomOptionValueInfoEntity
|
catalogProductCustomOptionValueInfo(String sessionId, String valueId, String store)
Retrieve custom option value info
|
|
abstract
CatalogProductCustomOptionValueListEntity[]
|
catalogProductCustomOptionValueList(String sessionId, String optionId, String store)
Retrieve custom option values list
|
|
abstract
boolean
|
catalogProductCustomOptionValueRemove(String sessionId, String valueId)
Remove value from custom option
|
|
abstract
boolean
|
catalogProductCustomOptionValueUpdate(String sessionId, String valueId, CatalogProductCustomOptionValueUpdateEntity data, String storeId)
Update custom option value
|
|
abstract
int
|
catalogProductDelete(String sessionId, String product, String productIdentifierType)
Delete product
|
|
abstract
int
|
catalogProductDownloadableLinkAdd(String sessionId, String productId, CatalogProductDownloadableLinkAddEntity resource, String resourceType, String store, String identifierType)
Add links to downloadable product
|
|
abstract
CatalogProductDownloadableLinkInfoEntity
|
catalogProductDownloadableLinkList(String sessionId, String productId, String store, String identifierType)
Retrieve list of links and samples for downloadable product
|
|
abstract
boolean
|
catalogProductDownloadableLinkRemove(String sessionId, String linkId, String resourceType)
Remove links and samples from downloadable 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
boolean
|
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
boolean
|
catalogProductLinkRemove(String sessionId, String type, String product, String linkedProduct, String productIdentifierType)
Remove product link
|
|
abstract
String[]
|
catalogProductLinkTypes(String sessionId)
Retrieve product link types
|
|
abstract
boolean
|
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
CatalogAttributeEntity[]
|
catalogProductListOfAdditionalAttributes(String sessionId, String productType, String attributeSetId)
Get list of additional attributes which are not in default
create/update list
|
|
abstract
int
|
catalogProductSetSpecialPrice(String sessionId, String product, String specialPrice, String fromDate, String toDate, String storeView, String productIdentifierType)
Update product special price
|
|
abstract
AssociativeEntity[]
|
catalogProductTagAdd(String sessionId, CatalogProductTagAddEntity data)
Add tag(s) to product
|
|
abstract
CatalogProductTagInfoEntity
|
catalogProductTagInfo(String sessionId, String tagId, String store)
Retrieve product tag info
|
|
abstract
CatalogProductTagListEntity[]
|
catalogProductTagList(String sessionId, String productId, String store)
Retrieve list of tags by product
|
|
abstract
boolean
|
catalogProductTagRemove(String sessionId, String tagId)
Remove product tag
|
|
abstract
boolean
|
catalogProductTagUpdate(String sessionId, String tagId, CatalogProductTagUpdateEntity data, String store)
Update product tag
|
|
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
MagentoInfoEntity
|
magentoInfo(String sessionId)
Info about current Magento installation
|
|
abstract
ExistsFaltureEntity[]
|
resourceFaults(String resourceName, String sessionId)
List of resource faults
|
|
abstract
ApiEntity[]
|
resources(String sessionId)
List of available resources
|
|
abstract
boolean
|
salesOrderAddComment(String sessionId, String orderIncrementId, String status, String comment, String notify)
Add comment to order
|
|
abstract
boolean
|
salesOrderCancel(String sessionId, String orderIncrementId)
Cancel order
|
|
abstract
boolean
|
salesOrderCreditmemoAddComment(String sessionId, String creditmemoIncrementId, String comment, int notifyCustomer, int includeComment)
Add new comment to shipment
|
|
abstract
boolean
|
salesOrderCreditmemoCancel(String sessionId, String creditmemoIncrementId)
Cancel creditmemo
|
|
abstract
String
|
salesOrderCreditmemoCreate(String sessionId, String creditmemoIncrementId, SalesOrderCreditmemoData creditmemoData, String comment, int notifyCustomer, int includeComment, String refundToStoreCreditAmount)
Create new creditmemo for order
|
|
abstract
SalesOrderCreditmemoEntity
|
salesOrderCreditmemoInfo(String sessionId, String creditmemoIncrementId)
Retrieve creditmemo information
|
|
abstract
SalesOrderCreditmemoEntity[]
|
salesOrderCreditmemoList(String sessionId, Filters filters)
Retrieve list of creditmemos by filters
|
|
abstract
boolean
|
salesOrderHold(String sessionId, String orderIncrementId)
Hold order
|
|
abstract
SalesOrderEntity
|
salesOrderInfo(String sessionId, String orderIncrementId)
Retrieve order information
|
|
abstract
boolean
|
salesOrderInvoiceAddComment(String sessionId, String invoiceIncrementId, String comment, String email, String includeComment)
Add new comment to shipment
|
|
abstract
boolean
|
salesOrderInvoiceCancel(String sessionId, String invoiceIncrementId)
Cancel invoice
|
|
abstract
boolean
|
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
boolean
|
salesOrderInvoiceVoid(String sessionId, String invoiceIncrementId)
Void invoice
|
|
abstract
SalesOrderListEntity[]
|
salesOrderList(String sessionId, Filters filters)
Retrieve list of orders by filters
|
|
abstract
boolean
|
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
boolean
|
salesOrderShipmentRemoveTrack(String sessionId, String shipmentIncrementId, String trackId)
Remove tracking number
|
|
abstract
boolean
|
salesOrderShipmentSendInfo(String sessionId, String shipmentIncrementId, String comment)
Send shipment info
|
|
abstract
boolean
|
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
|
|
abstract
StoreEntity
|
storeInfo(String sessionId, String storeId)
Store view info
|
|
abstract
StoreEntity[]
|
storeList(String sessionId)
List of stores
|
Known Indirect Subclasses