Essa é a API para a conexão de um sistema externo com a Get Commerce.

Para que você tenha acesso a API da Get Commerce é preciso solicitar através do e-mail [email protected] as credenciais para sua loja.

Web Service: GetCommerceService

Target Namespace:
urn:Magento

Port Port Port typeSource code

Location:
https://dominio.com.br/api/v2_soap/index/
Protocol:
SOAP
Default style:
document
Transport protocol:
SOAP over HTTP
Operations:
  1. callDetailSource code
  2. catalogCategoryAssignProductDetailSource code
  3. catalogCategoryAssignedProductsDetailSource code
  4. catalogCategoryAttributeCurrentStoreDetailSource code
  5. catalogCategoryAttributeListDetailSource code
  6. catalogCategoryAttributeOptionsDetailSource code
  7. catalogCategoryCreateDetailSource code
  8. catalogCategoryCurrentStoreDetailSource code
  9. catalogCategoryDeleteDetailSource code
  10. catalogCategoryInfoDetailSource code
  11. catalogCategoryLevelDetailSource code
  12. catalogCategoryMoveDetailSource code
  13. catalogCategoryRemoveProductDetailSource code
  14. catalogCategoryTreeDetailSource code
  15. catalogCategoryUpdateDetailSource code
  16. catalogCategoryUpdateProductDetailSource code
  17. catalogInventoryStockItemListDetailSource code
  18. catalogInventoryStockItemMultiUpdateDetailSource code
  19. catalogInventoryStockItemUpdateDetailSource code
  20. catalogProductAttributeAddOptionDetailSource code
  21. catalogProductAttributeCreateDetailSource code
  22. catalogProductAttributeCurrentStoreDetailSource code
  23. catalogProductAttributeInfoDetailSource code
  24. catalogProductAttributeListDetailSource code
  25. catalogProductAttributeMediaCreateDetailSource code
  26. catalogProductAttributeMediaCurrentStoreDetailSource code
  27. catalogProductAttributeMediaInfoDetailSource code
  28. catalogProductAttributeMediaListDetailSource code
  29. catalogProductAttributeMediaRemoveDetailSource code
  30. catalogProductAttributeMediaTypesDetailSource code
  31. catalogProductAttributeMediaUpdateDetailSource code
  32. catalogProductAttributeOptionsDetailSource code
  33. catalogProductAttributeRemoveDetailSource code
  34. catalogProductAttributeSetAttributeAddDetailSource code
  35. catalogProductAttributeSetAttributeRemoveDetailSource code
  36. catalogProductAttributeSetCreateDetailSource code
  37. catalogProductAttributeSetGroupAddDetailSource code
  38. catalogProductAttributeSetGroupRemoveDetailSource code
  39. catalogProductAttributeSetGroupRenameDetailSource code
  40. catalogProductAttributeSetListDetailSource code
  41. catalogProductAttributeSetRemoveDetailSource code
  42. catalogProductAttributeTierPriceInfoDetailSource code
  43. catalogProductAttributeTierPriceUpdateDetailSource code
  44. catalogProductAttributeUpdateDetailSource code
  45. catalogProductCreateDetailSource code
  46. catalogProductCurrentStoreDetailSource code
  47. catalogProductCustomOptionAddDetailSource code
  48. catalogProductCustomOptionInfoDetailSource code
  49. catalogProductCustomOptionListDetailSource code
  50. catalogProductCustomOptionRemoveDetailSource code
  51. catalogProductCustomOptionTypesDetailSource code
  52. catalogProductCustomOptionUpdateDetailSource code
  53. catalogProductCustomOptionValueAddDetailSource code
  54. catalogProductCustomOptionValueInfoDetailSource code
  55. catalogProductCustomOptionValueListDetailSource code
  56. catalogProductCustomOptionValueRemoveDetailSource code
  57. catalogProductCustomOptionValueUpdateDetailSource code
  58. catalogProductDeleteDetailSource code
  59. catalogProductDownloadableLinkAddDetailSource code
  60. catalogProductDownloadableLinkListDetailSource code
  61. catalogProductDownloadableLinkRemoveDetailSource code
  62. catalogProductGetSpecialPriceDetailSource code
  63. catalogProductInfoDetailSource code
  64. catalogProductLinkAssignDetailSource code
  65. catalogProductLinkAttributesDetailSource code
  66. catalogProductLinkListDetailSource code
  67. catalogProductLinkRemoveDetailSource code
  68. catalogProductLinkTypesDetailSource code
  69. catalogProductLinkUpdateDetailSource code
  70. catalogProductListDetailSource code
  71. catalogProductMultiUpdateDetailSource code
  72. catalogProductSetSpecialPriceDetailSource code
  73. catalogProductTagAddDetailSource code
  74. catalogProductTagInfoDetailSource code
  75. catalogProductTagListDetailSource code
  76. catalogProductTagRemoveDetailSource code
  77. catalogProductTagUpdateDetailSource code
  78. catalogProductTypeListDetailSource code
  79. catalogProductUpdateDetailSource code
  80. customerAddressCreateDetailSource code
  81. customerAddressDeleteDetailSource code
  82. customerAddressInfoDetailSource code
  83. customerAddressListDetailSource code
  84. customerAddressUpdateDetailSource code
  85. customerCustomerCreateDetailSource code
  86. customerCustomerDeleteDetailSource code
  87. customerCustomerInfoDetailSource code
  88. customerCustomerListDetailSource code
  89. customerCustomerUpdateDetailSource code
  90. customerGroupListDetailSource code
  91. directoryCountryListDetailSource code
  92. directoryRegionListDetailSource code
  93. endSessionDetailSource code
  94. giftMessageSetForQuoteDetailSource code
  95. giftMessageSetForQuoteItemDetailSource code
  96. giftMessageSetForQuoteProductDetailSource code
  97. globalFaultsDetailSource code
  98. loginDetailSource code
  99. magentoInfoDetailSource code
  100. multiCallDetailSource code
  101. resourceFaultsDetailSource code
  102. resourcesDetailSource code
  103. salesOrderAddCommentDetailSource code
  104. salesOrderCancelDetailSource code
  105. salesOrderCreditmemoAddCommentDetailSource code
  106. salesOrderCreditmemoCancelDetailSource code
  107. salesOrderCreditmemoCreateDetailSource code
  108. salesOrderCreditmemoInfoDetailSource code
  109. salesOrderCreditmemoListDetailSource code
  110. salesOrderHoldDetailSource code
  111. salesOrderInfoDetailSource code
  112. salesOrderInvoiceAddCommentDetailSource code
  113. salesOrderInvoiceCancelDetailSource code
  114. salesOrderInvoiceCaptureDetailSource code
  115. salesOrderInvoiceCreateDetailSource code
  116. salesOrderInvoiceInfoDetailSource code
  117. salesOrderInvoiceListDetailSource code
  118. salesOrderInvoiceVoidDetailSource code
  119. salesOrderListDetailSource code
  120. salesOrderShipmentAddCommentDetailSource code
  121. salesOrderShipmentAddTrackDetailSource code
  122. salesOrderShipmentCreateDetailSource code
  123. salesOrderShipmentGetCarriersDetailSource code
  124. salesOrderShipmentInfoDetailSource code
  125. salesOrderShipmentListDetailSource code
  126. salesOrderShipmentRemoveTrackDetailSource code
  127. salesOrderShipmentSendInfoDetailSource code
  128. salesOrderUnholdDetailSource code
  129. shoppingCartCouponAddDetailSource code
  130. shoppingCartCouponRemoveDetailSource code
  131. shoppingCartCreateDetailSource code
  132. shoppingCartCustomerAddressesDetailSource code
  133. shoppingCartCustomerSetDetailSource code
  134. shoppingCartInfoDetailSource code
  135. shoppingCartLicenseDetailSource code
  136. shoppingCartOrderDetailSource code
  137. shoppingCartPaymentListDetailSource code
  138. shoppingCartPaymentMethodDetailSource code
  139. shoppingCartProductAddDetailSource code
  140. shoppingCartProductListDetailSource code
  141. shoppingCartProductMoveToCustomerQuoteDetailSource code
  142. shoppingCartProductRemoveDetailSource code
  143. shoppingCartProductUpdateDetailSource code
  144. shoppingCartShippingListDetailSource code
  145. shoppingCartShippingMethodDetailSource code
  146. shoppingCartTotalsDetailSource code
  147. startSessionDetailSource code
  148. storeInfoDetailSource code
  149. storeListDetailSource code

Operations

    Port type PortTypeSource code

    1. call
      Description:
      Call api functionality
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      call (soap:body, use = literal)Source code
      parameters type callParam
      • sessionId type string
      • apiPath type string
      • args type anyType
      Output:
      callResponse (soap:body, use = literal)Source code
      parameters type callResponseParam
      • result type anyType
    2. catalogCategoryAssignProduct
      Description:
      Assign product to category
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryAssignProductRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryAssignProductRequestParam
      • sessionId type string
      • categoryId type int
      • productId type string
      • position - optional; type string
      • identifierType - optional; type string
      Output:
      catalogCategoryAssignProductResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryAssignProductResponseParam
      • result type boolean
    3. catalogCategoryAssignedProducts
      Description:
      Retrieve list of assigned products
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryAssignedProductsRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryAssignedProductsRequestParam
      • sessionId type string
      • categoryId type int
      • store - optional; type string
      Output:
      catalogCategoryAssignedProductsResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryAssignedProductsResponseParam
      • result type catalogAssignedProductArray
        • complexObjectArray - optional, unbounded; type catalogAssignedProduct
          • product_id type int
          • type type string
          • set type int
          • sku type string
          • position type int
    4. catalogCategoryAttributeCurrentStore
      Description:
      Set/Get current store view
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryAttributeCurrentStoreRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryAttributeCurrentStoreRequestParam
      • sessionId type string
      • store - optional; type string
      Output:
      catalogCategoryAttributeCurrentStoreResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryAttributeCurrentStoreResponseParam
      • result type int
    5. catalogCategoryAttributeList
      Description:
      Retrieve category attributes
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryAttributeListRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryAttributeListRequestParam
      • sessionId type string
      Output:
      catalogCategoryAttributeListResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryAttributeListResponseParam
      • result type catalogAttributeEntityArray
        • complexObjectArray - optional, unbounded; type catalogAttributeEntity
          • attribute_id - optional; type int
          • code - optional; type string
          • type - optional; type string
          • required - optional; type string
          • scope - optional; type string
    6. catalogCategoryAttributeOptions
      Description:
      Retrieve attribute options
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryAttributeOptionsRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryAttributeOptionsRequestParam
      • sessionId type string
      • attributeId type string
      • store - optional; type string
      Output:
      catalogCategoryAttributeOptionsResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryAttributeOptionsResponseParam
      • result type catalogAttributeOptionEntityArray
        • complexObjectArray - optional, unbounded; type catalogAttributeOptionEntity
          • label type string
          • value type string
    7. catalogCategoryCreate
      Description:
      Create new category and return its id.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryCreateRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryCreateRequestParam
      • sessionId type string
      • parentId type int
      • categoryData type catalogCategoryEntityCreate
        • name - optional; type string
        • is_active - optional; type int
        • position - optional; type int
        • available_sort_by - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • custom_design - optional; type string
        • custom_design_apply - optional; type int
        • custom_design_from - optional; type string
        • custom_design_to - optional; type string
        • custom_layout_update - optional; type string
        • default_sort_by - optional; type string
        • description - optional; type string
        • display_mode - optional; type string
        • is_anchor - optional; type int
        • landing_page - optional; type int
        • meta_description - optional; type string
        • meta_keywords - optional; type string
        • meta_title - optional; type string
        • page_layout - optional; type string
        • url_key - optional; type string
        • include_in_menu - optional; type int
      • store - optional; type string
      Output:
      catalogCategoryCreateResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryCreateResponseParam
      • result type int
    8. catalogCategoryCurrentStore
      Description:
      Set_Get current store view
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryCurrentStoreRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryCurrentStoreRequestParam
      • sessionId type string
      • store - optional; type string
      Output:
      catalogCategoryCurrentStoreResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryCurrentStoreResponseParam
      • result type int
    9. catalogCategoryDelete
      Description:
      Delete category
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryDeleteRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryDeleteRequestParam
      • sessionId type string
      • categoryId type int
      Output:
      catalogCategoryDeleteResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryDeleteResponseParam
      • result type boolean
    10. catalogCategoryInfo
      Description:
      Retrieve hierarchical tree of categories.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryInfoRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryInfoRequestParam
      • sessionId type string
      • categoryId type int
      • store - optional; type string
      • attributes - optional; type ArrayOfString
        • complexObjectArray - optional, unbounded; type string
      Output:
      catalogCategoryInfoResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryInfoResponseParam
      • result type catalogCategoryInfo
        • category_id type string
        • is_active type int
        • position type string
        • level type string
        • parent_id type string
        • all_children type string
        • children type string
        • created_at - optional; type string
        • updated_at - optional; type string
        • name - optional; type string
        • url_key - optional; type string
        • description - optional; type string
        • meta_title - optional; type string
        • meta_keywords - optional; type string
        • meta_description - optional; type string
        • path - optional; type string
        • url_path - optional; type string
        • children_count - optional; type int
        • display_mode - optional; type string
        • is_anchor - optional; type int
        • available_sort_by - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • custom_design - optional; type string
        • custom_design_apply - optional; type string
        • custom_design_from - optional; type string
        • custom_design_to - optional; type string
        • page_layout - optional; type string
        • custom_layout_update - optional; type string
        • default_sort_by - optional; type string
        • landing_page - optional; type int
        • include_in_menu - optional; type int
        • custom_use_parent_settings - optional; type int
        • custom_apply_to_products - optional; type int
        • filter_price_range - optional; type string
    11. catalogCategoryLevel
      Description:
      Retrieve hierarchical tree of categories.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryLevelRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryLevelRequestParam
      • sessionId type string
      • website - optional; type string
      • store - optional; type string
      • categoryId - optional; type string
      Output:
      catalogCategoryLevelResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryLevelResponseParam
      • result type ArrayOfCatalogCategoryEntitiesNoChildren
        • complexObjectArray - optional, unbounded; type catalogCategoryEntityNoChildren
          • category_id type int
          • parent_id type int
          • name type string
          • is_active type int
          • position type int
          • level type int
    12. catalogCategoryMove
      Description:
      Move category in tree
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryMoveRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryMoveRequestParam
      • sessionId type string
      • categoryId type int
      • parentId type int
      • afterId type string
      Output:
      catalogCategoryMoveResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryMoveResponseParam
      • result type boolean
    13. catalogCategoryRemoveProduct
      Description:
      Remove product assignment from category
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryRemoveProductRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryRemoveProductRequestParam
      • sessionId type string
      • categoryId type int
      • productId type string
      • identifierType - optional; type string
      Output:
      catalogCategoryRemoveProductResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryRemoveProductResponseParam
      • result type boolean
    14. catalogCategoryTree
      Description:
      Retrieve hierarchical tree of categories.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryTreeRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryTreeRequestParam
      • sessionId type string
      • parentId type string
      • store - optional; type string
      Output:
      catalogCategoryTreeResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryTreeResponseParam
      • result type catalogCategoryTree
        • category_id type int
        • parent_id type int
        • name type string
        • position type int
        • level type int
        • children type ArrayOfCatalogCategoryEntities
          • complexObjectArray - optional, unbounded; type catalogCategoryEntity
            • category_id type int
            • parent_id type int
            • name type string
            • is_active type int
            • position type int
            • level type int
            • children type ArrayOfCatalogCategoryEntities
              • complexObjectArray - optional, unbounded; type catalogCategoryEntity
                • category_id type int
                • parent_id type int
                • name type string
                • is_active type int
                • position type int
                • level type int
                • children type ArrayOfCatalogCategoryEntities
                  • complexObjectArray - optional, unbounded; type catalogCategoryEntity
                    • category_id type int
                    • parent_id type int
                    • name type string
                    • is_active type int
                    • position type int
                    • level type int
                    • children type ArrayOfCatalogCategoryEntities... is recursive
    15. catalogCategoryUpdate
      Description:
      Update category
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryUpdateRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryUpdateRequestParam
      • sessionId type string
      • categoryId type int
      • categoryData type catalogCategoryEntityCreate
        • name - optional; type string
        • is_active - optional; type int
        • position - optional; type int
        • available_sort_by - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • custom_design - optional; type string
        • custom_design_apply - optional; type int
        • custom_design_from - optional; type string
        • custom_design_to - optional; type string
        • custom_layout_update - optional; type string
        • default_sort_by - optional; type string
        • description - optional; type string
        • display_mode - optional; type string
        • is_anchor - optional; type int
        • landing_page - optional; type int
        • meta_description - optional; type string
        • meta_keywords - optional; type string
        • meta_title - optional; type string
        • page_layout - optional; type string
        • url_key - optional; type string
        • include_in_menu - optional; type int
      • store - optional; type string
      Output:
      catalogCategoryUpdateResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryUpdateResponseParam
      • result type boolean
    16. catalogCategoryUpdateProduct
      Description:
      Update assigned product
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogCategoryUpdateProductRequest (soap:body, use = literal)Source code
      parameters type catalogCategoryUpdateProductRequestParam
      • sessionId type string
      • categoryId type int
      • productId type string
      • position - optional; type string
      • identifierType - optional; type string
      Output:
      catalogCategoryUpdateProductResponse (soap:body, use = literal)Source code
      parameters type catalogCategoryUpdateProductResponseParam
      • result type boolean
    17. catalogInventoryStockItemList
      Description:
      Retrieve stock data by product ids
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogInventoryStockItemListRequest (soap:body, use = literal)Source code
      parameters type catalogInventoryStockItemListRequestParam
      • sessionId type string
      • productIds type ArrayOfString
        • complexObjectArray - optional, unbounded; type string
      Output:
      catalogInventoryStockItemListResponse (soap:body, use = literal)Source code
      parameters type catalogInventoryStockItemListResponseParam
      • result type catalogInventoryStockItemEntityArray
        • complexObjectArray - optional, unbounded; type catalogInventoryStockItemEntity
          • product_id - optional; type string
          • sku - optional; type string
          • qty - optional; type string
          • is_in_stock - optional; type string
    18. catalogInventoryStockItemMultiUpdate
      Description:
      Multi update product stock data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogInventoryStockItemMultiUpdateRequest (soap:body, use = literal)Source code
      parameters type catalogInventoryStockItemMultiUpdateRequestParam
      • sessionId type string
      • productIds type ArrayOfString
        • complexObjectArray - optional, unbounded; type string
      • productData type catalogInventoryStockItemUpdateEntityArray
        • complexObjectArray - optional, unbounded; type catalogInventoryStockItemUpdateEntity
          • qty - optional; type string
          • is_in_stock - optional; type int
          • manage_stock - optional; type int
          • use_config_manage_stock - optional; type int
          • min_qty - optional; type int
          • use_config_min_qty - optional; type int
          • min_sale_qty - optional; type int
          • use_config_min_sale_qty - optional; type int
          • max_sale_qty - optional; type int
          • use_config_max_sale_qty - optional; type int
          • is_qty_decimal - optional; type int
          • backorders - optional; type int
          • use_config_backorders - optional; type int
          • notify_stock_qty - optional; type int
          • use_config_notify_stock_qty - optional; type int
      Output:
      catalogInventoryStockItemMultiUpdateResponse (soap:body, use = literal)Source code
      parameters type catalogInventoryStockItemMultiUpdateResponseParam
      • result type boolean
    19. catalogInventoryStockItemUpdate
      Description:
      Update product stock data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogInventoryStockItemUpdateRequest (soap:body, use = literal)Source code
      parameters type catalogInventoryStockItemUpdateRequestParam
      • sessionId type string
      • productId type string
      • data type catalogInventoryStockItemUpdateEntity
        • qty - optional; type string
        • is_in_stock - optional; type int
        • manage_stock - optional; type int
        • use_config_manage_stock - optional; type int
        • min_qty - optional; type int
        • use_config_min_qty - optional; type int
        • min_sale_qty - optional; type int
        • use_config_min_sale_qty - optional; type int
        • max_sale_qty - optional; type int
        • use_config_max_sale_qty - optional; type int
        • is_qty_decimal - optional; type int
        • backorders - optional; type int
        • use_config_backorders - optional; type int
        • notify_stock_qty - optional; type int
        • use_config_notify_stock_qty - optional; type int
      Output:
      catalogInventoryStockItemUpdateResponse (soap:body, use = literal)Source code
      parameters type catalogInventoryStockItemUpdateResponseParam
      • result type int
    20. catalogProductAttributeAddOption
      Description:
      Add option to attribute
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeAddOptionRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeAddOptionRequestParam
      • sessionId type string
      • attribute type string
      • data type catalogProductAttributeOptionEntityToAdd
        • label type catalogProductAttributeOptionLabelArray
          • complexObjectArray - unbounded; type catalogProductAttributeOptionLabelEntity
            • store_id type ArrayOfString
              • complexObjectArray - optional, unbounded; type string
            • value type string
        • order type int
        • is_default type int
      Output:
      catalogProductAttributeAddOptionResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeAddOptionResponseParam
      • result type boolean
    21. catalogProductAttributeCreate
      Description:
      Create new attribute
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeCreateRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeCreateRequestParam
      • sessionId type string
      • data type catalogProductAttributeEntityToCreate
        • attribute_code type string
        • frontend_input type string
        • scope - optional; type string
        • default_value - optional; type string
        • is_unique - optional; type int
        • is_required - optional; type int
        • apply_to - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • is_configurable - optional; type int
        • is_searchable - optional; type int
        • is_visible_in_advanced_search - optional; type int
        • is_comparable - optional; type int
        • is_used_for_promo_rules - optional; type int
        • is_visible_on_front - optional; type int
        • used_in_product_listing - optional; type int
        • additional_fields - optional; type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
        • frontend_label - optional; type catalogProductAttributeFrontendLabelArray
          • complexObjectArray - optional, unbounded; type catalogProductAttributeFrontendLabelEntity
            • store_id type string
            • label type string
      Output:
      catalogProductAttributeCreateResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeCreateResponseParam
      • result type string
    22. catalogProductAttributeCurrentStore
      Description:
      Set/Get current store view
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeCurrentStoreRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeCurrentStoreRequestParam
      • sessionId type string
      • store - optional; type string
      Output:
      catalogProductAttributeCurrentStoreResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeCurrentStoreResponseParam
      • result type int
    23. catalogProductAttributeInfo
      Description:
      Get full information about attribute with list of options
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeInfoRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeInfoRequestParam
      • sessionId type string
      • attribute type string
      Output:
      catalogProductAttributeInfoResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeInfoResponseParam
      • result type catalogProductAttributeEntity
        • attribute_id type string
        • attribute_code type string
        • frontend_input type string
        • scope - optional; type string
        • default_value - optional; type string
        • is_unique - optional; type int
        • is_required - optional; type int
        • apply_to - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • is_configurable - optional; type int
        • is_searchable - optional; type int
        • is_visible_in_advanced_search - optional; type int
        • is_comparable - optional; type int
        • is_used_for_promo_rules - optional; type int
        • is_visible_on_front - optional; type int
        • used_in_product_listing - optional; type int
        • additional_fields - optional; type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
        • options - optional; type catalogAttributeOptionEntityArray
          • complexObjectArray - optional, unbounded; type catalogAttributeOptionEntity
            • label type string
            • value type string
        • frontend_label type catalogProductAttributeFrontendLabelArray
          • complexObjectArray - optional, unbounded; type catalogProductAttributeFrontendLabelEntity
            • store_id type string
            • label type string
    24. catalogProductAttributeList
      Description:
      Retrieve attribute list
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeListRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeListRequestParam
      • sessionId type string
      • setId type int
      Output:
      catalogProductAttributeListResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeListResponseParam
      • result type catalogAttributeEntityArray
        • complexObjectArray - optional, unbounded; type catalogAttributeEntity
          • attribute_id - optional; type int
          • code - optional; type string
          • type - optional; type string
          • required - optional; type string
          • scope - optional; type string
    25. catalogProductAttributeMediaCreate
      Description:
      Upload new product image
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeMediaCreateRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaCreateRequestParam
      • sessionId type string
      • productId type string
      • data type catalogProductAttributeMediaCreateEntity
        • file - optional; type catalogProductImageFileEntity
          • content type string
          • mime type string
          • name - optional; type string
        • label - optional; type string
        • position - optional; type string
        • types - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • exclude - optional; type string
        • remove - optional; type string
      • store - optional; type string
      • identifierType - optional; type string
      Output:
      catalogProductAttributeMediaCreateResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaCreateResponseParam
      • result type string
    26. catalogProductAttributeMediaCurrentStore
      Description:
      Set/Get current store view
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeMediaCurrentStoreRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaCurrentStoreRequestParam
      • sessionId type string
      • store - optional; type string
      Output:
      catalogProductAttributeMediaCurrentStoreResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaCurrentStoreResponseParam
      • result type int
    27. catalogProductAttributeMediaInfo
      Description:
      Retrieve product image data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeMediaInfoRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaInfoRequestParam
      • sessionId type string
      • productId type string
      • file type string
      • store - optional; type string
      • identifierType - optional; type string
      Output:
      catalogProductAttributeMediaInfoResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaInfoResponseParam
      • result type catalogProductImageEntity
        • file type string
        • label type string
        • position type string
        • exclude type string
        • url type string
        • types type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
    28. catalogProductAttributeMediaList
      Description:
      Retrieve product image list
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeMediaListRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaListRequestParam
      • sessionId type string
      • productId type string
      • store - optional; type string
      • identifierType - optional; type string
      Output:
      catalogProductAttributeMediaListResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaListResponseParam
      • result type catalogProductImageEntityArray
        • complexObjectArray - optional, unbounded; type catalogProductImageEntity
          • file type string
          • label type string
          • position type string
          • exclude type string
          • url type string
          • types type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
    29. catalogProductAttributeMediaRemove
      Description:
      Remove product image
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeMediaRemoveRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaRemoveRequestParam
      • sessionId type string
      • productId type string
      • file type string
      • identifierType - optional; type string
      Output:
      catalogProductAttributeMediaRemoveResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaRemoveResponseParam
      • result type int
    30. catalogProductAttributeMediaTypes
      Description:
      Retrieve product image types
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeMediaTypesRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaTypesRequestParam
      • sessionId type string
      • setId type string
      Output:
      catalogProductAttributeMediaTypesResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaTypesResponseParam
      • result type catalogProductAttributeMediaTypeEntityArray
        • complexObjectArray - optional, unbounded; type catalogProductAttributeMediaTypeEntity
          • code type string
          • scope type string
    31. catalogProductAttributeMediaUpdate
      Description:
      Update product image
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeMediaUpdateRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaUpdateRequestParam
      • sessionId type string
      • productId type string
      • file type string
      • data type catalogProductAttributeMediaCreateEntity
        • file - optional; type catalogProductImageFileEntity
          • content type string
          • mime type string
          • name - optional; type string
        • label - optional; type string
        • position - optional; type string
        • types - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • exclude - optional; type string
        • remove - optional; type string
      • store - optional; type string
      • identifierType - optional; type string
      Output:
      catalogProductAttributeMediaUpdateResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeMediaUpdateResponseParam
      • result type int
    32. catalogProductAttributeOptions
      Description:
      Retrieve attribute options
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeOptionsRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeOptionsRequestParam
      • sessionId type string
      • attributeId type int
      • store - optional; type string
      Output:
      catalogProductAttributeOptionsResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeOptionsResponseParam
      • result type catalogAttributeOptionEntityArray
        • complexObjectArray - optional, unbounded; type catalogAttributeOptionEntity
          • label type string
          • value type string
    33. catalogProductAttributeRemove
      Description:
      Delete attribute
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeRemoveRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeRemoveRequestParam
      • sessionId type string
      • attribute type string
      Output:
      catalogProductAttributeRemoveResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeRemoveResponseParam
      • result type boolean
    34. catalogProductAttributeSetAttributeAdd
      Description:
      Add attribute into attribute set
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeSetAttributeAddRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetAttributeAddRequestParam
      • sessionId type string
      • attributeId type string
      • attributeSetId type string
      • attributeGroupId - optional; type string
      • sortOrder - optional; type string
      Output:
      catalogProductAttributeSetAttributeAddResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetAttributeAddResponseParam
      • result type int
    35. catalogProductAttributeSetAttributeRemove
      Description:
      Remove attribute from attribute set
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeSetAttributeRemoveRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetAttributeRemoveRequestParam
      • sessionId type string
      • attributeId type string
      • attributeSetId type string
      Output:
      catalogProductAttributeSetAttributeRemoveResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetAttributeRemoveResponseParam
      • result type int
    36. catalogProductAttributeSetCreate
      Description:
      Create product attribute set based on another set
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeSetCreateRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetCreateRequestParam
      • sessionId type string
      • attributeSetName type string
      • skeletonSetId type string
      Output:
      catalogProductAttributeSetCreateResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetCreateResponseParam
      • result type string
    37. catalogProductAttributeSetGroupAdd
      Description:
      Create group within existing attribute set
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeSetGroupAddRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetGroupAddRequestParam
      • sessionId type string
      • attributeSetId type string
      • groupName type string
      Output:
      catalogProductAttributeSetGroupAddResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetGroupAddResponseParam
      • result type string
    38. catalogProductAttributeSetGroupRemove
      Description:
      Remove group from attribute set
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeSetGroupRemoveRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetGroupRemoveRequestParam
      • sessionId type string
      • attributeGroupId type string
      Output:
      catalogProductAttributeSetGroupRemoveResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetGroupRemoveResponseParam
      • result type int
    39. catalogProductAttributeSetGroupRename
      Description:
      Rename existing group
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeSetGroupRenameRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetGroupRenameRequestParam
      • sessionId type string
      • groupId type string
      • groupName type string
      Output:
      catalogProductAttributeSetGroupRenameResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetGroupRenameResponseParam
      • result type int
    40. catalogProductAttributeSetList
      Description:
      Retrieve product attribute sets
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeSetListRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetListRequestParam
      • sessionId type string
      Output:
      catalogProductAttributeSetListResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetListResponseParam
      • result type catalogProductAttributeSetEntityArray
        • complexObjectArray - optional, unbounded; type catalogProductAttributeSetEntity
          • set_id - optional; type int
          • name - optional; type string
    41. catalogProductAttributeSetRemove
      Description:
      Remove product attribute set
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeSetRemoveRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetRemoveRequestParam
      • sessionId type string
      • attributeSetId type string
      • forceProductsRemove - optional; type string
      Output:
      catalogProductAttributeSetRemoveResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeSetRemoveResponseParam
      • result type int
    42. catalogProductAttributeTierPriceInfo
      Description:
      Retrieve product tier prices
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeTierPriceInfoRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeTierPriceInfoRequestParam
      • sessionId type string
      • productId type string
      • identifierType - optional; type string
      Output:
      catalogProductAttributeTierPriceInfoResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeTierPriceInfoResponseParam
      • result type catalogProductTierPriceEntityArray
        • complexObjectArray - optional, unbounded; type catalogProductTierPriceEntity
          • customer_group_id - optional; type string
          • website - optional; type string
          • qty - optional; type int
          • price - optional; type double
    43. catalogProductAttributeTierPriceUpdate
      Description:
      Update product tier prices
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeTierPriceUpdateRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeTierPriceUpdateRequestParam
      • sessionId type string
      • productId type string
      • tierPrices type catalogProductTierPriceEntityArray
        • complexObjectArray - optional, unbounded; type catalogProductTierPriceEntity
          • customer_group_id - optional; type string
          • website - optional; type string
          • qty - optional; type int
          • price - optional; type double
      • identifierType - optional; type string
      Output:
      catalogProductAttributeTierPriceUpdateResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeTierPriceUpdateResponseParam
      • result type int
    44. catalogProductAttributeUpdate
      Description:
      Update attribute
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductAttributeUpdateRequest (soap:body, use = literal)Source code
      parameters type catalogProductAttributeUpdateRequestParam
      • sessionId type string
      • attribute type string
      • data type catalogProductAttributeEntityToUpdate
        • scope - optional; type string
        • default_value - optional; type string
        • is_unique - optional; type int
        • is_required - optional; type int
        • apply_to - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • is_configurable - optional; type int
        • is_searchable - optional; type int
        • is_visible_in_advanced_search - optional; type int
        • is_comparable - optional; type int
        • is_used_for_promo_rules - optional; type int
        • is_visible_on_front - optional; type int
        • used_in_product_listing - optional; type int
        • additional_fields - optional; type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
        • frontend_label type catalogProductAttributeFrontendLabelArray
          • complexObjectArray - optional, unbounded; type catalogProductAttributeFrontendLabelEntity
            • store_id type string
            • label type string
      Output:
      catalogProductAttributeUpdateResponse (soap:body, use = literal)Source code
      parameters type catalogProductAttributeUpdateResponseParam
      • result type boolean
    45. catalogProductCreate
      Description:
      Create new product and return product id
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCreateRequest (soap:body, use = literal)Source code
      parameters type catalogProductCreateRequestParam
      • sessionId type string
      • type type string
      • set type string
      • sku type string
      • productData type catalogProductCreateEntity
        • categories - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • websites - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • name - optional; type string
        • description - optional; type string
        • short_description - optional; type string
        • weight - optional; type string
        • status - optional; type string
        • url_key - optional; type string
        • url_path - optional; type string
        • visibility - optional; type string
        • category_ids - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • website_ids - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • has_options - optional; type string
        • gift_message_available - optional; type string
        • price - optional; type string
        • special_price - optional; type string
        • special_from_date - optional; type string
        • special_to_date - optional; type string
        • tax_class_id - optional; type string
        • tier_price - optional; type catalogProductTierPriceEntityArray
          • complexObjectArray - optional, unbounded; type catalogProductTierPriceEntity
            • customer_group_id - optional; type string
            • website - optional; type string
            • qty - optional; type int
            • price - optional; type double
        • meta_title - optional; type string
        • meta_keyword - optional; type string
        • meta_description - optional; type string
        • custom_design - optional; type string
        • custom_layout_update - optional; type string
        • options_container - optional; type string
        • additional_attributes - optional; type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
        • stock_data - optional; type catalogInventoryStockItemUpdateEntity
          • qty - optional; type string
          • is_in_stock - optional; type int
          • manage_stock - optional; type int
          • use_config_manage_stock - optional; type int
          • min_qty - optional; type int
          • use_config_min_qty - optional; type int
          • min_sale_qty - optional; type int
          • use_config_min_sale_qty - optional; type int
          • max_sale_qty - optional; type int
          • use_config_max_sale_qty - optional; type int
          • is_qty_decimal - optional; type int
          • backorders - optional; type int
          • use_config_backorders - optional; type int
          • notify_stock_qty - optional; type int
          • use_config_notify_stock_qty - optional; type int
      • store - optional; type string
      Output:
      catalogProductCreateResponse (soap:body, use = literal)Source code
      parameters type catalogProductCreateResponseParam
      • result type int
    46. catalogProductCurrentStore
      Description:
      Set/Get current store view
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCurrentStoreRequest (soap:body, use = literal)Source code
      parameters type catalogProductCurrentStoreRequestParam
      • sessionId type string
      • store - optional; type string
      Output:
      catalogProductCurrentStoreResponse (soap:body, use = literal)Source code
      parameters type catalogProductCurrentStoreResponseParam
      • result type int
    47. catalogProductCustomOptionAdd
      Description:
      Add new custom option into product
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCustomOptionAddRequest (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionAddRequestParam
      • sessionId type string
      • productId type string
      • data type catalogProductCustomOptionToAdd
        • title type string
        • type type string
        • sort_order - optional; type string
        • is_require - optional; type int
        • additional_fields type catalogProductCustomOptionAdditionalFieldsArray
          • complexObjectArray - unbounded; type catalogProductCustomOptionAdditionalFieldsEntity
            • title - optional; type string
            • price - optional; type string
            • price_type - optional; type string
            • sku - optional; type string
            • max_characters - optional; type string
            • sort_order - optional; type string
            • file_extension - optional; type string
            • image_size_x - optional; type string
            • image_size_y - optional; type string
            • value_id - optional; type string
      • store - optional; type string
      Output:
      catalogProductCustomOptionAddResponse (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionAddResponseParam
      • result type int
    48. catalogProductCustomOptionInfo
      Description:
      Get full information about custom option in product
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCustomOptionInfoRequest (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionInfoRequestParam
      • sessionId type string
      • optionId type string
      • store - optional; type string
      Output:
      catalogProductCustomOptionInfoResponse (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionInfoResponseParam
      • result type catalogProductCustomOptionInfoEntity
        • title type string
        • type type string
        • sort_order type string
        • is_require type int
        • additional_fields type catalogProductCustomOptionAdditionalFieldsArray
          • complexObjectArray - unbounded; type catalogProductCustomOptionAdditionalFieldsEntity
            • title - optional; type string
            • price - optional; type string
            • price_type - optional; type string
            • sku - optional; type string
            • max_characters - optional; type string
            • sort_order - optional; type string
            • file_extension - optional; type string
            • image_size_x - optional; type string
            • image_size_y - optional; type string
            • value_id - optional; type string
    49. catalogProductCustomOptionList
      Description:
      Retrieve list of product custom options
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCustomOptionListRequest (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionListRequestParam
      • sessionId type string
      • productId type string
      • store - optional; type string
      Output:
      catalogProductCustomOptionListResponse (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionListResponseParam
      • result type catalogProductCustomOptionListArray
        • complexObjectArray - optional, unbounded; type catalogProductCustomOptionListEntity
          • option_id type string
          • title type string
          • type type string
          • sort_order type string
          • is_require type int
    50. catalogProductCustomOptionRemove
      Description:
      Remove custom option
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCustomOptionRemoveRequest (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionRemoveRequestParam
      • sessionId type string
      • optionId type string
      Output:
      catalogProductCustomOptionRemoveResponse (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionRemoveResponseParam
      • result type int
    51. catalogProductCustomOptionTypes
      Description:
      Get list of available custom option types
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCustomOptionTypesRequest (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionTypesRequestParam
      • sessionId type string
      Output:
      catalogProductCustomOptionTypesResponse (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionTypesResponseParam
      • result type catalogProductCustomOptionTypesArray
        • complexObjectArray - optional, unbounded; type catalogProductCustomOptionTypesEntity
          • label type string
          • value type string
    52. catalogProductCustomOptionUpdate
      Description:
      Update product custom option
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCustomOptionUpdateRequest (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionUpdateRequestParam
      • sessionId type string
      • optionId type string
      • data type catalogProductCustomOptionToUpdate
        • title - optional; type string
        • type - optional; type string
        • sort_order - optional; type string
        • is_require - optional; type int
        • additional_fields - optional; type catalogProductCustomOptionAdditionalFieldsArray
          • complexObjectArray - unbounded; type catalogProductCustomOptionAdditionalFieldsEntity
            • title - optional; type string
            • price - optional; type string
            • price_type - optional; type string
            • sku - optional; type string
            • max_characters - optional; type string
            • sort_order - optional; type string
            • file_extension - optional; type string
            • image_size_x - optional; type string
            • image_size_y - optional; type string
            • value_id - optional; type string
      • store - optional; type string
      Output:
      catalogProductCustomOptionUpdateResponse (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionUpdateResponseParam
      • result type int
    53. catalogProductCustomOptionValueAdd
      Description:
      Add new custom option values
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCustomOptionValueAddRequest (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionValueAddRequestParam
      • sessionId type string
      • optionId type string
      • data type catalogProductCustomOptionValueAddArray
        • complexObjectArray - unbounded; type catalogProductCustomOptionValueAddEntity
          • title type string
          • price type string
          • price_type type string
          • sku type string
          • sort_order - optional; type string
      • store - optional; type string
      Output:
      catalogProductCustomOptionValueAddResponse (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionValueAddResponseParam
      • result type int
    54. catalogProductCustomOptionValueInfo
      Description:
      Retrieve custom option value info
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCustomOptionValueInfoRequest (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionValueInfoRequestParam
      • sessionId type string
      • valueId type string
      • store - optional; type string
      Output:
      catalogProductCustomOptionValueInfoResponse (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionValueInfoResponseParam
      • result type catalogProductCustomOptionValueInfoEntity
        • value_id type string
        • option_id type string
        • sku type string
        • sort_order type string
        • default_price type string
        • default_price_type type string
        • store_price type string
        • store_price_type type string
        • price type string
        • price_type type string
        • default_title type string
        • store_title type string
        • title type string
    55. catalogProductCustomOptionValueList
      Description:
      Retrieve custom option values list
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCustomOptionValueListRequest (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionValueListRequestParam
      • sessionId type string
      • optionId type string
      • store - optional; type string
      Output:
      catalogProductCustomOptionValueListResponse (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionValueListResponseParam
      • result type catalogProductCustomOptionValueListArray
        • complexObjectArray - optional, unbounded; type catalogProductCustomOptionValueListEntity
          • value_id type string
          • title type string
          • price type string
          • price_type type string
          • sku type string
          • sort_order type string
    56. catalogProductCustomOptionValueRemove
      Description:
      Remove value from custom option
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCustomOptionValueRemoveRequest (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionValueRemoveRequestParam
      • sessionId type string
      • valueId type string
      Output:
      catalogProductCustomOptionValueRemoveResponse (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionValueRemoveResponseParam
      • result type int
    57. catalogProductCustomOptionValueUpdate
      Description:
      Update custom option value
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductCustomOptionValueUpdateRequest (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionValueUpdateRequestParam
      • sessionId type string
      • valueId type string
      • data type catalogProductCustomOptionValueUpdateEntity
        • title type string
        • price type string
        • price_type type string
        • sku type string
        • sort_order - optional; type string
      • store - optional; type string
      Output:
      catalogProductCustomOptionValueUpdateResponse (soap:body, use = literal)Source code
      parameters type catalogProductCustomOptionValueUpdateResponseParam
      • result type int
    58. catalogProductDelete
      Description:
      Delete product
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductDeleteRequest (soap:body, use = literal)Source code
      parameters type catalogProductDeleteRequestParam
      • sessionId type string
      • productId type string
      • identifierType - optional; type string
      Output:
      catalogProductDeleteResponse (soap:body, use = literal)Source code
      parameters type catalogProductDeleteResponseParam
      • result type int
    59. catalogProductDownloadableLinkAdd
      Description:
      Add links to downloadable product
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductDownloadableLinkAddRequest (soap:body, use = literal)Source code
      parameters type catalogProductDownloadableLinkAddRequestParam
      • sessionId type string
      • productId type string
      • resource type catalogProductDownloadableLinkAddEntity
        • title type string
        • price - optional; type string
        • is_unlimited - optional; type int
        • number_of_downloads - optional; type int
        • is_shareable - optional; type int
        • sample - optional; type catalogProductDownloadableLinkAddSampleEntity
          • type - optional; type string
          • file - optional; type catalogProductDownloadableLinkFileEntity
            • name - optional; type string
            • base64_content - optional; type string
          • url - optional; type string
        • type - optional; type string
        • file - optional; type catalogProductDownloadableLinkFileEntity
          • name - optional; type string
          • base64_content - optional; type string
        • link_url - optional; type string
        • sample_url - optional; type string
        • sort_order - optional; type int
      • resourceType type string
      • store - optional; type string
      • identifierType - optional; type string
      Output:
      catalogProductDownloadableLinkAddResponse (soap:body, use = literal)Source code
      parameters type catalogProductDownloadableLinkAddResponseParam
      • result type int
    60. catalogProductDownloadableLinkList
      Description:
      Retrieve list of links and samples for downloadable product
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductDownloadableLinkListRequest (soap:body, use = literal)Source code
      parameters type catalogProductDownloadableLinkListRequestParam
      • sessionId type string
      • productId type string
      • store - optional; type string
      • identifierType - optional; type string
      Output:
      catalogProductDownloadableLinkListResponse (soap:body, use = literal)Source code
      parameters type catalogProductDownloadableLinkListResponseParam
      • result type catalogProductDownloadableLinkListEntity
        • links type catalogProductDownloadableLinkEntityArray
          • complexObjectArray - optional, unbounded; type catalogProductDownloadableLinkEntity
            • link_id type string
            • title type string
            • price type string
            • number_of_downloads - optional; type int
            • is_unlimited - optional; type int
            • is_shareable type int
            • link_url type string
            • link_type type string
            • sample_file - optional; type string
            • sample_url - optional; type string
            • sample_type type string
            • sort_order type int
            • file_save - optional; type catalogProductDownloadableLinkFileInfoEntityArray
              • complexObjectArray - optional, unbounded; type catalogProductDownloadableLinkFileInfoEntity
                • file type string
                • name type string
                • size type int
                • status type string
            • sample_file_save - optional; type catalogProductDownloadableLinkFileInfoEntityArray
              • complexObjectArray - optional, unbounded; type catalogProductDownloadableLinkFileInfoEntity
                • file type string
                • name type string
                • size type int
                • status type string
        • samples type catalogProductDownloadableLinkSampleEntityArray
          • complexObjectArray - optional, unbounded; type catalogProductDownloadableLinkSampleEntity
            • sample_id type string
            • product_id type string
            • sample_file - optional; type string
            • sample_url - optional; type string
            • sample_type type string
            • sort_order type string
            • default_title type string
            • store_title type string
            • title type string
    61. catalogProductDownloadableLinkRemove
      Description:
      Remove links and samples from downloadable product
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductDownloadableLinkRemoveRequest (soap:body, use = literal)Source code
      parameters type catalogProductDownloadableLinkRemoveRequestParam
      • sessionId type string
      • linkId type string
      • resourceType type string
      Output:
      catalogProductDownloadableLinkRemoveResponse (soap:body, use = literal)Source code
      parameters type catalogProductDownloadableLinkRemoveResponseParam
      • result type int
    62. catalogProductGetSpecialPrice
      Description:
      Get product special price data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductGetSpecialPriceRequest (soap:body, use = literal)Source code
      parameters type catalogProductGetSpecialPriceRequestParam
      • sessionId type string
      • productId type string
      • store - optional; type string
      Output:
      catalogProductGetSpecialPriceResponse (soap:body, use = literal)Source code
      parameters type catalogProductGetSpecialPriceResponseParam
      • result type catalogProductSpecialPriceReturnEntity
        • special_price type string
        • special_from_date type string
        • special_to_date type string
    63. catalogProductInfo
      Description:
      Retrieve product
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductInfoRequest (soap:body, use = literal)Source code
      parameters type catalogProductInfoRequestParam
      • sessionId type string
      • productId type string
      • store - optional; type string
      • attributes - optional; type catalogProductRequestAttributes
        • attributes - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • additional_attributes - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
      • identifierType - optional; type string
      Output:
      catalogProductInfoResponse (soap:body, use = literal)Source code
      parameters type catalogProductInfoResponseParam
      • result type catalogProductReturnEntity
        • product_id - optional; type string
        • sku - optional; type string
        • set - optional; type string
        • type - optional; type string
        • categories - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • websites - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • created_at - optional; type string
        • updated_at - optional; type string
        • type_id - optional; type string
        • name - optional; type string
        • description - optional; type string
        • short_description - optional; type string
        • weight - optional; type string
        • status - optional; type string
        • url_key - optional; type string
        • url_path - optional; type string
        • visibility - optional; type string
        • category_ids - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • website_ids - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • has_options - optional; type string
        • gift_message_available - optional; type string
        • price - optional; type string
        • special_price - optional; type string
        • special_from_date - optional; type string
        • special_to_date - optional; type string
        • tax_class_id - optional; type string
        • tier_price - optional; type catalogProductTierPriceEntityArray
          • complexObjectArray - optional, unbounded; type catalogProductTierPriceEntity
            • customer_group_id - optional; type string
            • website - optional; type string
            • qty - optional; type int
            • price - optional; type double
        • meta_title - optional; type string
        • meta_keyword - optional; type string
        • meta_description - optional; type string
        • custom_design - optional; type string
        • custom_layout_update - optional; type string
        • options_container - optional; type string
        • additional_attributes - optional; type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
    64. catalogProductLinkAssign
      Description:
      Assign product link
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductLinkAssignRequest (soap:body, use = literal)Source code
      parameters type catalogProductLinkAssignRequestParam
      • sessionId type string
      • type type string
      • productId type string
      • linkedProductId type string
      • data - optional; type catalogProductLinkEntity
        • product_id - optional; type string
        • type - optional; type string
        • set - optional; type string
        • sku - optional; type string
        • position - optional; type string
        • qty - optional; type string
      • identifierType - optional; type string
      Output:
      catalogProductLinkAssignResponse (soap:body, use = literal)Source code
      parameters type catalogProductLinkAssignResponseParam
      • result type string
    65. catalogProductLinkAttributes
      Description:
      Retrieve product link type attributes
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductLinkAttributesRequest (soap:body, use = literal)Source code
      parameters type catalogProductLinkAttributesRequestParam
      • sessionId type string
      • type type string
      Output:
      catalogProductLinkAttributesResponse (soap:body, use = literal)Source code
      parameters type catalogProductLinkAttributesResponseParam
      • result type catalogProductLinkAttributeEntityArray
        • complexObjectArray - optional, unbounded; type catalogProductLinkAttributeEntity
          • code - optional; type string
          • type - optional; type string
    66. catalogProductLinkList
      Description:
      Retrieve linked products
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductLinkListRequest (soap:body, use = literal)Source code
      parameters type catalogProductLinkListRequestParam
      • sessionId type string
      • type type string
      • productId type string
      • identifierType - optional; type string
      Output:
      catalogProductLinkListResponse (soap:body, use = literal)Source code
      parameters type catalogProductLinkListResponseParam
      • result type catalogProductLinkEntityArray
        • complexObjectArray - optional, unbounded; type catalogProductLinkEntity
          • product_id - optional; type string
          • type - optional; type string
          • set - optional; type string
          • sku - optional; type string
          • position - optional; type string
          • qty - optional; type string
    67. catalogProductLinkRemove
      Description:
      Remove product link
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductLinkRemoveRequest (soap:body, use = literal)Source code
      parameters type catalogProductLinkRemoveRequestParam
      • sessionId type string
      • type type string
      • productId type string
      • linkedProductId type string
      • identifierType - optional; type string
      Output:
      catalogProductLinkRemoveResponse (soap:body, use = literal)Source code
      parameters type catalogProductLinkRemoveResponseParam
      • result type string
    68. catalogProductLinkTypes
      Description:
      Retrieve product link types
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductLinkTypesRequest (soap:body, use = literal)Source code
      parameters type catalogProductLinkTypesRequestParam
      • sessionId type string
      Output:
      catalogProductLinkTypesResponse (soap:body, use = literal)Source code
      parameters type catalogProductLinkTypesResponseParam
      • result type ArrayOfString
        • complexObjectArray - optional, unbounded; type string
    69. catalogProductLinkUpdate
      Description:
      Update product link
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductLinkUpdateRequest (soap:body, use = literal)Source code
      parameters type catalogProductLinkUpdateRequestParam
      • sessionId type string
      • type type string
      • productId type string
      • linkedProductId type string
      • data - optional; type catalogProductLinkEntity
        • product_id - optional; type string
        • type - optional; type string
        • set - optional; type string
        • sku - optional; type string
        • position - optional; type string
        • qty - optional; type string
      • identifierType - optional; type string
      Output:
      catalogProductLinkUpdateResponse (soap:body, use = literal)Source code
      parameters type catalogProductLinkUpdateResponseParam
      • result type string
    70. catalogProductList
      Description:
      Retrieve products list by filters
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductListRequest (soap:body, use = literal)Source code
      parameters type catalogProductListRequestParam
      • sessionId type string
      • filters type filters
        • filter - optional; type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
        • complex_filter - optional; type complexFilterArray
          • complexObjectArray - optional, unbounded; type complexFilter
            • key type string
            • value type associativeEntity
              • key type string
              • value type string
      • store - optional; type string
      Output:
      catalogProductListResponse (soap:body, use = literal)Source code
      parameters type catalogProductListResponseParam
      • result type catalogProductEntityArray
        • complexObjectArray - optional, unbounded; type catalogProductEntity
          • product_id type string
          • sku type string
          • name type string
          • set type string
          • type type string
          • category_ids type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
          • website_ids type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
    71. catalogProductMultiUpdate
      Description:
      Product multi update
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductMultiUpdateRequest (soap:body, use = literal)Source code
      parameters type catalogProductMultiUpdateRequestParam
      • sessionId type string
      • productIds type ArrayOfString
        • complexObjectArray - optional, unbounded; type string
      • productData type catalogProductCreateEntityArray
        • complexObjectArray - optional, unbounded; type catalogProductCreateEntity
          • categories - optional; type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
          • websites - optional; type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
          • name - optional; type string
          • description - optional; type string
          • short_description - optional; type string
          • weight - optional; type string
          • status - optional; type string
          • url_key - optional; type string
          • url_path - optional; type string
          • visibility - optional; type string
          • category_ids - optional; type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
          • website_ids - optional; type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
          • has_options - optional; type string
          • gift_message_available - optional; type string
          • price - optional; type string
          • special_price - optional; type string
          • special_from_date - optional; type string
          • special_to_date - optional; type string
          • tax_class_id - optional; type string
          • tier_price - optional; type catalogProductTierPriceEntityArray
            • complexObjectArray - optional, unbounded; type catalogProductTierPriceEntity
              • customer_group_id - optional; type string
              • website - optional; type string
              • qty - optional; type int
              • price - optional; type double
          • meta_title - optional; type string
          • meta_keyword - optional; type string
          • meta_description - optional; type string
          • custom_design - optional; type string
          • custom_layout_update - optional; type string
          • options_container - optional; type string
          • additional_attributes - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • stock_data - optional; type catalogInventoryStockItemUpdateEntity
            • qty - optional; type string
            • is_in_stock - optional; type int
            • manage_stock - optional; type int
            • use_config_manage_stock - optional; type int
            • min_qty - optional; type int
            • use_config_min_qty - optional; type int
            • min_sale_qty - optional; type int
            • use_config_min_sale_qty - optional; type int
            • max_sale_qty - optional; type int
            • use_config_max_sale_qty - optional; type int
            • is_qty_decimal - optional; type int
            • backorders - optional; type int
            • use_config_backorders - optional; type int
            • notify_stock_qty - optional; type int
            • use_config_notify_stock_qty - optional; type int
      • store - optional; type string
      • identifierType - optional; type string
      Output:
      catalogProductMultiUpdateResponse (soap:body, use = literal)Source code
      parameters type catalogProductMultiUpdateResponseParam
      • result type boolean
    72. catalogProductSetSpecialPrice
      Description:
      Update product special price
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductSetSpecialPriceRequest (soap:body, use = literal)Source code
      parameters type catalogProductSetSpecialPriceRequestParam
      • sessionId type string
      • productId type string
      • specialPrice - optional; type string
      • fromDate - optional; type string
      • toDate - optional; type string
      • store - optional; type string
      Output:
      catalogProductSetSpecialPriceResponse (soap:body, use = literal)Source code
      parameters type catalogProductSetSpecialPriceResponseParam
      • result type int
    73. catalogProductTagAdd
      Description:
      Add tag(s) to product
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductTagAddRequest (soap:body, use = literal)Source code
      parameters type catalogProductTagAddRequestParam
      • sessionId type string
      • data type catalogProductTagAddEntity
        • tag type string
        • product_id type string
        • customer_id type string
        • store type string
      Output:
      catalogProductTagAddResponse (soap:body, use = literal)Source code
      parameters type catalogProductTagAddResponseParam
      • result type associativeArray
        • complexObjectArray - optional, unbounded; type associativeEntity
          • key type string
          • value type string
    74. catalogProductTagInfo
      Description:
      Retrieve product tag info
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductTagInfoRequest (soap:body, use = literal)Source code
      parameters type catalogProductTagInfoRequestParam
      • sessionId type string
      • tagId type string
      • store type string
      Output:
      catalogProductTagInfoResponse (soap:body, use = literal)Source code
      parameters type catalogProductTagInfoResponseParam
      • result type catalogProductTagInfoEntity
        • name type string
        • status type string
        • base_popularity type string
        • products type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
    75. catalogProductTagList
      Description:
      Retrieve list of tags by product
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductTagListRequest (soap:body, use = literal)Source code
      parameters type catalogProductTagListRequestParam
      • sessionId type string
      • productId type string
      • store type string
      Output:
      catalogProductTagListResponse (soap:body, use = literal)Source code
      parameters type catalogProductTagListResponseParam
      • result type catalogProductTagListEntityArray
        • complexObjectArray - optional, unbounded; type catalogProductTagListEntity
          • tag_id type string
          • name type string
    76. catalogProductTagRemove
      Description:
      Remove product tag
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductTagRemoveRequest (soap:body, use = literal)Source code
      parameters type catalogProductTagRemoveRequestParam
      • sessionId type string
      • tagId type string
      Output:
      catalogProductTagRemoveResponse (soap:body, use = literal)Source code
      parameters type catalogProductTagRemoveResponseParam
      • result type int
    77. catalogProductTagUpdate
      Description:
      Update product tag
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductTagUpdateRequest (soap:body, use = literal)Source code
      parameters type catalogProductTagUpdateRequestParam
      • sessionId type string
      • tagId type string
      • data type catalogProductTagUpdateEntity
        • name - optional; type string
        • status - optional; type string
        • base_popularity - optional; type string
      • store type string
      Output:
      catalogProductTagUpdateResponse (soap:body, use = literal)Source code
      parameters type catalogProductTagUpdateResponseParam
      • result type int
    78. catalogProductTypeList
      Description:
      Retrieve product types
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductTypeListRequest (soap:body, use = literal)Source code
      parameters type catalogProductTypeListRequestParam
      • sessionId type string
      Output:
      catalogProductTypeListResponse (soap:body, use = literal)Source code
      parameters type catalogProductTypeListResponseParam
      • result type catalogProductTypeEntityArray
        • complexObjectArray - optional, unbounded; type catalogProductTypeEntity
          • type - optional; type string
          • label - optional; type string
    79. catalogProductUpdate
      Description:
      Update product
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      catalogProductUpdateRequest (soap:body, use = literal)Source code
      parameters type catalogProductUpdateRequestParam
      • sessionId type string
      • productId type string
      • productData type catalogProductCreateEntity
        • categories - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • websites - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • name - optional; type string
        • description - optional; type string
        • short_description - optional; type string
        • weight - optional; type string
        • status - optional; type string
        • url_key - optional; type string
        • url_path - optional; type string
        • visibility - optional; type string
        • category_ids - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • website_ids - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • has_options - optional; type string
        • gift_message_available - optional; type string
        • price - optional; type string
        • special_price - optional; type string
        • special_from_date - optional; type string
        • special_to_date - optional; type string
        • tax_class_id - optional; type string
        • tier_price - optional; type catalogProductTierPriceEntityArray
          • complexObjectArray - optional, unbounded; type catalogProductTierPriceEntity
            • customer_group_id - optional; type string
            • website - optional; type string
            • qty - optional; type int
            • price - optional; type double
        • meta_title - optional; type string
        • meta_keyword - optional; type string
        • meta_description - optional; type string
        • custom_design - optional; type string
        • custom_layout_update - optional; type string
        • options_container - optional; type string
        • additional_attributes - optional; type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
        • stock_data - optional; type catalogInventoryStockItemUpdateEntity
          • qty - optional; type string
          • is_in_stock - optional; type int
          • manage_stock - optional; type int
          • use_config_manage_stock - optional; type int
          • min_qty - optional; type int
          • use_config_min_qty - optional; type int
          • min_sale_qty - optional; type int
          • use_config_min_sale_qty - optional; type int
          • max_sale_qty - optional; type int
          • use_config_max_sale_qty - optional; type int
          • is_qty_decimal - optional; type int
          • backorders - optional; type int
          • use_config_backorders - optional; type int
          • notify_stock_qty - optional; type int
          • use_config_notify_stock_qty - optional; type int
      • store - optional; type string
      • identifierType - optional; type string
      Output:
      catalogProductUpdateResponse (soap:body, use = literal)Source code
      parameters type catalogProductUpdateResponseParam
      • result type boolean
    80. customerAddressCreate
      Description:
      Create customer address
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      customerAddressCreateRequest (soap:body, use = literal)Source code
      parameters type customerAddressCreateRequestParam
      • sessionId type string
      • customerId type int
      • addressData type customerAddressEntityCreate
        • city - optional; type string
        • company - optional; type string
        • country_id - optional; type string
        • fax - optional; type string
        • firstname - optional; type string
        • lastname - optional; type string
        • middlename - optional; type string
        • postcode - optional; type string
        • prefix - optional; type string
        • region_id - optional; type int
        • region - optional; type string
        • street - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • suffix - optional; type string
        • telephone - optional; type string
        • is_default_billing - optional; type boolean
        • is_default_shipping - optional; type boolean
      Output:
      customerAddressCreateResponse (soap:body, use = literal)Source code
      parameters type customerAddressCreateResponseParam
      • result type int
    81. customerAddressDelete
      Description:
      Delete customer address
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      customerAddressDeleteRequest (soap:body, use = literal)Source code
      parameters type customerAddressDeleteRequestParam
      • sessionId type string
      • addressId type int
      Output:
      customerAddressDeleteResponse (soap:body, use = literal)Source code
      parameters type customerAddressDeleteResponseParam
      • result type boolean
    82. customerAddressInfo
      Description:
      Retrieve customer address data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      customerAddressInfoRequest (soap:body, use = literal)Source code
      parameters type customerAddressInfoRequestParam
      • sessionId type string
      • addressId type int
      Output:
      customerAddressInfoResponse (soap:body, use = literal)Source code
      parameters type customerAddressInfoResponseParam
      • result type customerAddressEntityItem
        • customer_address_id - optional; type int
        • created_at - optional; type string
        • updated_at - optional; type string
        • increment_id - optional; type string
        • city - optional; type string
        • company - optional; type string
        • country_id - optional; type string
        • fax - optional; type string
        • firstname - optional; type string
        • lastname - optional; type string
        • middlename - optional; type string
        • postcode - optional; type string
        • prefix - optional; type string
        • region - optional; type string
        • region_id - optional; type int
        • street - optional; type string
        • suffix - optional; type string
        • telephone - optional; type string
        • is_default_billing - optional; type boolean
        • is_default_shipping - optional; type boolean
    83. customerAddressList
      Description:
      Retrieve customer addresses
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      customerAddressListRequest (soap:body, use = literal)Source code
      parameters type customerAddressListRequestParam
      • sessionId type string
      • customerId type int
      Output:
      customerAddressListResponse (soap:body, use = literal)Source code
      parameters type customerAddressListResponseParam
      • result type customerAddressEntityArray
        • complexObjectArray - optional, unbounded; type customerAddressEntityItem
          • customer_address_id - optional; type int
          • created_at - optional; type string
          • updated_at - optional; type string
          • increment_id - optional; type string
          • city - optional; type string
          • company - optional; type string
          • country_id - optional; type string
          • fax - optional; type string
          • firstname - optional; type string
          • lastname - optional; type string
          • middlename - optional; type string
          • postcode - optional; type string
          • prefix - optional; type string
          • region - optional; type string
          • region_id - optional; type int
          • street - optional; type string
          • suffix - optional; type string
          • telephone - optional; type string
          • is_default_billing - optional; type boolean
          • is_default_shipping - optional; type boolean
    84. customerAddressUpdate
      Description:
      Update customer address data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      customerAddressUpdateRequest (soap:body, use = literal)Source code
      parameters type customerAddressUpdateRequestParam
      • sessionId type string
      • addressId type int
      • addressData type customerAddressEntityCreate
        • city - optional; type string
        • company - optional; type string
        • country_id - optional; type string
        • fax - optional; type string
        • firstname - optional; type string
        • lastname - optional; type string
        • middlename - optional; type string
        • postcode - optional; type string
        • prefix - optional; type string
        • region_id - optional; type int
        • region - optional; type string
        • street - optional; type ArrayOfString
          • complexObjectArray - optional, unbounded; type string
        • suffix - optional; type string
        • telephone - optional; type string
        • is_default_billing - optional; type boolean
        • is_default_shipping - optional; type boolean
      Output:
      customerAddressUpdateResponse (soap:body, use = literal)Source code
      parameters type customerAddressUpdateResponseParam
      • result type boolean
    85. customerCustomerCreate
      Description:
      Create customer
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      customerCustomerCreateRequest (soap:body, use = literal)Source code
      parameters type customerCustomerCreateRequestParam
      • sessionId type string
      • customerData type customerCustomerEntityToCreate
        • customer_id - optional; type int
        • email - optional; type string
        • firstname - optional; type string
        • lastname - optional; type string
        • middlename - optional; type string
        • password - optional; type string
        • website_id - optional; type int
        • store_id - optional; type int
        • group_id - optional; type int
        • prefix - optional; type string
        • suffix - optional; type string
        • dob - optional; type string
        • taxvat - optional; type string
        • gender - optional; type int
      Output:
      customerCustomerCreateResponse (soap:body, use = literal)Source code
      parameters type customerCustomerCreateResponseParam
      • result type int
    86. customerCustomerDelete
      Description:
      Delete customer
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      customerCustomerDeleteRequest (soap:body, use = literal)Source code
      parameters type customerCustomerDeleteRequestParam
      • sessionId type string
      • customerId type int
      Output:
      customerCustomerDeleteResponse (soap:body, use = literal)Source code
      parameters type customerCustomerDeleteResponseParam
      • result type boolean
    87. customerCustomerInfo
      Description:
      Retrieve customer data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      customerCustomerInfoRequest (soap:body, use = literal)Source code
      parameters type customerCustomerInfoRequestParam
      • sessionId type string
      • customerId type int
      • attributes - optional; type ArrayOfString
        • complexObjectArray - optional, unbounded; type string
      Output:
      customerCustomerInfoResponse (soap:body, use = literal)Source code
      parameters type customerCustomerInfoResponseParam
      • result type customerCustomerEntity
        • customer_id - optional; type int
        • created_at - optional; type string
        • updated_at - optional; type string
        • increment_id - optional; type string
        • store_id - optional; type int
        • website_id - optional; type int
        • created_in - optional; type string
        • email - optional; type string
        • firstname - optional; type string
        • middlename - optional; type string
        • lastname - optional; type string
        • group_id - optional; type int
        • prefix - optional; type string
        • suffix - optional; type string
        • dob - optional; type string
        • taxvat - optional; type string
        • confirmation - optional; type boolean
        • password_hash - optional; type string
    88. customerCustomerList
      Description:
      Retrieve customers
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      customerCustomerListRequest (soap:body, use = literal)Source code
      parameters type customerCustomerListRequestParam
      • sessionId type string
      • filters type filters
        • filter - optional; type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
        • complex_filter - optional; type complexFilterArray
          • complexObjectArray - optional, unbounded; type complexFilter
            • key type string
            • value type associativeEntity
              • key type string
              • value type string
      Output:
      customerCustomerListResponse (soap:body, use = literal)Source code
      parameters type customerCustomerListResponseParam
      • result type customerCustomerEntityArray
        • complexObjectArray - optional, unbounded; type customerCustomerEntity
          • customer_id - optional; type int
          • created_at - optional; type string
          • updated_at - optional; type string
          • increment_id - optional; type string
          • store_id - optional; type int
          • website_id - optional; type int
          • created_in - optional; type string
          • email - optional; type string
          • firstname - optional; type string
          • middlename - optional; type string
          • lastname - optional; type string
          • group_id - optional; type int
          • prefix - optional; type string
          • suffix - optional; type string
          • dob - optional; type string
          • taxvat - optional; type string
          • confirmation - optional; type boolean
          • password_hash - optional; type string
    89. customerCustomerUpdate
      Description:
      Update customer data
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      customerCustomerUpdateRequest (soap:body, use = literal)Source code
      parameters type customerCustomerUpdateRequestParam
      • sessionId type string
      • customerId type int
      • customerData type customerCustomerEntityToCreate
        • customer_id - optional; type int
        • email - optional; type string
        • firstname - optional; type string
        • lastname - optional; type string
        • middlename - optional; type string
        • password - optional; type string
        • website_id - optional; type int
        • store_id - optional; type int
        • group_id - optional; type int
        • prefix - optional; type string
        • suffix - optional; type string
        • dob - optional; type string
        • taxvat - optional; type string
        • gender - optional; type int
      Output:
      customerCustomerUpdateResponse (soap:body, use = literal)Source code
      parameters type customerCustomerUpdateResponseParam
      • result type boolean
    90. customerGroupList
      Description:
      Retrieve customer groups
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      customerGroupListRequest (soap:body, use = literal)Source code
      parameters type customerGroupListRequestParam
      • sessionId type string
      Output:
      customerGroupListResponse (soap:body, use = literal)Source code
      parameters type customerGroupListResponseParam
      • result type customerGroupEntityArray
        • complexObjectArray - optional, unbounded; type customerGroupEntity
          • customer_group_id type int
          • customer_group_code type string
    91. directoryCountryList
      Description:
      List of countries
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      directoryCountryListRequest (soap:body, use = literal)Source code
      parameters type directoryCountryListRequestParam
      • sessionId type string
      Output:
      directoryCountryListResponse (soap:body, use = literal)Source code
      parameters type directoryCountryListResponseParam
      • result type directoryCountryEntityArray
        • complexObjectArray - optional, unbounded; type directoryCountryEntity
          • country_id type string
          • iso2_code type string
          • iso3_code type string
          • name type string
    92. directoryRegionList
      Description:
      List of regions in specified country
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      directoryRegionListRequest (soap:body, use = literal)Source code
      parameters type directoryRegionListRequestParam
      • sessionId type string
      • country type string
      Output:
      directoryRegionListResponse (soap:body, use = literal)Source code
      parameters type directoryRegionListResponseParam
      • result type directoryRegionEntityArray
        • complexObjectArray - optional, unbounded; type directoryRegionEntity
          • region_id type string
          • code type string
          • name type string
    93. endSession
      Description:
      End web service session
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      endSession (soap:body, use = literal)Source code
      parameters type endSessionParam
      • sessionId type string
      Output:
      endSessionResponse (soap:body, use = literal)Source code
      parameters type endSessionResponseParam
      • result type boolean
    94. giftMessageSetForQuote
      Description:
      Set a gift message to the cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      giftMessageForQuoteRequest (soap:body, use = literal)Source code
      parameters type giftMessageForQuoteRequestParam
      • sessionId type string
      • quoteId type string
      • giftMessage type giftMessageEntity
        • from - optional; type string
        • to - optional; type string
        • message - optional; type string
      • store - optional; type string
      Output:
      giftMessageForQuoteResponse (soap:body, use = literal)Source code
      parameters type giftMessageForQuoteResponseParam
      • result type giftMessageResponse
        • entityId - optional; type string
        • result - optional; type boolean
        • error - optional; type string
    95. giftMessageSetForQuoteItem
      Description:
      Setting a gift messages to the quote item
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      giftMessageForQuoteItemRequest (soap:body, use = literal)Source code
      parameters type giftMessageForQuoteItemRequestParam
      • sessionId type string
      • quoteItemId type string
      • giftMessage type giftMessageEntity
        • from - optional; type string
        • to - optional; type string
        • message - optional; type string
      • store - optional; type string
      Output:
      giftMessageForQuoteItemResponse (soap:body, use = literal)Source code
      parameters type giftMessageForQuoteItemResponseParam
      • result type giftMessageResponse
        • entityId - optional; type string
        • result - optional; type boolean
        • error - optional; type string
    96. giftMessageSetForQuoteProduct
      Description:
      Setting a gift messages to the quote items by products
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      giftMessageForQuoteProductRequest (soap:body, use = literal)Source code
      parameters type giftMessageForQuoteProductRequestParam
      • sessionId type string
      • quoteId type string
      • productsAndMessages type giftMessageAssociativeProductsEntityArray
        • complexObjectArray - optional, unbounded; type giftMessageAssociativeProductsEntity
          • product type shoppingCartProductEntity
            • product_id - optional; type string
            • sku - optional; type string
            • qty - optional; type double
            • options - optional; type associativeArray
              • complexObjectArray - optional, unbounded; type associativeEntity
                • key type string
                • value type string
            • bundle_option - optional; type associativeArray
              • complexObjectArray - optional, unbounded; type associativeEntity
                • key type string
                • value type string
            • bundle_option_qty - optional; type associativeArray
              • complexObjectArray - optional, unbounded; type associativeEntity
                • key type string
                • value type string
            • links - optional; type ArrayOfString
              • complexObjectArray - optional, unbounded; type string
          • message type giftMessageEntity
            • from - optional; type string
            • to - optional; type string
            • message - optional; type string
      • store - optional; type string
      Output:
      giftMessageForQuoteProductResponse (soap:body, use = literal)Source code
      parameters type giftMessageForQuoteProductResponseParam
      • result type giftMessageResponseArray
        • complexObjectArray - optional, unbounded; type giftMessageResponse
          • entityId - optional; type string
          • result - optional; type boolean
          • error - optional; type string
    97. globalFaults
      Description:
      List of global faults
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      globalFaults (soap:body, use = literal)Source code
      parameters type globalFaultsParam
      • sessionId type string
      Output:
      globalFaultsResponse (soap:body, use = literal)Source code
      parameters type globalFaultsResponseParam
      • result type ArrayOfExistsFaltures
        • complexObjectArray - optional, unbounded; type existsFaltureEntity
          • code type string
          • message type string
    98. login
      Description:
      Login user and retrive session id
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      login (soap:body, use = literal)Source code
      parameters type loginParam
      • username type string
      • apiKey type string
      Output:
      loginResponse (soap:body, use = literal)Source code
      parameters type loginResponseParam
      • result type string
    99. magentoInfo
      Description:
      Info about current Magento installation
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      magentoInfoRequest (soap:body, use = literal)Source code
      parameters type magentoInfoRequestParam
      • sessionId type string
      Output:
      magentoInfoResponse (soap:body, use = literal)Source code
      parameters type magentoInfoResponseParam
      • result type magentoInfoEntity
        • magento_version type string
        • magento_edition type string
    100. multiCall
      Description:
      Multiple calls of resource functionality
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      multiCall (soap:body, use = literal)Source code
      parameters type multiCallParam
      • sessionId type string
      • calls type anyType
      • options type anyType
      Output:
      multiCallResponse (soap:body, use = literal)Source code
      parameters type multiCallResponseParam
      • result type anyType
    101. resourceFaults
      Description:
      List of resource faults
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      resourceFaults (soap:body, use = literal)Source code
      parameters type resourceFaultsParam
      • sessionId type string
      • resourceName type string
      Output:
      resourceFaultsResponse (soap:body, use = literal)Source code
      parameters type resourceFaultsResponseParam
      • result type ArrayOfExistsFaltures
        • complexObjectArray - optional, unbounded; type existsFaltureEntity
          • code type string
          • message type string
    102. resources
      Description:
      List of available resources
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      resourcesRequest (soap:body, use = literal)Source code
      parameters type resourcesRequestParam
      • sessionId type string
      Output:
      resourcesResponse (soap:body, use = literal)Source code
      parameters type resourcesResponseParam
      • result type ArrayOfApis
        • complexObjectArray - optional, unbounded; type apiEntity
          • title type string
          • name type string
          • aliases type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
          • methods type ArrayOfApiMethods
            • complexObjectArray - optional, unbounded; type apiMethodEntity
              • title type string
              • path type string
              • name type string
              • aliases type ArrayOfString
                • complexObjectArray - optional, unbounded; type string
    103. salesOrderAddComment
      Description:
      Add comment to order
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderAddCommentRequest (soap:body, use = literal)Source code
      parameters type salesOrderAddCommentRequestParam
      • sessionId type string
      • orderIncrementId type string
      • status type string
      • comment - optional; type string
      • notify - optional; type int
      Output:
      salesOrderAddCommentResponse (soap:body, use = literal)Source code
      parameters type salesOrderAddCommentResponseParam
      • result type int
    104. salesOrderCancel
      Description:
      Cancel order
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderCancelRequest (soap:body, use = literal)Source code
      parameters type salesOrderCancelRequestParam
      • sessionId type string
      • orderIncrementId type string
      Output:
      salesOrderCancelResponse (soap:body, use = literal)Source code
      parameters type salesOrderCancelResponseParam
      • result type int
    105. salesOrderCreditmemoAddComment
      Description:
      Add new comment to creditmemo
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderCreditmemoAddCommentRequest (soap:body, use = literal)Source code
      parameters type salesOrderCreditmemoAddCommentRequestParam
      • sessionId type string
      • creditmemoIncrementId type string
      • comment type string
      • notifyCustomer - optional; type int
      • includeComment - optional; type int
      Output:
      salesOrderCreditmemoAddCommentResponse (soap:body, use = literal)Source code
      parameters type salesOrderCreditmemoAddCommentResponseParam
      • result type int
    106. salesOrderCreditmemoCancel
      Description:
      Cancel creditmemo
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderCreditmemoCancelRequest (soap:body, use = literal)Source code
      parameters type salesOrderCreditmemoCancelRequestParam
      • sessionId type string
      • creditmemoIncrementId type string
      Output:
      salesOrderCreditmemoCancelResponse (soap:body, use = literal)Source code
      parameters type salesOrderCreditmemoCancelResponseParam
      • result type string
    107. salesOrderCreditmemoCreate
      Description:
      Create new creditmemo for order
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderCreditmemoCreateRequest (soap:body, use = literal)Source code
      parameters type salesOrderCreditmemoCreateRequestParam
      • sessionId type string
      • orderIncrementId type string
      • creditmemoData - optional; type salesOrderCreditmemoData
        • qtys - optional; type orderItemIdQtyArray
          • complexObjectArray - optional, unbounded; type orderItemIdQty
            • order_item_id type int
            • qty type double
        • shipping_amount - optional; type double
        • adjustment_positive - optional; type double
        • adjustment_negative - optional; type double
      • comment - optional; type string
      • notifyCustomer - optional; type int
      • includeComment - optional; type int
      • refundToStoreCreditAmount - optional; type string
      Output:
      salesOrderCreditmemoCreateResponse (soap:body, use = literal)Source code
      parameters type salesOrderCreditmemoCreateResponseParam
      • result type string
    108. salesOrderCreditmemoInfo
      Description:
      Retrieve creditmemo information
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderCreditmemoInfoRequest (soap:body, use = literal)Source code
      parameters type salesOrderCreditmemoInfoRequestParam
      • sessionId type string
      • creditmemoIncrementId type string
      Output:
      salesOrderCreditmemoInfoResponse (soap:body, use = literal)Source code
      parameters type salesOrderCreditmemoInfoResponseParam
      • result type salesOrderCreditmemoEntity
        • updated_at - optional; type string
        • created_at - optional; type string
        • increment_id - optional; type string
        • transaction_id - optional; type string
        • global_currency_code - optional; type string
        • base_currency_code - optional; type string
        • order_currency_code - optional; type string
        • store_currency_code - optional; type string
        • cybersource_token - optional; type string
        • invoice_id - optional; type string
        • billing_address_id - optional; type string
        • shipping_address_id - optional; type string
        • state - optional; type string
        • creditmemo_status - optional; type string
        • email_sent - optional; type string
        • order_id - optional; type string
        • tax_amount - optional; type string
        • shipping_tax_amount - optional; type string
        • base_tax_amount - optional; type string
        • base_adjustment_positive - optional; type string
        • base_grand_total - optional; type string
        • adjustment - optional; type string
        • subtotal - optional; type string
        • discount_amount - optional; type string
        • base_subtotal - optional; type string
        • base_adjustment - optional; type string
        • base_to_global_rate - optional; type string
        • store_to_base_rate - optional; type string
        • base_shipping_amount - optional; type string
        • adjustment_negative - optional; type string
        • subtotal_incl_tax - optional; type string
        • shipping_amount - optional; type string
        • base_subtotal_incl_tax - optional; type string
        • base_adjustment_negative - optional; type string
        • grand_total - optional; type string
        • base_discount_amount - optional; type string
        • base_to_order_rate - optional; type string
        • store_to_order_rate - optional; type string
        • base_shipping_tax_amount - optional; type string
        • adjustment_positive - optional; type string
        • store_id - optional; type string
        • hidden_tax_amount - optional; type string
        • base_hidden_tax_amount - optional; type string
        • shipping_hidden_tax_amount - optional; type string
        • base_shipping_hidden_tax_amnt - optional; type string
        • shipping_incl_tax - optional; type string
        • base_shipping_incl_tax - optional; type string
        • base_customer_balance_amount - optional; type string
        • customer_balance_amount - optional; type string
        • bs_customer_bal_total_refunded - optional; type string
        • customer_bal_total_refunded - optional; type string
        • base_gift_cards_amount - optional; type string
        • gift_cards_amount - optional; type string
        • gw_base_price - optional; type string
        • gw_price - optional; type string
        • gw_items_base_price - optional; type string
        • gw_items_price - optional; type string
        • gw_card_base_price - optional; type string
        • gw_card_price - optional; type string
        • gw_base_tax_amount - optional; type string
        • gw_tax_amount - optional; type string
        • gw_items_base_tax_amount - optional; type string
        • gw_items_tax_amount - optional; type string
        • gw_card_base_tax_amount - optional; type string
        • gw_card_tax_amount - optional; type string
        • base_reward_currency_amount - optional; type string
        • reward_currency_amount - optional; type string
        • reward_points_balance - optional; type string
        • reward_points_balance_refund - optional; type string
        • creditmemo_id - optional; type string
        • items - optional; type salesOrderCreditmemoItemEntityArray
          • complexObjectArray - optional, unbounded; type salesOrderCreditmemoItemEntity
            • item_id - optional; type string
            • parent_id - optional; type string
            • weee_tax_applied_row_amount - optional; type string
            • base_price - optional; type string
            • base_weee_tax_row_disposition - optional; type string
            • tax_amount - optional; type string
            • base_weee_tax_applied_amount - optional; type string
            • weee_tax_row_disposition - optional; type string
            • base_row_total - optional; type string
            • discount_amount - optional; type string
            • row_total - optional; type string
            • weee_tax_applied_amount - optional; type string
            • base_discount_amount - optional; type string
            • base_weee_tax_disposition - optional; type string
            • price_incl_tax - optional; type string
            • base_tax_amount - optional; type string
            • weee_tax_disposition - optional; type string
            • base_price_incl_tax - optional; type string
            • qty - optional; type string
            • base_cost - optional; type string
            • base_weee_tax_applied_row_amount - optional; type string
            • price - optional; type string
            • base_row_total_incl_tax - optional; type string
            • row_total_incl_tax - optional; type string
            • product_id - optional; type string
            • order_item_id - optional; type string
            • additional_data - optional; type string
            • description - optional; type string
            • weee_tax_applied - optional; type string
            • sku - optional; type string
            • name - optional; type string
            • hidden_tax_amount - optional; type string
            • base_hidden_tax_amount - optional; type string
        • comments - optional; type salesOrderCreditmemoCommentEntityArray
          • complexObjectArray - optional, unbounded; type salesOrderCreditmemoCommentEntity
            • parent_id - optional; type string
            • created_at - optional; type string
            • comment - optional; type string
            • is_customer_notified - optional; type string
            • comment_id - optional; type string
            • is_visible_on_front - optional; type string
    109. salesOrderCreditmemoList
      Description:
      Retrieve list of creditmemos by filters
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderCreditmemoListRequest (soap:body, use = literal)Source code
      parameters type salesOrderCreditmemoListRequestParam
      • sessionId type string
      • filters - optional; type filters
        • filter - optional; type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
        • complex_filter - optional; type complexFilterArray
          • complexObjectArray - optional, unbounded; type complexFilter
            • key type string
            • value type associativeEntity
              • key type string
              • value type string
      Output:
      salesOrderCreditmemoListResponse (soap:body, use = literal)Source code
      parameters type salesOrderCreditmemoListResponseParam
      • result type salesOrderCreditmemoEntityArray
        • complexObjectArray - optional, unbounded; type salesOrderCreditmemoEntity
          • updated_at - optional; type string
          • created_at - optional; type string
          • increment_id - optional; type string
          • transaction_id - optional; type string
          • global_currency_code - optional; type string
          • base_currency_code - optional; type string
          • order_currency_code - optional; type string
          • store_currency_code - optional; type string
          • cybersource_token - optional; type string
          • invoice_id - optional; type string
          • billing_address_id - optional; type string
          • shipping_address_id - optional; type string
          • state - optional; type string
          • creditmemo_status - optional; type string
          • email_sent - optional; type string
          • order_id - optional; type string
          • tax_amount - optional; type string
          • shipping_tax_amount - optional; type string
          • base_tax_amount - optional; type string
          • base_adjustment_positive - optional; type string
          • base_grand_total - optional; type string
          • adjustment - optional; type string
          • subtotal - optional; type string
          • discount_amount - optional; type string
          • base_subtotal - optional; type string
          • base_adjustment - optional; type string
          • base_to_global_rate - optional; type string
          • store_to_base_rate - optional; type string
          • base_shipping_amount - optional; type string
          • adjustment_negative - optional; type string
          • subtotal_incl_tax - optional; type string
          • shipping_amount - optional; type string
          • base_subtotal_incl_tax - optional; type string
          • base_adjustment_negative - optional; type string
          • grand_total - optional; type string
          • base_discount_amount - optional; type string
          • base_to_order_rate - optional; type string
          • store_to_order_rate - optional; type string
          • base_shipping_tax_amount - optional; type string
          • adjustment_positive - optional; type string
          • store_id - optional; type string
          • hidden_tax_amount - optional; type string
          • base_hidden_tax_amount - optional; type string
          • shipping_hidden_tax_amount - optional; type string
          • base_shipping_hidden_tax_amnt - optional; type string
          • shipping_incl_tax - optional; type string
          • base_shipping_incl_tax - optional; type string
          • base_customer_balance_amount - optional; type string
          • customer_balance_amount - optional; type string
          • bs_customer_bal_total_refunded - optional; type string
          • customer_bal_total_refunded - optional; type string
          • base_gift_cards_amount - optional; type string
          • gift_cards_amount - optional; type string
          • gw_base_price - optional; type string
          • gw_price - optional; type string
          • gw_items_base_price - optional; type string
          • gw_items_price - optional; type string
          • gw_card_base_price - optional; type string
          • gw_card_price - optional; type string
          • gw_base_tax_amount - optional; type string
          • gw_tax_amount - optional; type string
          • gw_items_base_tax_amount - optional; type string
          • gw_items_tax_amount - optional; type string
          • gw_card_base_tax_amount - optional; type string
          • gw_card_tax_amount - optional; type string
          • base_reward_currency_amount - optional; type string
          • reward_currency_amount - optional; type string
          • reward_points_balance - optional; type string
          • reward_points_balance_refund - optional; type string
          • creditmemo_id - optional; type string
          • items - optional; type salesOrderCreditmemoItemEntityArray
            • complexObjectArray - optional, unbounded; type salesOrderCreditmemoItemEntity
              • item_id - optional; type string
              • parent_id - optional; type string
              • weee_tax_applied_row_amount - optional; type string
              • base_price - optional; type string
              • base_weee_tax_row_disposition - optional; type string
              • tax_amount - optional; type string
              • base_weee_tax_applied_amount - optional; type string
              • weee_tax_row_disposition - optional; type string
              • base_row_total - optional; type string
              • discount_amount - optional; type string
              • row_total - optional; type string
              • weee_tax_applied_amount - optional; type string
              • base_discount_amount - optional; type string
              • base_weee_tax_disposition - optional; type string
              • price_incl_tax - optional; type string
              • base_tax_amount - optional; type string
              • weee_tax_disposition - optional; type string
              • base_price_incl_tax - optional; type string
              • qty - optional; type string
              • base_cost - optional; type string
              • base_weee_tax_applied_row_amount - optional; type string
              • price - optional; type string
              • base_row_total_incl_tax - optional; type string
              • row_total_incl_tax - optional; type string
              • product_id - optional; type string
              • order_item_id - optional; type string
              • additional_data - optional; type string
              • description - optional; type string
              • weee_tax_applied - optional; type string
              • sku - optional; type string
              • name - optional; type string
              • hidden_tax_amount - optional; type string
              • base_hidden_tax_amount - optional; type string
          • comments - optional; type salesOrderCreditmemoCommentEntityArray
            • complexObjectArray - optional, unbounded; type salesOrderCreditmemoCommentEntity
              • parent_id - optional; type string
              • created_at - optional; type string
              • comment - optional; type string
              • is_customer_notified - optional; type string
              • comment_id - optional; type string
              • is_visible_on_front - optional; type string
    110. salesOrderHold
      Description:
      Hold order
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderHoldRequest (soap:body, use = literal)Source code
      parameters type salesOrderHoldRequestParam
      • sessionId type string
      • orderIncrementId type string
      Output:
      salesOrderHoldResponse (soap:body, use = literal)Source code
      parameters type salesOrderHoldResponseParam
      • result type int
    111. salesOrderInfo
      Description:
      Retrieve order information
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderInfoRequest (soap:body, use = literal)Source code
      parameters type salesOrderInfoRequestParam
      • sessionId type string
      • orderIncrementId type string
      Output:
      salesOrderInfoResponse (soap:body, use = literal)Source code
      parameters type salesOrderInfoResponseParam
      • result type salesOrderEntity
        • increment_id - optional; type string
        • parent_id - optional; type string
        • store_id - optional; type string
        • created_at - optional; type string
        • updated_at - optional; type string
        • is_active - optional; type string
        • customer_id - optional; type string
        • tax_amount - optional; type string
        • shipping_amount - optional; type string
        • discount_amount - optional; type string
        • subtotal - optional; type string
        • grand_total - optional; type string
        • total_paid - optional; type string
        • total_refunded - optional; type string
        • total_qty_ordered - optional; type string
        • total_canceled - optional; type string
        • total_invoiced - optional; type string
        • total_online_refunded - optional; type string
        • total_offline_refunded - optional; type string
        • base_tax_amount - optional; type string
        • base_shipping_amount - optional; type string
        • base_discount_amount - optional; type string
        • base_subtotal - optional; type string
        • base_grand_total - optional; type string
        • base_total_paid - optional; type string
        • base_total_refunded - optional; type string
        • base_total_qty_ordered - optional; type string
        • base_total_canceled - optional; type string
        • base_total_invoiced - optional; type string
        • base_total_online_refunded - optional; type string
        • base_total_offline_refunded - optional; type string
        • billing_address_id - optional; type string
        • billing_firstname - optional; type string
        • billing_lastname - optional; type string
        • shipping_address_id - optional; type string
        • shipping_firstname - optional; type string
        • shipping_lastname - optional; type string
        • billing_name - optional; type string
        • shipping_name - optional; type string
        • store_to_base_rate - optional; type string
        • store_to_order_rate - optional; type string
        • base_to_global_rate - optional; type string
        • base_to_order_rate - optional; type string
        • weight - optional; type string
        • store_name - optional; type string
        • remote_ip - optional; type string
        • status - optional; type string
        • state - optional; type string
        • applied_rule_ids - optional; type string
        • global_currency_code - optional; type string
        • base_currency_code - optional; type string
        • store_currency_code - optional; type string
        • order_currency_code - optional; type string
        • shipping_method - optional; type string
        • shipping_description - optional; type string
        • customer_email - optional; type string
        • customer_firstname - optional; type string
        • customer_lastname - optional; type string
        • quote_id - optional; type string
        • is_virtual - optional; type string
        • customer_group_id - optional; type string
        • customer_note_notify - optional; type string
        • customer_is_guest - optional; type string
        • email_sent - optional; type string
        • order_id - optional; type string
        • gift_message_id - optional; type string
        • gift_message - optional; type string
        • shipping_address - optional; type salesOrderAddressEntity
          • increment_id - optional; type string
          • parent_id - optional; type string
          • created_at - optional; type string
          • updated_at - optional; type string
          • is_active - optional; type string
          • address_type - optional; type string
          • firstname - optional; type string
          • lastname - optional; type string
          • company - optional; type string
          • street - optional; type string
          • city - optional; type string
          • region - optional; type string
          • postcode - optional; type string
          • country_id - optional; type string
          • telephone - optional; type string
          • fax - optional; type string
          • region_id - optional; type string
          • address_id - optional; type string
        • billing_address - optional; type salesOrderAddressEntity
          • increment_id - optional; type string
          • parent_id - optional; type string
          • created_at - optional; type string
          • updated_at - optional; type string
          • is_active - optional; type string
          • address_type - optional; type string
          • firstname - optional; type string
          • lastname - optional; type string
          • company - optional; type string
          • street - optional; type string
          • city - optional; type string
          • region - optional; type string
          • postcode - optional; type string
          • country_id - optional; type string
          • telephone - optional; type string
          • fax - optional; type string
          • region_id - optional; type string
          • address_id - optional; type string
        • items - optional; type salesOrderItemEntityArray
          • complexObjectArray - optional, unbounded; type salesOrderItemEntity
            • item_id - optional; type string
            • order_id - optional; type string
            • quote_item_id - optional; type string
            • created_at - optional; type string
            • updated_at - optional; type string
            • product_id - optional; type string
            • product_type - optional; type string
            • product_options - optional; type string
            • weight - optional; type string
            • is_virtual - optional; type string
            • sku - optional; type string
            • name - optional; type string
            • applied_rule_ids - optional; type string
            • free_shipping - optional; type string
            • is_qty_decimal - optional; type string
            • no_discount - optional; type string
            • qty_canceled - optional; type string
            • qty_invoiced - optional; type string
            • qty_ordered - optional; type string
            • qty_refunded - optional; type string
            • qty_shipped - optional; type string
            • cost - optional; type string
            • price - optional; type string
            • base_price - optional; type string
            • original_price - optional; type string
            • base_original_price - optional; type string
            • tax_percent - optional; type string
            • tax_amount - optional; type string
            • base_tax_amount - optional; type string
            • tax_invoiced - optional; type string
            • base_tax_invoiced - optional; type string
            • discount_percent - optional; type string
            • discount_amount - optional; type string
            • base_discount_amount - optional; type string
            • discount_invoiced - optional; type string
            • base_discount_invoiced - optional; type string
            • amount_refunded - optional; type string
            • base_amount_refunded - optional; type string
            • row_total - optional; type string
            • base_row_total - optional; type string
            • row_invoiced - optional; type string
            • base_row_invoiced - optional; type string
            • row_weight - optional; type string
            • gift_message_id - optional; type string
            • gift_message - optional; type string
            • gift_message_available - optional; type string
            • base_tax_before_discount - optional; type string
            • tax_before_discount - optional; type string
            • weee_tax_applied - optional; type string
            • weee_tax_applied_amount - optional; type string
            • weee_tax_applied_row_amount - optional; type string
            • base_weee_tax_applied_amount - optional; type string
            • base_weee_tax_applied_row_amount - optional; type string
            • weee_tax_disposition - optional; type string
            • weee_tax_row_disposition - optional; type string
            • base_weee_tax_disposition - optional; type string
            • base_weee_tax_row_disposition - optional; type string
        • payment - optional; type salesOrderPaymentEntity
          • increment_id - optional; type string
          • parent_id - optional; type string
          • created_at - optional; type string
          • updated_at - optional; type string
          • is_active - optional; type string
          • amount_ordered - optional; type string
          • shipping_amount - optional; type string
          • base_amount_ordered - optional; type string
          • base_shipping_amount - optional; type string
          • method - optional; type string
          • po_number - optional; type string
          • cc_type - optional; type string
          • cc_number_enc - optional; type string
          • cc_last4 - optional; type string
          • cc_owner - optional; type string
          • cc_exp_month - optional; type string
          • cc_exp_year - optional; type string
          • cc_ss_start_month - optional; type string
          • cc_ss_start_year - optional; type string
          • payment_id - optional; type string
        • status_history - optional; type salesOrderStatusHistoryEntityArray
          • complexObjectArray - optional, unbounded; type salesOrderStatusHistoryEntity
            • increment_id - optional; type string
            • parent_id - optional; type string
            • created_at - optional; type string
            • updated_at - optional; type string
            • is_active - optional; type string
            • is_customer_notified - optional; type string
            • status - optional; type string
            • comment - optional; type string
    112. salesOrderInvoiceAddComment
      Description:
      Add new comment to shipment
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderInvoiceAddCommentRequest (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceAddCommentRequestParam
      • sessionId type string
      • invoiceIncrementId type string
      • comment type string
      • email - optional; type string
      • includeComment - optional; type string
      Output:
      salesOrderInvoiceAddCommentResponse (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceAddCommentResponseParam
      • result type string
    113. salesOrderInvoiceCancel
      Description:
      Cancel invoice
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderInvoiceCancelRequest (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceCancelRequestParam
      • sessionId type string
      • invoiceIncrementId type string
      Output:
      salesOrderInvoiceCancelResponse (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceCancelResponseParam
      • result type string
    114. salesOrderInvoiceCapture
      Description:
      Capture invoice
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderInvoiceCaptureRequest (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceCaptureRequestParam
      • sessionId type string
      • invoiceIncrementId type string
      Output:
      salesOrderInvoiceCaptureResponse (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceCaptureResponseParam
      • result type string
    115. salesOrderInvoiceCreate
      Description:
      Create new invoice for order
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderInvoiceCreateRequest (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceCreateRequestParam
      • sessionId type string
      • invoiceIncrementId type string
      • itemsQty type orderItemIdQtyArray
        • complexObjectArray - optional, unbounded; type orderItemIdQty
          • order_item_id type int
          • qty type double
      • comment - optional; type string
      • email - optional; type string
      • includeComment - optional; type string
      Output:
      salesOrderInvoiceCreateResponse (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceCreateResponseParam
      • result type string
    116. salesOrderInvoiceInfo
      Description:
      Retrieve invoice information
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderInvoiceInfoRequest (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceInfoRequestParam
      • sessionId type string
      • invoiceIncrementId type string
      Output:
      salesOrderInvoiceInfoResponse (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceInfoResponseParam
      • result type salesOrderInvoiceEntity
        • increment_id - optional; type string
        • parent_id - optional; type string
        • store_id - optional; type string
        • created_at - optional; type string
        • updated_at - optional; type string
        • is_active - optional; type string
        • global_currency_code - optional; type string
        • base_currency_code - optional; type string
        • store_currency_code - optional; type string
        • order_currency_code - optional; type string
        • store_to_base_rate - optional; type string
        • store_to_order_rate - optional; type string
        • base_to_global_rate - optional; type string
        • base_to_order_rate - optional; type string
        • subtotal - optional; type string
        • base_subtotal - optional; type string
        • base_grand_total - optional; type string
        • discount_amount - optional; type string
        • base_discount_amount - optional; type string
        • shipping_amount - optional; type string
        • base_shipping_amount - optional; type string
        • tax_amount - optional; type string
        • base_tax_amount - optional; type string
        • billing_address_id - optional; type string
        • billing_firstname - optional; type string
        • billing_lastname - optional; type string
        • order_id - optional; type string
        • order_increment_id - optional; type string
        • order_created_at - optional; type string
        • state - optional; type string
        • grand_total - optional; type string
        • invoice_id - optional; type string
        • items - optional; type salesOrderInvoiceItemEntityArray
          • complexObjectArray - optional, unbounded; type salesOrderInvoiceItemEntity
            • increment_id - optional; type string
            • parent_id - optional; type string
            • created_at - optional; type string
            • updated_at - optional; type string
            • is_active - optional; type string
            • weee_tax_applied - optional; type string
            • qty - optional; type string
            • cost - optional; type string
            • price - optional; type string
            • tax_amount - optional; type string
            • row_total - optional; type string
            • base_price - optional; type string
            • base_tax_amount - optional; type string
            • base_row_total - optional; type string
            • base_weee_tax_applied_amount - optional; type string
            • base_weee_tax_applied_row_amount - optional; type string
            • weee_tax_applied_amount - optional; type string
            • weee_tax_applied_row_amount - optional; type string
            • weee_tax_disposition - optional; type string
            • weee_tax_row_disposition - optional; type string
            • base_weee_tax_disposition - optional; type string
            • base_weee_tax_row_disposition - optional; type string
            • sku - optional; type string
            • name - optional; type string
            • order_item_id - optional; type string
            • product_id - optional; type string
            • item_id - optional; type string
        • comments - optional; type salesOrderInvoiceCommentEntityArray
          • complexObjectArray - optional, unbounded; type salesOrderInvoiceCommentEntity
            • increment_id - optional; type string
            • parent_id - optional; type string
            • created_at - optional; type string
            • updated_at - optional; type string
            • is_active - optional; type string
            • comment - optional; type string
            • is_customer_notified - optional; type string
            • comment_id - optional; type string
    117. salesOrderInvoiceList
      Description:
      Retrieve list of invoices by filters
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderInvoiceListRequest (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceListRequestParam
      • sessionId type string
      • filters - optional; type filters
        • filter - optional; type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
        • complex_filter - optional; type complexFilterArray
          • complexObjectArray - optional, unbounded; type complexFilter
            • key type string
            • value type associativeEntity
              • key type string
              • value type string
      Output:
      salesOrderInvoiceListResponse (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceListResponseParam
      • result type salesOrderInvoiceEntityArray
        • complexObjectArray - optional, unbounded; type salesOrderInvoiceEntity
          • increment_id - optional; type string
          • parent_id - optional; type string
          • store_id - optional; type string
          • created_at - optional; type string
          • updated_at - optional; type string
          • is_active - optional; type string
          • global_currency_code - optional; type string
          • base_currency_code - optional; type string
          • store_currency_code - optional; type string
          • order_currency_code - optional; type string
          • store_to_base_rate - optional; type string
          • store_to_order_rate - optional; type string
          • base_to_global_rate - optional; type string
          • base_to_order_rate - optional; type string
          • subtotal - optional; type string
          • base_subtotal - optional; type string
          • base_grand_total - optional; type string
          • discount_amount - optional; type string
          • base_discount_amount - optional; type string
          • shipping_amount - optional; type string
          • base_shipping_amount - optional; type string
          • tax_amount - optional; type string
          • base_tax_amount - optional; type string
          • billing_address_id - optional; type string
          • billing_firstname - optional; type string
          • billing_lastname - optional; type string
          • order_id - optional; type string
          • order_increment_id - optional; type string
          • order_created_at - optional; type string
          • state - optional; type string
          • grand_total - optional; type string
          • invoice_id - optional; type string
          • items - optional; type salesOrderInvoiceItemEntityArray
            • complexObjectArray - optional, unbounded; type salesOrderInvoiceItemEntity
              • increment_id - optional; type string
              • parent_id - optional; type string
              • created_at - optional; type string
              • updated_at - optional; type string
              • is_active - optional; type string
              • weee_tax_applied - optional; type string
              • qty - optional; type string
              • cost - optional; type string
              • price - optional; type string
              • tax_amount - optional; type string
              • row_total - optional; type string
              • base_price - optional; type string
              • base_tax_amount - optional; type string
              • base_row_total - optional; type string
              • base_weee_tax_applied_amount - optional; type string
              • base_weee_tax_applied_row_amount - optional; type string
              • weee_tax_applied_amount - optional; type string
              • weee_tax_applied_row_amount - optional; type string
              • weee_tax_disposition - optional; type string
              • weee_tax_row_disposition - optional; type string
              • base_weee_tax_disposition - optional; type string
              • base_weee_tax_row_disposition - optional; type string
              • sku - optional; type string
              • name - optional; type string
              • order_item_id - optional; type string
              • product_id - optional; type string
              • item_id - optional; type string
          • comments - optional; type salesOrderInvoiceCommentEntityArray
            • complexObjectArray - optional, unbounded; type salesOrderInvoiceCommentEntity
              • increment_id - optional; type string
              • parent_id - optional; type string
              • created_at - optional; type string
              • updated_at - optional; type string
              • is_active - optional; type string
              • comment - optional; type string
              • is_customer_notified - optional; type string
              • comment_id - optional; type string
    118. salesOrderInvoiceVoid
      Description:
      Void invoice
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderInvoiceVoidRequest (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceVoidRequestParam
      • sessionId type string
      • invoiceIncrementId type string
      Output:
      salesOrderInvoiceVoidResponse (soap:body, use = literal)Source code
      parameters type salesOrderInvoiceVoidResponseParam
      • result type string
    119. salesOrderList
      Description:
      Retrieve list of orders by filters
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderListRequest (soap:body, use = literal)Source code
      parameters type salesOrderListRequestParam
      • sessionId type string
      • filters type filters
        • filter - optional; type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
        • complex_filter - optional; type complexFilterArray
          • complexObjectArray - optional, unbounded; type complexFilter
            • key type string
            • value type associativeEntity
              • key type string
              • value type string
      Output:
      salesOrderListResponse (soap:body, use = literal)Source code
      parameters type salesOrderListResponseParam
      • result type salesOrderListEntityArray
        • complexObjectArray - optional, unbounded; type salesOrderListEntity
          • increment_id - optional; type string
          • store_id - optional; type string
          • created_at - optional; type string
          • updated_at - optional; type string
          • customer_id - optional; type string
          • tax_amount - optional; type string
          • shipping_amount - optional; type string
          • discount_amount - optional; type string
          • subtotal - optional; type string
          • grand_total - optional; type string
          • total_paid - optional; type string
          • total_refunded - optional; type string
          • total_qty_ordered - optional; type string
          • total_canceled - optional; type string
          • total_invoiced - optional; type string
          • total_online_refunded - optional; type string
          • total_offline_refunded - optional; type string
          • base_tax_amount - optional; type string
          • base_shipping_amount - optional; type string
          • base_discount_amount - optional; type string
          • base_subtotal - optional; type string
          • base_grand_total - optional; type string
          • base_total_paid - optional; type string
          • base_total_refunded - optional; type string
          • base_total_qty_ordered - optional; type string
          • base_total_canceled - optional; type string
          • base_total_invoiced - optional; type string
          • base_total_online_refunded - optional; type string
          • base_total_offline_refunded - optional; type string
          • billing_address_id - optional; type string
          • billing_firstname - optional; type string
          • billing_lastname - optional; type string
          • shipping_address_id - optional; type string
          • shipping_firstname - optional; type string
          • shipping_lastname - optional; type string
          • billing_name - optional; type string
          • shipping_name - optional; type string
          • store_to_base_rate - optional; type string
          • store_to_order_rate - optional; type string
          • base_to_global_rate - optional; type string
          • base_to_order_rate - optional; type string
          • weight - optional; type string
          • store_name - optional; type string
          • remote_ip - optional; type string
          • status - optional; type string
          • state - optional; type string
          • applied_rule_ids - optional; type string
          • global_currency_code - optional; type string
          • base_currency_code - optional; type string
          • store_currency_code - optional; type string
          • order_currency_code - optional; type string
          • shipping_method - optional; type string
          • shipping_description - optional; type string
          • customer_email - optional; type string
          • customer_firstname - optional; type string
          • customer_lastname - optional; type string
          • quote_id - optional; type string
          • is_virtual - optional; type string
          • customer_group_id - optional; type string
          • customer_note_notify - optional; type string
          • customer_is_guest - optional; type string
          • email_sent - optional; type string
          • order_id - optional; type string
          • gift_message_id - optional; type string
          • coupon_code - optional; type string
          • protect_code - optional; type string
          • base_discount_canceled - optional; type string
          • base_discount_invoiced - optional; type string
          • base_discount_refunded - optional; type string
          • base_shipping_canceled - optional; type string
          • base_shipping_invoiced - optional; type string
          • base_shipping_refunded - optional; type string
          • base_shipping_tax_amount - optional; type string
          • base_shipping_tax_refunded - optional; type string
          • base_subtotal_canceled - optional; type string
          • base_subtotal_invoiced - optional; type string
          • base_subtotal_refunded - optional; type string
          • base_tax_canceled - optional; type string
          • base_tax_invoiced - optional; type string
          • base_tax_refunded - optional; type string
          • base_total_invoiced_cost - optional; type string
          • discount_canceled - optional; type string
          • discount_invoiced - optional; type string
          • discount_refunded - optional; type string
          • shipping_canceled - optional; type string
          • shipping_invoiced - optional; type string
          • shipping_refunded - optional; type string
          • shipping_tax_amount - optional; type string
          • shipping_tax_refunded - optional; type string
          • subtotal_canceled - optional; type string
          • subtotal_invoiced - optional; type string
          • subtotal_refunded - optional; type string
          • tax_canceled - optional; type string
          • tax_invoiced - optional; type string
          • tax_refunded - optional; type string
          • can_ship_partially - optional; type string
          • can_ship_partially_item - optional; type string
          • edit_increment - optional; type string
          • forced_do_shipment_with_invoice - optional; type string
          • payment_authorization_expiration - optional; type string
          • paypal_ipn_customer_notified - optional; type string
          • quote_address_id - optional; type string
          • adjustment_negative - optional; type string
          • adjustment_positive - optional; type string
          • base_adjustment_negative - optional; type string
          • base_adjustment_positive - optional; type string
          • base_shipping_discount_amount - optional; type string
          • base_subtotal_incl_tax - optional; type string
          • base_total_due - optional; type string
          • payment_authorization_amount - optional; type string
          • shipping_discount_amount - optional; type string
          • subtotal_incl_tax - optional; type string
          • total_due - optional; type string
          • customer_dob - optional; type string
          • customer_middlename - optional; type string
          • customer_prefix - optional; type string
          • customer_suffix - optional; type string
          • customer_taxvat - optional; type string
          • discount_description - optional; type string
          • ext_customer_id - optional; type string
          • ext_order_id - optional; type string
          • hold_before_state - optional; type string
          • hold_before_status - optional; type string
          • original_increment_id - optional; type string
          • relation_child_id - optional; type string
          • relation_child_real_id - optional; type string
          • relation_parent_id - optional; type string
          • relation_parent_real_id - optional; type string
          • x_forwarded_for - optional; type string
          • customer_note - optional; type string
          • total_item_count - optional; type string
          • customer_gender - optional; type string
          • hidden_tax_amount - optional; type string
          • base_hidden_tax_amount - optional; type string
          • shipping_hidden_tax_amount - optional; type string
          • base_shipping_hidden_tax_amount - optional; type string
          • hidden_tax_invoiced - optional; type string
          • base_hidden_tax_invoiced - optional; type string
          • hidden_tax_refunded - optional; type string
          • base_hidden_tax_refunded - optional; type string
          • shipping_incl_tax - optional; type string
          • base_shipping_incl_tax - optional; type string
          • base_customer_balance_amount - optional; type string
          • customer_balance_amount - optional; type string
          • base_customer_balance_invoiced - optional; type string
          • customer_balance_invoiced - optional; type string
          • base_customer_balance_refunded - optional; type string
          • customer_balance_refunded - optional; type string
          • base_customer_balance_total_refunded - optional; type string
          • customer_balance_total_refunded - optional; type string
          • gift_cards - optional; type string
          • base_gift_cards_amount - optional; type string
          • gift_cards_amount - optional; type string
          • base_gift_cards_invoiced - optional; type string
          • gift_cards_invoiced - optional; type string
          • base_gift_cards_refunded - optional; type string
          • gift_cards_refunded - optional; type string
          • reward_points_balance - optional; type string
          • base_reward_currency_amount - optional; type string
          • reward_currency_amount - optional; type string
          • base_reward_currency_amount_invoiced - optional; type string
          • reward_currency_amount_invoiced - optional; type string
          • base_reward_currency_amount_refunded - optional; type string
          • reward_currency_amount_refunded - optional; type string
          • reward_points_balance_refunded - optional; type string
          • reward_points_balance_to_refund - optional; type string
          • reward_salesrule_points - optional; type string
          • firstname - optional; type string
          • lastname - optional; type string
          • telephone - optional; type string
          • postcode - optional; type string
    120. salesOrderShipmentAddComment
      Description:
      Add new comment to shipment
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderShipmentAddCommentRequest (soap:body, use = literal)Source code
      parameters type salesOrderShipmentAddCommentRequestParam
      • sessionId type string
      • shipmentIncrementId type string
      • comment - optional; type string
      • email type string
      • includeInEmail type string
      Output:
      salesOrderShipmentAddCommentResponse (soap:body, use = literal)Source code
      parameters type salesOrderShipmentAddCommentResponseParam
      • result type int
    121. salesOrderShipmentAddTrack
      Description:
      Add new tracking number
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderShipmentAddTrackRequest (soap:body, use = literal)Source code
      parameters type salesOrderShipmentAddTrackRequestParam
      • sessionId type string
      • shipmentIncrementId type string
      • carrier type string
      • title type string
      • trackNumber type string
      Output:
      salesOrderShipmentAddTrackResponse (soap:body, use = literal)Source code
      parameters type salesOrderShipmentAddTrackResponseParam
      • result type int
    122. salesOrderShipmentCreate
      Description:
      Create new shipment for order
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderShipmentCreateRequest (soap:body, use = literal)Source code
      parameters type salesOrderShipmentCreateRequestParam
      • sessionId type string
      • orderIncrementId type string
      • itemsQty type orderItemIdQtyArray
        • complexObjectArray - optional, unbounded; type orderItemIdQty
          • order_item_id type int
          • qty type double
      • comment - optional; type string
      • email type int
      • includeComment type int
      Output:
      salesOrderShipmentCreateResponse (soap:body, use = literal)Source code
      parameters type salesOrderShipmentCreateResponseParam
      • result type string
    123. salesOrderShipmentGetCarriers
      Description:
      Retrieve list of allowed carriers for order
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderShipmentGetCarriersRequest (soap:body, use = literal)Source code
      parameters type salesOrderShipmentGetCarriersRequestParam
      • sessionId type string
      • orderIncrementId type string
      Output:
      salesOrderShipmentGetCarriersResponse (soap:body, use = literal)Source code
      parameters type salesOrderShipmentGetCarriersResponseParam
      • result type associativeArray
        • complexObjectArray - optional, unbounded; type associativeEntity
          • key type string
          • value type string
    124. salesOrderShipmentInfo
      Description:
      Retrieve shipment information
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderShipmentInfoRequest (soap:body, use = literal)Source code
      parameters type salesOrderShipmentInfoRequestParam
      • sessionId type string
      • shipmentIncrementId type string
      Output:
      salesOrderShipmentInfoResponse (soap:body, use = literal)Source code
      parameters type salesOrderShipmentInfoResponseParam
      • result type salesOrderShipmentEntity
        • increment_id - optional; type string
        • parent_id - optional; type string
        • store_id - optional; type string
        • created_at - optional; type string
        • updated_at - optional; type string
        • is_active - optional; type string
        • shipping_address_id - optional; type string
        • shipping_firstname - optional; type string
        • shipping_lastname - optional; type string
        • order_id - optional; type string
        • order_increment_id - optional; type string
        • order_created_at - optional; type string
        • total_qty - optional; type string
        • shipment_id - optional; type string
        • items - optional; type salesOrderShipmentItemEntityArray
          • complexObjectArray - optional, unbounded; type salesOrderShipmentItemEntity
            • increment_id - optional; type string
            • parent_id - optional; type string
            • created_at - optional; type string
            • updated_at - optional; type string
            • is_active - optional; type string
            • sku - optional; type string
            • name - optional; type string
            • order_item_id - optional; type string
            • product_id - optional; type string
            • weight - optional; type string
            • price - optional; type string
            • qty - optional; type string
            • item_id - optional; type string
        • tracks - optional; type salesOrderShipmentTrackEntityArray
          • complexObjectArray - optional, unbounded; type salesOrderShipmentTrackEntity
            • increment_id - optional; type string
            • parent_id - optional; type string
            • created_at - optional; type string
            • updated_at - optional; type string
            • is_active - optional; type string
            • carrier_code - optional; type string
            • title - optional; type string
            • number - optional; type string
            • order_id - optional; type string
            • track_id - optional; type string
        • comments - optional; type salesOrderShipmentCommentEntityArray
          • complexObjectArray - optional, unbounded; type salesOrderShipmentCommentEntity
            • increment_id - optional; type string
            • parent_id - optional; type string
            • created_at - optional; type string
            • updated_at - optional; type string
            • is_active - optional; type string
            • comment - optional; type string
            • is_customer_notified - optional; type string
            • comment_id - optional; type string
    125. salesOrderShipmentList
      Description:
      Retrieve list of shipments by filters
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderShipmentListRequest (soap:body, use = literal)Source code
      parameters type salesOrderShipmentListRequestParam
      • sessionId type string
      • filters - optional; type filters
        • filter - optional; type associativeArray
          • complexObjectArray - optional, unbounded; type associativeEntity
            • key type string
            • value type string
        • complex_filter - optional; type complexFilterArray
          • complexObjectArray - optional, unbounded; type complexFilter
            • key type string
            • value type associativeEntity
              • key type string
              • value type string
      Output:
      salesOrderShipmentListResponse (soap:body, use = literal)Source code
      parameters type salesOrderShipmentListResponseParam
      • result type salesOrderShipmentEntityArray
        • complexObjectArray - optional, unbounded; type salesOrderShipmentEntity
          • increment_id - optional; type string
          • parent_id - optional; type string
          • store_id - optional; type string
          • created_at - optional; type string
          • updated_at - optional; type string
          • is_active - optional; type string
          • shipping_address_id - optional; type string
          • shipping_firstname - optional; type string
          • shipping_lastname - optional; type string
          • order_id - optional; type string
          • order_increment_id - optional; type string
          • order_created_at - optional; type string
          • total_qty - optional; type string
          • shipment_id - optional; type string
          • items - optional; type salesOrderShipmentItemEntityArray
            • complexObjectArray - optional, unbounded; type salesOrderShipmentItemEntity
              • increment_id - optional; type string
              • parent_id - optional; type string
              • created_at - optional; type string
              • updated_at - optional; type string
              • is_active - optional; type string
              • sku - optional; type string
              • name - optional; type string
              • order_item_id - optional; type string
              • product_id - optional; type string
              • weight - optional; type string
              • price - optional; type string
              • qty - optional; type string
              • item_id - optional; type string
          • tracks - optional; type salesOrderShipmentTrackEntityArray
            • complexObjectArray - optional, unbounded; type salesOrderShipmentTrackEntity
              • increment_id - optional; type string
              • parent_id - optional; type string
              • created_at - optional; type string
              • updated_at - optional; type string
              • is_active - optional; type string
              • carrier_code - optional; type string
              • title - optional; type string
              • number - optional; type string
              • order_id - optional; type string
              • track_id - optional; type string
          • comments - optional; type salesOrderShipmentCommentEntityArray
            • complexObjectArray - optional, unbounded; type salesOrderShipmentCommentEntity
              • increment_id - optional; type string
              • parent_id - optional; type string
              • created_at - optional; type string
              • updated_at - optional; type string
              • is_active - optional; type string
              • comment - optional; type string
              • is_customer_notified - optional; type string
              • comment_id - optional; type string
    126. salesOrderShipmentRemoveTrack
      Description:
      Remove tracking number
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderShipmentRemoveTrackRequest (soap:body, use = literal)Source code
      parameters type salesOrderShipmentRemoveTrackRequestParam
      • sessionId type string
      • shipmentIncrementId type string
      • trackId type string
      Output:
      salesOrderShipmentRemoveTrackResponse (soap:body, use = literal)Source code
      parameters type salesOrderShipmentRemoveTrackResponseParam
      • result type int
    127. salesOrderShipmentSendInfo
      Description:
      Send shipment info
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderShipmentSendInfoRequest (soap:body, use = literal)Source code
      parameters type salesOrderShipmentSendInfoRequestParam
      • sessionId type string
      • shipmentIncrementId type string
      • comment - optional; type string
      Output:
      salesOrderShipmentSendInfoResponse (soap:body, use = literal)Source code
      parameters type salesOrderShipmentSendInfoResponseParam
      • result type int
    128. salesOrderUnhold
      Description:
      Unhold order
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      salesOrderUnholdRequest (soap:body, use = literal)Source code
      parameters type salesOrderUnholdRequestParam
      • sessionId type string
      • orderIncrementId type string
      Output:
      salesOrderUnholdResponse (soap:body, use = literal)Source code
      parameters type salesOrderUnholdResponseParam
      • result type int
    129. shoppingCartCouponAdd
      Description:
      Add coupon code for shopping cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartCouponAddRequest (soap:body, use = literal)Source code
      parameters type shoppingCartCouponAddRequestParam
      • sessionId type string
      • quoteId type int
      • couponCode type string
      • store - optional; type string
      Output:
      shoppingCartCouponAddResponse (soap:body, use = literal)Source code
      parameters type shoppingCartCouponAddResponseParam
      • result type boolean
    130. shoppingCartCouponRemove
      Description:
      Remove coupon code from shopping cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartCouponRemoveRequest (soap:body, use = literal)Source code
      parameters type shoppingCartCouponRemoveRequestParam
      • sessionId type string
      • quoteId type int
      • store - optional; type string
      Output:
      shoppingCartCouponRemoveResponse (soap:body, use = literal)Source code
      parameters type shoppingCartCouponRemoveResponseParam
      • result type boolean
    131. shoppingCartCreate
      Description:
      Create shopping cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartCreateRequest (soap:body, use = literal)Source code
      parameters type shoppingCartCreateRequestParam
      • sessionId type string
      • store - optional; type string
      Output:
      shoppingCartCreateResponse (soap:body, use = literal)Source code
      parameters type shoppingCartCreateResponseParam
      • result type int
    132. shoppingCartCustomerAddresses
      Description:
      Set customer's addresses in shopping cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartCustomerAddressesRequest (soap:body, use = literal)Source code
      parameters type shoppingCartCustomerAddressesRequestParam
      • sessionId type string
      • quoteId type int
      • customerAddressData type shoppingCartCustomerAddressEntityArray
        • complexObjectArray - optional, unbounded; type shoppingCartCustomerAddressEntity
          • mode - optional; type string
          • address_id - optional; type string
          • firstname - optional; type string
          • lastname - optional; type string
          • company - optional; type string
          • street - optional; type string
          • city - optional; type string
          • region - optional; type string
          • region_id - optional; type string
          • postcode - optional; type string
          • country_id - optional; type string
          • telephone - optional; type string
          • fax - optional; type string
          • is_default_billing - optional; type int
          • is_default_shipping - optional; type int
      • store - optional; type string
      Output:
      shoppingCartCustomerAddressesResponse (soap:body, use = literal)Source code
      parameters type shoppingCartCustomerAddressesResponseParam
      • result type boolean
    133. shoppingCartCustomerSet
      Description:
      Set customer for shopping cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartCustomerSetRequest (soap:body, use = literal)Source code
      parameters type shoppingCartCustomerSetRequestParam
      • sessionId type string
      • quoteId type int
      • customerData type shoppingCartCustomerEntity
        • mode - optional; type string
        • customer_id - optional; type int
        • email - optional; type string
        • firstname - optional; type string
        • lastname - optional; type string
        • password - optional; type string
        • confirmation - optional; type string
        • website_id - optional; type int
        • store_id - optional; type int
        • group_id - optional; type int
      • store - optional; type string
      Output:
      shoppingCartCustomerSetResponse (soap:body, use = literal)Source code
      parameters type shoppingCartCustomerSetResponseParam
      • result type boolean
    134. shoppingCartInfo
      Description:
      Retrieve information about shopping cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartInfoRequest (soap:body, use = literal)Source code
      parameters type shoppingCartInfoRequestParam
      • sessionId type string
      • quoteId type int
      • store - optional; type string
      Output:
      shoppingCartInfoResponse (soap:body, use = literal)Source code
      parameters type shoppingCartInfoResponseParam
      • result type shoppingCartInfoEntity
        • store_id - optional; type string
        • created_at - optional; type string
        • updated_at - optional; type string
        • converted_at - optional; type string
        • quote_id - optional; type int
        • is_active - optional; type int
        • is_virtual - optional; type int
        • is_multi_shipping - optional; type int
        • items_count - optional; type double
        • items_qty - optional; type double
        • orig_order_id - optional; type string
        • store_to_base_rate - optional; type string
        • store_to_quote_rate - optional; type string
        • base_currency_code - optional; type string
        • store_currency_code - optional; type string
        • quote_currency_code - optional; type string
        • grand_total - optional; type string
        • base_grand_total - optional; type string
        • checkout_method - optional; type string
        • customer_id - optional; type string
        • customer_tax_class_id - optional; type string
        • customer_group_id - optional; type int
        • customer_email - optional; type string
        • customer_prefix - optional; type string
        • customer_firstname - optional; type string
        • customer_middlename - optional; type string
        • customer_lastname - optional; type string
        • customer_suffix - optional; type string
        • customer_note - optional; type string
        • customer_note_notify - optional; type string
        • customer_is_guest - optional; type string
        • applied_rule_ids - optional; type string
        • reserved_order_id - optional; type string
        • password_hash - optional; type string
        • coupon_code - optional; type string
        • global_currency_code - optional; type string
        • base_to_global_rate - optional; type double
        • base_to_quote_rate - optional; type double
        • customer_taxvat - optional; type string
        • customer_gender - optional; type string
        • subtotal - optional; type double
        • base_subtotal - optional; type double
        • subtotal_with_discount - optional; type double
        • base_subtotal_with_discount - optional; type double
        • ext_shipping_info - optional; type string
        • gift_message_id - optional; type string
        • gift_message - optional; type string
        • customer_balance_amount_used - optional; type double
        • base_customer_balance_amount_used - optional; type double
        • use_customer_balance - optional; type string
        • gift_cards_amount - optional; type string
        • base_gift_cards_amount - optional; type string
        • gift_cards_amount_used - optional; type string
        • use_reward_points - optional; type string
        • reward_points_balance - optional; type string
        • base_reward_currency_amount - optional; type string
        • reward_currency_amount - optional; type string
        • shipping_address - optional; type shoppingCartAddressEntity
          • address_id - optional; type string
          • created_at - optional; type string
          • updated_at - optional; type string
          • customer_id - optional; type string
          • save_in_address_book - optional; type int
          • customer_address_id - optional; type string
          • address_type - optional; type string
          • email - optional; type string
          • prefix - optional; type string
          • firstname - optional; type string
          • middlename - optional; type string
          • lastname - optional; type string
          • suffix - optional; type string
          • company - optional; type string
          • street - optional; type string
          • city - optional; type string
          • region - optional; type string
          • region_id - optional; type string
          • postcode - optional; type string
          • country_id - optional; type string
          • telephone - optional; type string
          • fax - optional; type string
          • same_as_billing - optional; type int
          • free_shipping - optional; type int
          • shipping_method - optional; type string
          • shipping_description - optional; type string
          • weight - optional; type double
        • billing_address - optional; type shoppingCartAddressEntity
          • address_id - optional; type string
          • created_at - optional; type string
          • updated_at - optional; type string
          • customer_id - optional; type string
          • save_in_address_book - optional; type int
          • customer_address_id - optional; type string
          • address_type - optional; type string
          • email - optional; type string
          • prefix - optional; type string
          • firstname - optional; type string
          • middlename - optional; type string
          • lastname - optional; type string
          • suffix - optional; type string
          • company - optional; type string
          • street - optional; type string
          • city - optional; type string
          • region - optional; type string
          • region_id - optional; type string
          • postcode - optional; type string
          • country_id - optional; type string
          • telephone - optional; type string
          • fax - optional; type string
          • same_as_billing - optional; type int
          • free_shipping - optional; type int
          • shipping_method - optional; type string
          • shipping_description - optional; type string
          • weight - optional; type double
        • items - optional; type shoppingCartItemEntityArray
          • complexObjectArray - optional, unbounded; type shoppingCartItemEntity
            • item_id - optional; type string
            • created_at - optional; type string
            • updated_at - optional; type string
            • product_id - optional; type string
            • store_id - optional; type string
            • parent_item_id - optional; type string
            • is_virtual - optional; type int
            • sku - optional; type string
            • name - optional; type string
            • description - optional; type string
            • applied_rule_ids - optional; type string
            • additional_data - optional; type string
            • free_shipping - optional; type string
            • is_qty_decimal - optional; type string
            • no_discount - optional; type string
            • weight - optional; type double
            • qty - optional; type double
            • price - optional; type double
            • base_price - optional; type double
            • custom_price - optional; type double
            • discount_percent - optional; type double
            • discount_amount - optional; type double
            • base_discount_amount - optional; type double
            • tax_percent - optional; type double
            • tax_amount - optional; type double
            • base_tax_amount - optional; type double
            • row_total - optional; type double
            • base_row_total - optional; type double
            • row_total_with_discount - optional; type double
            • row_weight - optional; type double
            • product_type - optional; type string
            • base_tax_before_discount - optional; type double
            • tax_before_discount - optional; type double
            • original_custom_price - optional; type double
            • base_cost - optional; type double
            • price_incl_tax - optional; type double
            • base_price_incl_tax - optional; type double
            • row_total_incl_tax - optional; type double
            • base_row_total_incl_tax - optional; type double
            • gift_message_id - optional; type string
            • gift_message - optional; type string
            • gift_message_available - optional; type string
            • weee_tax_applied - optional; type double
            • weee_tax_applied_amount - optional; type double
            • weee_tax_applied_row_amount - optional; type double
            • base_weee_tax_applied_amount - optional; type double
            • base_weee_tax_applied_row_amount - optional; type double
            • weee_tax_disposition - optional; type double
            • weee_tax_row_disposition - optional; type double
            • base_weee_tax_disposition - optional; type double
            • base_weee_tax_row_disposition - optional; type double
            • tax_class_id - optional; type string
        • payment - optional; type shoppingCartPaymentEntity
          • payment_id - optional; type string
          • created_at - optional; type string
          • updated_at - optional; type string
          • method - optional; type string
          • cc_type - optional; type string
          • cc_number_enc - optional; type string
          • cc_last4 - optional; type string
          • cc_cid_enc - optional; type string
          • cc_owner - optional; type string
          • cc_exp_month - optional; type string
          • cc_exp_year - optional; type string
          • cc_ss_owner - optional; type string
          • cc_ss_start_month - optional; type string
          • cc_ss_start_year - optional; type string
          • cc_ss_issue - optional; type string
          • po_number - optional; type string
          • additional_data - optional; type string
          • additional_information - optional; type string
    135. shoppingCartLicense
      Description:
      Get terms and conditions
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartLicenseRequest (soap:body, use = literal)Source code
      parameters type shoppingCartLicenseRequestParam
      • sessionId type string
      • quoteId type int
      • store - optional; type string
      Output:
      shoppingCartLicenseResponse (soap:body, use = literal)Source code
      parameters type shoppingCartLicenseResponseParam
      • result type shoppingCartLicenseEntityArray
        • complexObjectArray - optional, unbounded; type shoppingCartLicenseEntity
          • agreement_id - optional; type string
          • name - optional; type string
          • content - optional; type string
          • is_active - optional; type int
          • is_html - optional; type int
    136. shoppingCartOrder
      Description:
      Create an order from shopping cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartOrderRequest (soap:body, use = literal)Source code
      parameters type shoppingCartOrderRequestParam
      • sessionId type string
      • quoteId type int
      • store - optional; type string
      • agreements - optional; type ArrayOfString
        • complexObjectArray - optional, unbounded; type string
      Output:
      shoppingCartOrderResponse (soap:body, use = literal)Source code
      parameters type shoppingCartOrderResponseParam
      • result type string
    137. shoppingCartPaymentList
      Description:
      Get list of available payment methods
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartPaymentListRequest (soap:body, use = literal)Source code
      parameters type shoppingCartPaymentListRequestParam
      • sessionId type string
      • quoteId type int
      • store - optional; type string
      Output:
      shoppingCartPaymentListResponse (soap:body, use = literal)Source code
      parameters type shoppingCartPaymentListResponseParam
      • result type shoppingCartPaymentMethodResponseEntityArray
        • complexObjectArray - optional, unbounded; type shoppingCartPaymentMethodResponseEntity
          • code type string
          • title type string
          • cc_types type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
    138. shoppingCartPaymentMethod
      Description:
      Set payment method
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartPaymentMethodRequest (soap:body, use = literal)Source code
      parameters type shoppingCartPaymentMethodRequestParam
      • sessionId type string
      • quoteId type int
      • paymentData type shoppingCartPaymentMethodEntity
        • po_number - optional; type string
        • method - optional; type string
        • cc_cid - optional; type string
        • cc_owner - optional; type string
        • cc_number - optional; type string
        • cc_type - optional; type string
        • cc_exp_year - optional; type string
        • cc_exp_month - optional; type string
      • store - optional; type string
      Output:
      shoppingCartPaymentMethodResponse (soap:body, use = literal)Source code
      parameters type shoppingCartPaymentMethodResponseParam
      • result type boolean
    139. shoppingCartProductAdd
      Description:
      Add product(s) to shopping cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartProductAddRequest (soap:body, use = literal)Source code
      parameters type shoppingCartProductAddRequestParam
      • sessionId type string
      • quoteId type int
      • productsData type shoppingCartProductEntityArray
        • complexObjectArray - optional, unbounded; type shoppingCartProductEntity
          • product_id - optional; type string
          • sku - optional; type string
          • qty - optional; type double
          • options - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • bundle_option - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • bundle_option_qty - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • links - optional; type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
      • store - optional; type string
      Output:
      shoppingCartProductAddResponse (soap:body, use = literal)Source code
      parameters type shoppingCartProductAddResponseParam
      • result type boolean
    140. shoppingCartProductList
      Description:
      Get list of products in shopping cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartProductListRequest (soap:body, use = literal)Source code
      parameters type shoppingCartProductListRequestParam
      • sessionId type string
      • quoteId type int
      • store - optional; type string
      Output:
      shoppingCartProductListResponse (soap:body, use = literal)Source code
      parameters type shoppingCartProductListResponseParam
      • result type shoppingCartProductResponseEntityArray
        • complexObjectArray - optional, unbounded; type catalogProductEntity
          • product_id type string
          • sku type string
          • name type string
          • set type string
          • type type string
          • category_ids type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
          • website_ids type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
    141. shoppingCartProductMoveToCustomerQuote
      Description:
      Move product(s) to customer quote
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartProductMoveToCustomerQuoteRequest (soap:body, use = literal)Source code
      parameters type shoppingCartProductMoveToCustomerQuoteRequestParam
      • sessionId type string
      • quoteId type int
      • productsData type shoppingCartProductEntityArray
        • complexObjectArray - optional, unbounded; type shoppingCartProductEntity
          • product_id - optional; type string
          • sku - optional; type string
          • qty - optional; type double
          • options - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • bundle_option - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • bundle_option_qty - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • links - optional; type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
      • store - optional; type string
      Output:
      shoppingCartProductMoveToCustomerQuoteResponse (soap:body, use = literal)Source code
      parameters type shoppingCartProductMoveToCustomerQuoteResponseParam
      • result type boolean
    142. shoppingCartProductRemove
      Description:
      Remove product(s) from shopping cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartProductRemoveRequest (soap:body, use = literal)Source code
      parameters type shoppingCartProductRemoveRequestParam
      • sessionId type string
      • quoteId type int
      • productsData type shoppingCartProductEntityArray
        • complexObjectArray - optional, unbounded; type shoppingCartProductEntity
          • product_id - optional; type string
          • sku - optional; type string
          • qty - optional; type double
          • options - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • bundle_option - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • bundle_option_qty - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • links - optional; type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
      • store - optional; type string
      Output:
      shoppingCartProductRemoveResponse (soap:body, use = literal)Source code
      parameters type shoppingCartProductRemoveResponseParam
      • result type boolean
    143. shoppingCartProductUpdate
      Description:
      Update product(s) quantities in shopping cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartProductUpdateRequest (soap:body, use = literal)Source code
      parameters type shoppingCartProductUpdateRequestParam
      • sessionId type string
      • quoteId type int
      • productsData type shoppingCartProductEntityArray
        • complexObjectArray - optional, unbounded; type shoppingCartProductEntity
          • product_id - optional; type string
          • sku - optional; type string
          • qty - optional; type double
          • options - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • bundle_option - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • bundle_option_qty - optional; type associativeArray
            • complexObjectArray - optional, unbounded; type associativeEntity
              • key type string
              • value type string
          • links - optional; type ArrayOfString
            • complexObjectArray - optional, unbounded; type string
      • store - optional; type string
      Output:
      shoppingCartProductUpdateResponse (soap:body, use = literal)Source code
      parameters type shoppingCartProductUpdateResponseParam
      • result type boolean
    144. shoppingCartShippingList
      Description:
      Get list of available shipping methods
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartShippingListRequest (soap:body, use = literal)Source code
      parameters type shoppingCartShippingListRequestParam
      • sessionId type string
      • quoteId type int
      • store - optional; type string
      Output:
      shoppingCartShippingListResponse (soap:body, use = literal)Source code
      parameters type shoppingCartShippingListResponseParam
      • result type shoppingCartShippingMethodEntityArray
        • complexObjectArray - optional, unbounded; type shoppingCartShippingMethodEntity
          • code - optional; type string
          • carrier - optional; type string
          • carrier_title - optional; type string
          • method - optional; type string
          • method_title - optional; type string
          • method_description - optional; type string
          • price - optional; type double
    145. shoppingCartShippingMethod
      Description:
      Set shipping method
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartShippingMethodRequest (soap:body, use = literal)Source code
      parameters type shoppingCartShippingMethodRequestParam
      • sessionId type string
      • quoteId type int
      • shippingMethod type string
      • store - optional; type string
      Output:
      shoppingCartShippingMethodResponse (soap:body, use = literal)Source code
      parameters type shoppingCartShippingMethodResponseParam
      • result type boolean
    146. shoppingCartTotals
      Description:
      Get total prices for shopping cart
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      shoppingCartTotalsRequest (soap:body, use = literal)Source code
      parameters type shoppingCartTotalsRequestParam
      • sessionId type string
      • quoteId type int
      • store - optional; type string
      Output:
      shoppingCartTotalsResponse (soap:body, use = literal)Source code
      parameters type shoppingCartTotalsResponseParam
      • result type shoppingCartTotalsEntityArray
        • complexObjectArray - optional, unbounded; type shoppingCartTotalsEntity
          • title - optional; type string
          • amount - optional; type double
    147. startSession
      Description:
      Start web service session
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      startSession (soap:body, use = literal)Source code
      Output:
      startSessionResponse (soap:body, use = literal)Source code
      parameters type startSessionResponseParam
      • result type string
    148. storeInfo
      Description:
      Store view info
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      storeInfoRequest (soap:body, use = literal)Source code
      parameters type storeInfoRequestParam
      • sessionId type string
      • storeId type string
      Output:
      storeInfoResponse (soap:body, use = literal)Source code
      parameters type storeInfoResponseParam
      • result type storeEntity
        • store_id type int
        • code type string
        • website_id type int
        • group_id type int
        • name type string
        • sort_order type int
        • is_active type int
    149. storeList
      Description:
      List of stores
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      Input:
      storeListRequest (soap:body, use = literal)Source code
      parameters type storeListRequestParam
      • sessionId type string
      Output:
      storeListResponse (soap:body, use = literal)Source code
      parameters type storeListResponseParam
      • result type storeEntityArray
        • complexObjectArray - optional, unbounded; type storeEntity
          • store_id type int
          • code type string
          • website_id type int
          • group_id type int
          • name type string
          • sort_order type int
          • is_active type int

WSDL source code

<?xml version="1.0"?>
<wsdl:definitions name="Magento" targetNamespace="urn:Magento"
xmlns:typens="urn:Magento"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
>
<wsdl:types>
<xsd:schema targetNamespace="urn:Magento">
<xsd:complexType name="catalogProductReturnEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="catalogProductCreateEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="catalogCategoryInfo">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="catalogProductAttributeEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="salesOrderEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="salesOrderListEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="salesOrderItemEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="salesOrderInvoiceEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="salesOrderInvoiceItemEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="salesOrderCreditmemoEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="salesOrderCreditmemoItemEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="shoppingCartAddressEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="shoppingCartItemEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="shoppingCartInfoEntity">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
</xsd:schema>
</wsdl:types>
<wsdl:portType name="PortType"></wsdl:portType>
<wsdl:binding name="Binding" type="typens:PortType"></wsdl:binding>
</wsdl:definitions>

About wsdl-viewer.xsl

This document was generated by SAXON 9.1.0.8 from Saxonica XSLT engine. The engine processed the WSDL in XSLT 2.0 compliant mode.
This page has been generated bywsdl-viewer.xsl, version 3.1.02
Author: tomi vanek
Download athttp://tomi.vanek.sk/xml/wsdl-viewer.xsl.

The transformation was inspired by the article
Uche Ogbuji: WSDL processing with XSLT