|
boolean
|
addCategoryProduct(int categoryId, Integer productId, String productSku, String productIdOrSku, String position)
Assign product to category.
|
|
boolean
|
addOrderComment(String orderId, String status, String comment, boolean sendEmail)
Adds a comment to the given order id
|
|
boolean
|
addOrderInvoiceComment(String invoiceId, String comment, boolean sendEmail, boolean includeCommentInEmail)
Adds a comment to the given order's invoice
|
|
boolean
|
addOrderShipmentComment(String shipmentId, String comment, boolean sendEmail, boolean includeCommentInEmail)
Adds a comment to the shipment.
|
|
int
|
addOrderShipmentTrack(String shipmentId, String carrierCode, String title, String trackId)
Adds a new tracking number
|
|
boolean
|
addProductLink(String type, Integer productId, String productSku, String productIdOrSku, String linkedProductIdOrSku, CatalogProductLinkEntity productLinkEntity)
Links two products, given its source and destination productIdOrSku.
|
|
boolean
|
addShoppingCartCoupon(int quoteId, String couponCode, String storeId)
Adds a coupon code for a shopping cart (quote).
|
|
boolean
|
addShoppingCartProduct(int quoteId, List<ShoppingCartProductEntity> products, String storeId)
Adds one or more products to the shopping cart (quote).
|
|
boolean
|
cancelOrder(String orderId)
|
|
void
|
cancelOrderInvoice(String invoiceId)
Cancels an order's invoice
|
|
void
|
captureOrderInvoice(String invoiceId)
|
|
String
|
connectionId()
|
|
int
|
createCategory(int parentId, CatalogCategoryEntityCreate catalogCategoryEntity, String storeViewIdOrCode)
Creates a new category.
|
|
int
|
createCustomer(CustomerCustomerEntityToCreate customer)
Creates a customer with the given attributes
|
|
int
|
createCustomerAddress(int customerId, CustomerAddressEntityCreate customerAddress)
Creates a new address for the given customer using the given address
attributes
|
|
String
|
createOrderInvoice(String orderId, List<OrderItemIdQty> itemsQuantities, String comment, boolean sendEmail, boolean includeCommentInEmail)
Creates an invoice for the given order
|
|
String
|
createOrderShipment(String orderId, List<OrderItemIdQty> itemsQuantities, String comment, boolean sendEmail, boolean includeCommentInEmail)
Creates a shipment for order
|
|
int
|
createProduct(String type, int set, String sku, CatalogProductCreateEntity attributes, List<AssociativeEntity> additionalAttributes, String storeViewIdOrCode)
|
|
String
|
createProductAttributeMedia(Integer productId, String productSku, String productIdOrSku, CatalogProductAttributeMediaCreateEntity catalogProductAttributeMediaEntity, String storeViewIdOrCode, Object payload, MediaMimeType mimeType, String baseFileName)
Creates a new product media.
|
|
int
|
createShoppingCart(String storeId)
Creates an empty shopping cart.
|
|
String
|
createShoppingCartOrder(int quoteId, String storeId, List<String> licenses)
Creates an order from a shopping cart (quote).
|
|
boolean
|
deleteCategory(int categoryId)
Deletes a category.
|
|
boolean
|
deleteCategoryProduct(int categoryId, Integer productId, String productSku, String productIdOrSku)
Remove a product assignment.
|
|
boolean
|
deleteCustomer(int customerId)
Deletes a customer given its id
|
|
boolean
|
deleteCustomerAddress(int addressId)
Deletes a Customer Address
|
|
boolean
|
deleteOrderShipmentTrack(String shipmentId, String trackId)
Deletes the given track of the given order's shipment
|
|
int
|
deleteProduct(Integer productId, String productSku, String productIdOrSku)
Deletes a product.
|
|
boolean
|
deleteProductAttributeMedia(Integer productId, String productSku, String productIdOrSku, String fileName)
Removes a product image.
|
|
boolean
|
deleteProductLink(String type, Integer productId, String productSku, String productIdOrSku, String linkedProductIdOrSku)
Deletes a product's link.
|
|
void
|
disconnect()
|
|
int
|
getCatalogCurrentStoreView()
Answers the current default catalog store view id for this session
|
|
CatalogCategoryInfo
|
getCategory(int categoryId, String storeViewIdOrCode, List<String> attributeNames)
Answers category attributes.
|
|
CatalogCategoryTree
|
getCategoryTree(String parentId, String storeViewIdOrCode)
Answers the category tree.
|
|
CustomerCustomerEntity
|
getCustomer(int customerId, List<String> attributeNames)
Answers customer attributes for the given id.
|
|
CustomerAddressEntityItem
|
getCustomerAddress(int addressId)
Answers the customer address attributes
|
|
ShoppingCartInfoEntity
|
getInfoShoppingCart(int quoteId, String storeId)
Retrieves full information about the shopping cart (quote).
|
|
MetaData
|
getMetadata(MetaDataKey key)
|
|
List<MetaDataKey>
|
getMetadataKeys()
|
|
SalesOrderEntity
|
getOrder(String orderId)
Answers the order properties for the given orderId
|
|
SalesOrderInvoiceEntity
|
getOrderInvoice(String invoiceId)
Retrieves order invoice information
|
|
SalesOrderShipmentEntity
|
getOrderShipment(String shipmentId)
Retrieves the order shipment attributes
|
|
List<Carrier>
|
getOrderShipmentCarriers(String orderId)
Retrieves the order shipment carriers.
|
|
CatalogProductReturnEntity
|
getProduct(Integer productId, String productSku, String productIdOrSku, String storeViewIdOrCode, List<String> attributesNames, List<String> additionalAttributeNames)
Answers a product's specified attributes.
|
|
CatalogProductImageEntity
|
getProductAttributeMedia(Integer productId, String productSku, String productIdOrSku, String fileName, String storeViewIdOrCode)
Lists linked products to the given product and for the given link type.
|
|
CatalogProductReturnEntity
|
getProductSpecialPrice(Integer productId, String productSku, String productIdOrSku, String storeViewIdOrCode)
Answers a product special price.
|
|
String
|
getServerAddress()
|
|
String
|
getUser()
|
|
boolean
|
holdOrder(String orderId)
Puts order on hold.
|
|
void
|
initialiseConnector(String username, String password, String address)
|
|
List<CatalogAttributeOptionEntity>
|
listCategoryAttributeOptions(String attributeId, String storeViewIdOrCode)
Retrieves attribute options.
|
|
List<CatalogAttributeEntity>
|
listCategoryAttributes()
Retrieve product image types.
|
|
List<CatalogCategoryEntityNoChildren>
|
listCategoryLevels(String website, String storeViewIdOrCode, String parentCategoryId)
Answers levels of categories for a website, store view and parent category
|
|
List<CatalogAssignedProduct>
|
listCategoryProducts(int categoryId)
Lists product of a given category.
|
|
List<CustomerAddressEntityItem>
|
listCustomerAddresses(int customerId)
Lists the customer address for a given customer id
|
|
List<CustomerGroupEntity>
|
listCustomerGroups()
Lists all the customer groups
|
|
List<CustomerCustomerEntity>
|
listCustomers(String filter)
Answers a list of customer attributes for the given filter expression.
|
|
List<DirectoryCountryEntity>
|
listDirectoryCountries()
Answers the list of countries
|
|
List<DirectoryRegionEntity>
|
listDirectoryRegions(String countryId)
Answers a list of regions for the given county
|
|
List<CatalogInventoryStockItemEntity>
|
listInventoryStockItems(List<String> productIdOrSkus)
Lists inventory stock items.
|
|
List<SalesOrderListEntity>
|
listOrders(String filter)
Lists order attributes that match the given filtering expression.
|
|
List<SalesOrderInvoiceEntity>
|
listOrdersInvoices(String filter)
Lists order invoices that match the given filtering expression
|
|
List<SalesOrderShipmentEntity>
|
listOrdersShipments(String filter)
Lists order shipment atrributes that match the given
optional filtering expression
|
|
List<CatalogProductImageEntity>
|
listProductAttributeMedia(Integer productId, String productSku, String productIdOrSku, String storeViewIdOrCode)
Retrieves product image list.
|
|
List<CatalogProductAttributeMediaTypeEntity>
|
listProductAttributeMediaTypes(int setId)
Retrieve product image types.
|
|
List<CatalogAttributeOptionEntity>
|
listProductAttributeOptions(String attributeId, String storeViewIdOrCode)
Answers the product attribute options.
|
|
List<CatalogProductAttributeSetEntity>
|
listProductAttributeSets()
Retrieves product attribute sets.
|
|
List<CatalogProductTierPriceEntity>
|
listProductAttributeTierPrices(Integer productId, String productSku, String productIdOrSku)
Retrieve product tier prices.
|
|
List<CatalogAttributeEntity>
|
listProductAttributes(int setId)
Retrieves product attributes list.
|
|
List<CatalogProductLinkEntity>
|
listProductLink(String type, Integer productId, String productSku, String productIdOrSku)
Lists linked products to the given product and for the given link type
|
|
List<CatalogProductLinkAttributeEntity>
|
listProductLinkAttributes(String type)
Lists all the attributes for the given product link type
|
|
List<String>
|
listProductLinkTypes()
Answers product link types
|
|
List<CatalogProductTypeEntity>
|
listProductTypes()
Answers product types.
|
|
List<CatalogProductEntity>
|
listProducts(String filter, String storeViewIdOrCode)
Retrieve products list by filters.
|
|
List<ShoppingCartLicenseEntity>
|
listShoppingCartLicenses(int quoteId, String storeId)
Retrieves the website license agreement for the quote according to the website (store).
|
|
ShoppingCartPaymentMethodResponseEntityArray
|
listShoppingCartPaymentMethods(int quoteId, String storeId)
Retrieves a list of available payment methods for a shopping cart (quote).
|
|
List<CatalogProductEntity>
|
listShoppingCartProducts(int quoteId, String storeId)
Retrieves the list of products in the shopping cart (quote).
|
|
List<ShoppingCartShippingMethodEntity>
|
listShoppingCartShippingMethods(int quoteId, String storeId)
Retrieves the list of available shipping methods for a shopping cart (quote).
|
|
List<ShoppingCartTotalsEntity>
|
listShoppingCartTotals(int quoteId, String storeId)
Retrieves total prices for a shopping cart (quote).
|
|
List<CatalogInventoryStockItemEntity>
|
listStockItems(List<String> productIdOrSkus)
Retrieve stock data by product ids
|
|
void
|
moveCategory(int categoryId, int parentId, String afterId)
Move category in tree.
|
|
boolean
|
moveShoppingCartProductToCustomerQuote(int quoteId, List<ShoppingCartProductEntity> products, String storeId)
Moves products from the current quote to a customer quote.
|
|
boolean
|
removeShoppingCartCoupon(int quoteId, String storeId)
Removes a coupon code from a shopping cart (quote).
|
|
boolean
|
removeShoppingCartProduct(int quoteId, List<ShoppingCartProductEntity> products, String storeId)
Removes one or several products from a shopping cart (quote).
|
|
void
|
setCatalogClient(MagentoCatalogClient<?> catalogClient)
|
|
void
|
setCustomerClient(MagentoCustomerClient<?> customerClient)
|
|
void
|
setDirectoryClient(MagentoDirectoryClient<?> directoryClient)
|
|
void
|
setInventoryClient(MagentoInventoryClient<?> inventoryClient)
|
|
void
|
setOrderClient(MagentoOrderClient<?> magentoOrderClient)
|
|
void
|
setServerAddress(String serverAddress)
|
|
void
|
setShoppingCartClient(MagentoShoppingCartClient<?> catalogClient)
|
|
boolean
|
setShoppingCartCustomer(int quoteId, ShoppingCartCustomerEntity customer, String storeId)
Adds information about the customer to a shopping cart (quote).
|
|
boolean
|
setShoppingCartCustomerAddresses(int quoteId, List<ShoppingCartCustomerAddressEntity> shoppingCartCustomerAddresses, String storeId)
Sets the customer addresses in the shopping cart (quote).
|
|
boolean
|
setShoppingCartPaymentMethod(int quoteId, ShoppingCartPaymentMethodEntity shoppingCartPaymentMethod, String storeId)
Sets a payment method for a shopping cart (quote), cart must not be empty.
|
|
boolean
|
setShoppingCartShippingMethod(int quoteId, String method, String storeId)
Retrieves a shipping method for a shopping cart (quote).
|
|
void
|
setUser(String user)
|
|
String
|
toNativeQuery(Query query)
|
|
boolean
|
unholdOrder(String orderId)
|
|
boolean
|
updateCategory(int categoryId, CatalogCategoryEntityCreate catalogCategoryEntity, String storeViewIdOrCode)
Updates a category.
|
|
int
|
updateCategoryAttributeStoreView(String storeViewIdOrCode)
Set the default catalog store view for this session
|
|
boolean
|
updateCategoryProduct(int categoryId, Integer productId, String productSku, String productIdOrSku, String position)
Updates a category product.
|
|
boolean
|
updateCustomer(int customerId, CustomerCustomerEntityToCreate customer)
Updates the given customer attributes, for the given customer id.
|
|
boolean
|
updateCustomerAddress(int addressId, CustomerAddressEntityCreate customerAddress)
Updates the given map of customer address attributes, for the given customer address
|
|
int
|
updateInventoryStockItem(Integer productId, String productSku, String productIdOrSku, CatalogInventoryStockItemUpdateEntity catalogInventoryStockItem)
Updates an stock inventory item
|
|
boolean
|
updateProduct(Integer productId, String productSku, String productIdOrSku, CatalogProductCreateEntity catalogProductEntity, List<AssociativeEntity> additionalAttributes, String storeViewIdOrCode)
Updates a product.
|
|
boolean
|
updateProductAttributeMedia(Integer productId, String productSku, String productIdOrSku, String fileName, CatalogProductAttributeMediaCreateEntity catalogProductAttributeMediaEntity, String storeViewIdOrCode)
Updates product media.
|
|
int
|
updateProductAttributeTierPrice(Integer productId, String productSku, String productIdOrSku, CatalogProductTierPriceEntity catalogProductTierPriceEntity)
Updates a single product tier price.
|
|
boolean
|
updateProductLink(String type, Integer productId, String productSku, String productIdOrSku, String linkedProductIdOrSku, CatalogProductLinkEntity catalogProductLinkEntity)
|
|
int
|
updateProductSpecialPrice(Integer productId, String productSku, String productIdOrSku, String specialPrice, String fromDate, String toDate, String storeViewIdOrCode)
Sets a product special price.
|
|
boolean
|
updateShoppingCartProduct(int quoteId, List<ShoppingCartProductEntity> products, String storeId)
Updates one or several products in the shopping cart (quote).
|
|
int
|
updateStockItem(String productIdOrSku, CatalogInventoryStockItemUpdateEntity stockItem)
Update product stock data given its id or sku
|
|
boolean
|
validateConnection()
|
|
boolean
|
voidOrderInvoice(String invoiceId)
|
Known Direct Subclasses