Merge pull request #109 from oojoe/master

Added Shipping Zones to the Service Description
zf-fr · Sep 1, 2020 · b5e1229 · b5e1229
2 parents 32e323e + d7d85ea
commit b5e1229
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/src/ServiceDescription/Shopify-v1.php b/src/ServiceDescription/Shopify-v1.php
@@ -4980,6 +4980,33 @@
             ]
         ],
 
+        /**
+         * --------------------------------------------------------------------------------
+         * SHIPPING ZONE RELATED METHODS
+         *
+         * DOC: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone
+         * --------------------------------------------------------------------------------
+         */
+
+        'GetShippingZones' => [
+            'httpMethod'           => 'GET',
+            'uri'                  => 'admin/api/{version}/shipping_zones.json',
+            'responseModel'        => 'GenericModel',
+            'summary'              => 'Retrieve a list of all shipping zones',
+            'data'                 => ['root_key' => 'shipping_zones'],
+            'parameters'           => [
+                'version' => [
+                    'description' => 'API version',
+                    'location'    => 'uri',
+                    'type'        => 'string',
+                    'required'    => true
+                ],
+            ],
+            'additionalParameters' => [
+                'location' => 'query',
+            ],
+        ],
+
         /**
          * --------------------------------------------------------------------------------
          * TRANSACTION RELATED METHODS

diff --git a/src/ShopifyClient.php b/src/ShopifyClient.php
@@ -331,6 +331,10 @@
  * @method array updateScriptTag(array $args = []) {@command Shopify UpdateScriptTag}
  * @method array deleteScriptTag(array $args = []) {@command Shopify DeleteScriptTag}
  *
+ * SHIPPING ZONE RELATED METHODS:
+ *
+ * @method array getShippingZones(array $args = []) {@command Shopify GetShippingZones}
+ *
  * TRANSACTION RELATED METHODS:
  *
  * @method array getTransactions(array $args = []) {@command Shopify GetTransactions}