Creating correct shipping option for magento orders (#453)

* Creating correct shipping option for magento orders

* change

* changes

* changes

* change

* changes

* changes

* Removing explicit exception imports

* changes

* changes

* changes

* changes

* changes

* changes

* changes

* changes

* changes

* changes

* changes

* changes

* chanmges

* changes

* a

* changes

* changes

* cahnges

* changes

---------

Co-authored-by: Paul Kang <[email protected]>

Author: danielmetaconnolly

app/code/Meta/BusinessExtension/Helper/GraphAPIAdapter.php

@@ -33,6 +33,9 @@
 use Magento\Framework\HTTP\Client\CurlFactory;
 use Magento\Framework\View\FileFactory;
 
+/**
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 class GraphAPIAdapter
 {
     private const ORDER_STATE_CREATED = 'CREATED';
@@ -580,7 +583,7 @@ public function getOrders($pageId, $cursorAfter = false, $filterType = "")
             'estimated_payment_details',
             'ship_by_date',
             'order_status',
-            'selected_shipping_option',
+            'selected_shipping_option{name, reference_id, price, calculated_tax, estimated_shipping_time}',
             'shipping_address{first_name, last_name, street1, street2, city, postal_code, country}',
             'payments',
             'promotion_details{applied_amount, coupon_code, target_granularity, sponsor, campaign_name}',

app/code/Meta/BusinessExtension/composer.json

@@ -13,7 +13,6 @@
     "magento/module-eav": "*",
     "magento/module-security": "*",
     "magento/module-store": "*",
-    "magento/module-webapi": "*",
     "facebook/php-business-sdk": "^15.0.0"
   },
   "autoload": {

app/code/Meta/Sales/Model/Mapper/OrderMapper.php

@@ -31,9 +31,11 @@
 use Magento\Store\Model\StoreManagerInterface;
 use Meta\BusinessExtension\Helper\GraphAPIAdapter;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
+use Meta\Sales\Plugin\ShippingMethodTypes;
 
 /**
  * Map facebook order data to magento order
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class OrderMapper
 {
@@ -120,6 +122,7 @@ public function map(array $data, int $storeId): Order
 
         $channel = ucfirst($data['channel']);
         $shippingOptionName = $data['selected_shipping_option']['name'];
+        $shippingReferenceId = $data['selected_shipping_option']['reference_id'];
         $billingAddress = $this->getOrderBillingAddress($data);
         $shippingAddress = clone $billingAddress;
         $shippingAddress
@@ -146,7 +149,7 @@ public function map(array $data, int $storeId): Order
 
         $this->applyTotalsToOrder($order, $data, $storeId);
 
-        $shippingMethod = $this->getShippingMethod($shippingOptionName, $storeId);
+        $shippingMethod = $this->getShippingMethod($shippingOptionName, $shippingReferenceId, $storeId);
         $shippingDescription = $this->getShippingMethodLabel($shippingOptionName, $storeId);
 
         $order->setStoreId($storeId)
@@ -172,12 +175,19 @@ public function map(array $data, int $storeId): Order
      * Get Magento shipping method code. For example: "flatrate_flatrate"
      *
      * @param string $shippingOptionName (possible values: "standard", "expedited", "rush")
+     * @param string $shippingReferenceId
      * @param int $storeId
      * @return string|null
      * @throws LocalizedException
      */
-    private function getShippingMethod(string $shippingOptionName, int $storeId): ?string
+    private function getShippingMethod(string $shippingOptionName, string $shippingReferenceId, int $storeId): ?string
     {
+        $static_shipping_options = [ShippingMethodTypes::FREE_SHIPPING,
+                                    ShippingMethodTypes::FLAT_RATE,
+                                    ShippingMethodTypes::TABLE_RATE];
+        if (in_array($shippingReferenceId, $static_shipping_options)) {
+            return $shippingReferenceId;
+        }
         $map = $this->systemConfig->getShippingMethodsMap($storeId);
         foreach (['standard', 'expedited', 'rush'] as $item) {
             if (stripos($shippingOptionName, $item) !== false && isset($map[$item])) {

app/code/Meta/Sales/Plugin/ShippingData.php

@@ -49,6 +49,8 @@ class ShippingData
     public const ATTR_SHIPPING_FEE_TYPE = 'shipping_fee_type';
     public const ATTR_FREE_SHIPPING_MIN_ORDER_AMOUNT = 'free_shipping_minimum_order_amount';
 
+    public const EXTERNAL_REFERENCE_ID = 'external_reference_id';
+
     /**
      * @param CollectionFactory $tableRateCollection
      * @param ScopeConfigInterface $scopeConfig
@@ -104,6 +106,7 @@ public function buildShippingProfile(string $shippingProfileType): array
         $freeShippingThreshold = $this->getFieldFromModel($shippingProfileType, 'free_shipping_subtotal');
         $handlingFee = $this->getFieldFromModel($shippingProfileType, 'handling_fee');
         $handlingFeeType = $this->getFieldFromModel($shippingProfileType, 'handling_type');
+        $externalReferenceId = $this->getExternalReferenceID($shippingProfileType);
         return [
             self::ATTR_ENABLED => $isEnabled,
             self::ATTR_TITLE => $title,
@@ -113,6 +116,7 @@ public function buildShippingProfile(string $shippingProfileType): array
             self::ATTR_HANDLING_FEE_TYPE => $handlingFeeType,
             self::ATTR_SHIPPING_FEE_TYPE => $shippingType,
             self::ATTR_FREE_SHIPPING_MIN_ORDER_AMOUNT => $freeShippingThreshold,
+            self::EXTERNAL_REFERENCE_ID => $externalReferenceId
         ];
     }
 
@@ -129,6 +133,26 @@ private function getFieldFromModel(string $shippingProfileType, string $field)
         return $this->scopeConfig->getValue($path, \Magento\Store\Model\ScopeInterface::SCOPE_STORE, $this->storeId);
     }
 
+    /**
+     * Get external reference id for shipping settings which meta will use to identify the selected shipping option
+     *
+     * @param string $shippingProfileType
+     * @return string
+     */
+    private function getExternalReferenceID(string $shippingProfileType): string
+    {
+        switch ($shippingProfileType) {
+            case ShippingProfileTypes::TABLE_RATE:
+                return ShippingMethodTypes::TABLE_RATE;
+            case ShippingProfileTypes::FLAT_RATE:
+                return ShippingMethodTypes::FLAT_RATE;
+            case ShippingProfileTypes::FREE_SHIPPING:
+                return ShippingMethodTypes::FREE_SHIPPING;
+            default:
+                return "";
+        }
+    }
+
     /**
      * A function that builds shipping methods info for shipping profiles which are not table rates
      *

app/code/Meta/Sales/Plugin/ShippingFileBuilder.php

@@ -78,7 +78,8 @@ public function getHeaderFields(): array
             ShippingData::ATTR_HANDLING_FEE,
             ShippingData::ATTR_HANDLING_FEE_TYPE,
             ShippingData::ATTR_SHIPPING_FEE_TYPE,
-            ShippingData::ATTR_FREE_SHIPPING_MIN_ORDER_AMOUNT
+            ShippingData::ATTR_FREE_SHIPPING_MIN_ORDER_AMOUNT,
+            ShippingData::EXTERNAL_REFERENCE_ID
         ];
     }
 }

app/code/Meta/Sales/Plugin/ShippingMethodTypes.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Meta\Sales\Plugin;
+
+class ShippingMethodTypes
+{
+    public const TABLE_RATE = 'tablerate_bestway';
+    public const FREE_SHIPPING = 'freeshipping_freeshipping';
+    public const FLAT_RATE = 'flatrate_flatrate';
+}