Magento wsdl. Looking for a guide

Magento wsdl. Looking for a guide

August 11, 2026 · Illustrated author avatarBy Stefan Bogdanescu
Magento wsdl. Looking for a guide

A Comprehensive Guide to Magento API WSDL for Beginners

Hello developers! If you’re new to working with Magento APIs and looking for guidance on creating a WSDL (Web Services Description Language) file for your custom module, you’ve come to the right place.

Understanding Magento API WSDL Basics

In Magento, WSDL is used to describe the services available through web services. It provides information about the operations that can be performed, the data types of parameters and responses, and how to interact with these services using SOAP (Simple Object Access Protocol).

The key thing to understand is that Magento uses multiple WSDL files for different versions of its API:

  • v1_soap.xml: For Magento 1.x
  • v2_soap.xml or SOAP v2.0: For Magento 2.x

Creating Your Custom Module’s WSDL File

Step 1: Define the WSDL XML Structure

The WSDL file is an XML document that follows a specific structure defined by SOAP standards. Here’s a basic example of what your custom module’s v2_soap.xml might look like:

<definitions name="MyCustomModule" targetNamespace="http://example.com/mymodule/v1_0">
    <types>
        <xsd:schema>
            <!-- Your custom data types go here -->
        </xsd:schema>
    </types>
    <message name="MyServiceSoapRequestMessage">
        <!-- Request elements -->
    </message>
    <message name="MyServiceSoapResponseMessage">
        <!-- Response elements -->
    </message>
    <portType name="MyCustomModulePort" class="MyVendor\MyModule\Api\MyServiceInterface">
        <operation name="myMethod">
            <input message="tns:MyServiceSoapRequestMessage"/>
            <output message="tns:MyServiceSoapResponseMessage"/>
        </operation>
    </portType>
</definitions>

Step 2: Connecting Your WSDL to the API

To ensure Magento uses your custom module’s WSDL when accessing v2_soap.xml, you need to configure your service interface correctly. In your di.xml configuration file:

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
    <type name="MyVendor\MyModule\Api\MyServiceInterface">
        <arguments>
            <argument name="serviceInstance" xsi:type="object">MyVendor\MyModule\Model\MyService</argument>
        </arguments>
    </type>
</config>

Step 3: Testing Your Custom WSDL

Once you’ve created your v2_soap.xml file and configured your service interface, you can test it using a tool like SOAP UI or even directly in a web browser.

Visit http://your-magento-site.com/index.php/soap/?wsdl=1 to see the active WSDL for your Magento installation.

Tips from Laravel Company

At Laravel Company, we’ve found that keeping your custom API services well-organized is key. Make sure your data types match your database schema and use meaningful names for your operations and messages.

Remember, the Magento SOAP API uses a complex structure to provide extensive functionality. Don’t hesitate to refer to the official Magento 2 Developer Documentation for more detailed insights.

Keep practicing, and you’ll soon be an expert in extending Magento’s web services capabilities with your own custom WSDL!

Happy coding!

Magento 2 Magento 1 API Extensions

Our network