This is a beta release of documentation for Magento 2.4, published for previewing soon-to-be-released functionality. Content in this version is subject to change. Links to the v2.4 code base may not properly resolve until the code is officially released.

SOAP Reference

Soap WSDL Endpoint Format

http://<magento_host>/soap/<store_code>?wsdl&services=<serviceName1,serviceName2,..>

The value of store_code can be one of the following:

  • default
  • The assigned store code
  • all. This value only applies to the CMS and Product modules. If this value is specified, the API call affects all the merchant’s stores.

List of Service Names per Module

The entire list can be retrieved here: http://<magento_host>/soap/default?wsdl_list=1

Magento Commerce Web APIs Services per Module

The Web APIs for Magento Commerce (formerly Magento Enterprise Edition) are available on Magento Commerce installations only. Magento Commerce installations automatically have access to all Magento Open Source (formerly Magento Community Edition) web APIs.

CustomerBalance

1
customerBalanceBalanceManagementV1

GiftCardAccount

1
2
3
4
giftCardAccountGiftCardAccountManagementV1
giftCardAccountGuestGiftCardAccountManagementV1
giftRegistryGuestCartShippingMethodManagementV1
giftRegistryShippingMethodManagementV1

GiftWrapping

1
giftWrappingWrappingRepositoryV1

Reward

1
rewardRewardManagementV1

RMA

1
2
3
4
5
rmaCommentManagementV1
rmaRmaAttributesManagementV1
rmaRmaManagementV1
rmaRmaRepositoryV1
rmaTrackManagementV1

Worldpay

1
worldpayGuestPaymentInformationManagementProxyV1

Magento Open Source Web APIs Services per Module

The Magento Open Source Web APIs are available on all installations.

Analytics

1
analyticsLinkProviderV1

AsynchronousOperations

1
asynchronousOperationsOperationRepositoryV1

Backend

1
backendModuleServiceV1

Bundle

1
2
3
4
bundleProductLinkManagementV1
bundleProductOptionManagementV1
bundleProductOptionRepositoryV1
bundleProductOptionTypeListV1

Catalog

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
catalogAttributeSetManagementV1
catalogAttributeSetRepositoryV1
catalogBasePriceStorageV1 *
catalogCategoryAttributeOptionManagementV1
catalogCategoryAttributeRepositoryV1
catalogCategoryLinkManagementV1
catalogCategoryLinkRepositoryV1
catalogCategoryListV1 *
catalogCategoryManagementV1
catalogCategoryRepositoryV1
catalogCostStorageV1 *
catalogProductAttributeGroupRepositoryV1
catalogProductAttributeManagementV1
catalogProductAttributeMediaGalleryManagementV1
catalogProductAttributeOptionManagementV1
catalogProductAttributeRepositoryV1
catalogProductAttributeTypesListV1
catalogProductCustomOptionRepositoryV1
catalogProductCustomOptionTypeListV1
catalogProductLinkManagementV1
catalogProductLinkRepositoryV1
catalogProductLinkTypeListV1
catalogProductMediaAttributeManagementV1
catalogProductRenderListV1 *
catalogProductRepositoryV1
catalogProductTierPriceManagementV1
catalogProductTypeListV1
catalogProductWebsiteLinkRepositoryV1
catalogSpecialPriceStorageV1 *
catalogTierPriceStorageV1 *

CatalogInventory

1
catalogInventoryStockRegistryV1

Checkout

1
2
3
4
5
6
checkoutGuestPaymentInformationManagementV1
checkoutGuestShippingInformationManagementV1
checkoutGuestTotalsInformationManagementV1
checkoutPaymentInformationManagementV1
checkoutShippingInformationManagementV1
checkoutTotalsInformationManagementV1

CheckoutAgreements

1
checkoutAgreementsCheckoutAgreementsRepositoryV1

Cms

1
2
cmsBlockRepositoryV1
cmsPageRepositoryV1

ConfigurableProduct

1
2
3
configurableProductConfigurableProductManagementV1
configurableProductLinkManagementV1
configurableProductOptionRepositoryV1

Customer

1
2
3
4
5
6
7
8
customerAccountManagementV1
customerAddressMetadataV1
customerAddressRepositoryV1
customerCustomerMetadataV1
customerCustomerRepositoryV1
customerGroupManagementV1
customerGroupRepositoryV1
customerCustomerGroupConfigV1

Directory

1
2
directoryCountryInformationAcquirerV1
directoryCurrencyInformationAcquirerV1

Downloadable

1
2
downloadableLinkRepositoryV1
downloadableSampleRepositoryV1

Eav

1
2
eavAttributeSetManagementV1
eavAttributeSetRepositoryV1

GiftMessage

1
2
3
4
giftMessageCartRepositoryV1
giftMessageGuestCartRepositoryV1
giftMessageGuestItemRepositoryV1
giftMessageItemRepositoryV1

Integration

1
2
integrationAdminTokenServiceV1
integrationCustomerTokenServiceV1

InventoryApi

1
2
3
4
5
6
7
8
9
inventoryApiSourceRepositoryV1
inventoryApiGetSourcesAssignedToStockOrderedByPriorityV1
inventoryApiStockRepositoryV1
inventoryApiGetStockSourceLinksV1
inventoryApiStockSourceLinksSaveV1
inventoryApiStockSourceLinksDeleteV1
inventoryApiSourceItemRepositoryV1
inventoryApiSourceItemsSaveV1
inventoryApiSourceItemsDeleteV1

InventoryCatalogApi

1
2
3
inventoryCatalogApiBulkSourceAssignV1
inventoryCatalogApiBulkSourceUnassignV1
inventoryCatalogApiBulkInventoryTransferV1

InventoryDistanceBasedSourceSelectionApi

1
2
3
inventoryDistanceBasedSourceSelectionApiGetDistanceProviderCodeV1
inventoryDistanceBasedSourceSelectionApiGetDistanceV1
inventoryDistanceBasedSourceSelectionApiGetLatLngFromAddressV1

InventoryLowQuantityNotificationApi

1
2
3
inventoryLowQuantityNotificationApiGetSourceItemConfigurationV1
inventoryLowQuantityNotificationApiSourceItemConfigurationsSaveV1
inventoryLowQuantityNotificationApiDeleteSourceItemsConfigurationV1

InventorySalesApi

1
2
3
4
inventorySalesApiGetProductSalabilityV1
inventorySalesApiIsProductSalableV1
inventorySalesApiIsProductSalableForRequestedQtyV1
inventorySalesApiStockResolverV1

InventorySourceSelectionApi

1
2
inventorySourceSelectionApiGetSourceSelectionAlgorithmListV1
inventorySourceSelectionApiSourceSelectionServiceV1

Quote

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
quoteBillingAddressManagementV1
quoteCartItemRepositoryV1
quoteCartManagementV1
quoteCartRepositoryV1
quoteCartTotalManagementV1
quoteCartTotalRepositoryV1
quoteCouponManagementV1
quoteGuestBillingAddressManagementV1
quoteGuestCartItemRepositoryV1
quoteGuestCartManagementV1
quoteGuestCartRepositoryV1
quoteGuestCartTotalManagementV1
quoteGuestCartTotalRepositoryV1
quoteGuestCouponManagementV1
quoteGuestPaymentMethodManagementV1
quoteGuestShipmentEstimationV1
quoteGuestShippingMethodManagementV1
quotePaymentMethodManagementV1
quoteShipmentEstimationV1
quoteShippingMethodManagementV1

Sales

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
salesCreditmemoCommentRepositoryV1
salesCreditmemoManagementV1
salesCreditmemoRepositoryV1
salesInvoiceCommentRepositoryV1
salesInvoiceManagementV1
salesInvoiceOrderV1
salesInvoiceRepositoryV1
salesOrderAddressRepositoryV1
salesOrderItemRepositoryV1
salesOrderManagementV1
salesOrderRepositoryV1
salesRefundInvoiceV1
salesRefundOrderV1
salesShipmentCommentRepositoryV1
salesShipmentManagementV1
salesShipmentRepositoryV1
salesShipmentTrackRepositoryV1
salesShipOrderV1
salesTransactionRepositoryV1

SalesRule

1
2
3
salesRuleCouponManagementV1
salesRuleCouponRepositoryV1
salesRuleRuleRepositoryV1
1
searchV1

Store

1
2
3
4
storeGroupRepositoryV1
storeStoreConfigManagerV1
storeStoreRepositoryV1
storeWebsiteRepositoryV1

Tax

1
2
3
taxTaxClassRepositoryV1
taxTaxRateRepositoryV1
taxTaxRuleRepositoryV1

Magento B2B

See Integrate with B2B using REST for a list of services provided with B2B.