Magento 2: How to Get Estimated Shipping Methods using REST API?

Hello Magento Friends,

Today I came up with a new Magento solution for you all. It is about How to Get Estimated Shipping Methods using REST API in Magento 2.

Admin can configure multiple shipping methods in Magento 2 to provide a better user experience to customers.

Magento 2 provides default shipping methods like 

• Flat Rate
• Free Shipping
• Table Rates
• UPS
• USPS
• FedEx
• DHL

Among the above list, flat rate shipping is the most popular one. However, you can only create one flat rate shipping method in default Magento 2. Multiple Flat Rate Shipping Extension will help you configure more than one flat rate shipping. 

If you do not want to use default shipping methods, you can even Create Custom Shipping Method in Magento 2.

You can get the shipping methods using the REST API in Magento 2. Let’s look at the steps

Steps to Get Estimated Shipping Methods using REST API in Magento 2:

Step 1: Create the rootscript.php script file and add the below code

<?php
 
$baseUrl = " http://yourdomain/"; // your magento base url
//Customer Email id and Password set
 
$userData = array("username" => "test@gmail.com", "password" => "test@123");
 
$ch = curl_init($baseUrl."/rest/V1/integration/customer/token");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($userData));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Content-Type: application/json", "Content-Lenght: " . strlen(json_encode($userData))));
 
$token = curl_exec($ch);
 
$shippingData = array("address" => 
  array("city" => "THOUSAND OAKS",
        "company" => "Test Company",
        "country_id" => "US", 
        "customer_id" => 0,
        "firstname"=>"Michael S",
        "id"=> 8,
        "lastname"=> "Yarbrough",
        "postcode" => "91358",
        "region_code"=> "CA",
        "region"=> "California", 
        "region_id"=> 12, 
        "street" => ["721 Hall Street"],
        "telephone" => "159634877"));

$ch = curl_init($baseUrl."/rest/V1/carts/mine/estimate-shipping-methods");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($shippingData));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Content-Type: application/json", "Authorization: Bearer " . json_decode($token)));
 
$result = curl_exec($ch);
$result = json_decode($result, 1);
 
echo '<pre>';
 
print_r($result);
 
echo '</pre>';
 
?>

After successfully implementing the above step, it will return the shipping methods in array as follows.

Conclusion:

This way you can Get Estimated Shipping Methods using REST API in Magento 2. Alternatively, Get Shipment Information using SOAP API in Magento 2. If you face any hardships with the above code snippet, you can ask me through the comment part. Share the solution with your contacts. See you with the next Magento solution.

Happy Coding!