Merge branch 'bigcommerce:main' into fix-escaping-orders

bigcommerce · Sep 3, 2023 · a11bb47 · a11bb47
2 parents d25ea84 + af3bd63
commit a11bb47
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 118 deletions.
diff --git a/reference/catalog/products_catalog.v3.yml b/reference/catalog/products_catalog.v3.yml
@@ -7008,7 +7008,7 @@ components:
         image_file:
           type: string
           description: |
-            The local path to the original image file uploaded to BigCommerce. Limit of 1MB per file.
+            The local path to the original image file uploaded to BigCommerce. Limit of 8MB per file.
         is_thumbnail:
           type: boolean
           description: |

diff --git a/reference/channels.v3.yml b/reference/channels.v3.yml
@@ -252,7 +252,7 @@ paths:
         - $ref: '#/components/parameters/ContentType'
       summary: Create Multiple Channels Currency Assignments
       operationId: createMultipleChannelsCurrencyAssignments
-      description: Sets enabled currencies and default currency for multiple channels. Note that currencies must be added first in the **Settings > Setup > Currencies** settings from an active MSF-enabled BigCommerce Control Panel before the currencies can be assigned to a channel.
+      description: Sets enabled currencies and default currency for multiple channels. Note that currencies must be added first in the **Settings > Setup > Currencies** settings from an active MSF-enabled BigCommerce store control panel before the currencies can be assigned to a channel.
       requestBody:
         content:
           application/json:
@@ -274,7 +274,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/ContentType'
       operationId: updateMultipleChannelsCurrencyAssignments
-      description: Updates enabled currencies and default currency for multiple channels. Note that currencies must be added first in the **Settings > Setup > Currencies** settings from an active MSF-enabled BigCommerce Control Panel before the currencies can be assigned to a channel.
+      description: Updates enabled currencies and default currency for multiple channels. Note that currencies must be added first in the **Settings > Setup > Currencies** settings from an active MSF-enabled BigCommerce store control panel before the currencies can be assigned to a channel.
       requestBody:
         content:
           application/json:
@@ -311,7 +311,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/ContentType'
       operationId: createSingleChannelCurrencyAssignments
-      description: Sets enabled currencies and default currency for a specific channel. Note that currencies must be added first in the **Settings > Setup > Currencies** settings from an active MSF-enabled BigCommerce Control Panel before the currencies can be assigned to a channel.
+      description: Sets enabled currencies and default currency for a specific channel. Note that currencies must be added first in the **Settings > Setup > Currencies** settings from an active MSF-enabled BigCommerce store control panel before the currencies can be assigned to a channel.
       requestBody:
         content:
           application/json:
@@ -333,7 +333,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/ContentType'
       operationId: updateSingleChannelCurrencyAssignments
-      description: Updates enabled currencies and default currency for a specific channel. Note that currencies must be added first in the **Settings > Setup > Currencies** settings from an active MSF-enabled BigCommerce Control Panel before the currencies can be assigned to a channel.
+      description: Updates enabled currencies and default currency for a specific channel. Note that currencies must be added first in the **Settings > Setup > Currencies** settings from an active MSF-enabled BigCommerce store control panel before the currencies can be assigned to a channel.
       requestBody:
         content:
           application/json:

diff --git a/reference/currencies.v2.yml b/reference/currencies.v2.yml
@@ -10,13 +10,13 @@ info:
     | -- | -- |
     | Default Currency | Storeʼs default currency is the one from which any auto-conversion of pricing (product, tax, shipping, promotions) will happen.|
     | Display Currency | Currency that is displayed on the storefront. This might or might not mean that shopper can actually transact in that currency. Display currency is also often called "presentment currency" in the payments industry. |
-    | Transactional Currency | Transactional currency is what currency and amount BC passes to the payment provider and the currency/amount that the shopper will be charged to their bank account. If thereʼs a discrepancy between the storefront display currency and the transactional currency, a shopper has to pay a conversion fee and the conversion rate that will be used will be outside of BCʼs purview. |
-    | Settlement Currency | This is the currency in which the merchant gets paid out to their bank account. If thereʼs a discrepancy between the currency that shopper transacts in and the currency in which merchant settles, merchant has to pay a conversion fee and the conversion rate used will be outside of BCʼs purview. Merchant is able to set their settlement currency through their payment provider. |
+    | Transactional Currency | Transactional currency is what currency and amount BigCommerce passes to the payment provider and the currency/amount that the shopper will be charged to their bank account. If thereʼs a discrepancy between the storefront display currency and the transactional currency, a shopper has to pay a conversion fee and the conversion rate that will be used will be outside of BigCommerceʼs purview. |
+    | Settlement Currency | This is the currency in which the merchant gets paid out to their bank account. If thereʼs a discrepancy between the currency that shopper transacts in and the currency in which merchant settles, merchant has to pay a conversion fee and the conversion rate used will be outside of BigCommerceʼs purview. Merchant is able to set their settlement currency through their payment provider. |
     |BigCommerce Conversion Rate | Any conversion rate set on BigCommerce used to convert product’s default currency pricing into a new non-default currency. Conversion rate could be static or dynamic. |
     | Static Conversion Rate | One of the two auto-converted pricing options. If a merchant manually enters a static conversion rate, then the conversion rate will remain the same until/unless merchant updates their currency settings to use a different conversion rate. The advantage of using this method is to avoid constantly fluctuating price in non-default currencies. |
     | Dynamic Conversion Rate | One of the two auto-converted pricing options. If a merchant selects a dynamic conversion rate, theyʼve tied themselves to a currency conversion service, which will update the conversion rate at a certain frequency. This helps shopper-facing pricing remain most aligned to the storeʼs default currency and keeps non-default currency conversion rate at market rate. Merchant can either use BigCommerce Currency Service provided in the Currency setup page, or they can use API to automatically update the exchange rate from their trusted source. |
-    | Bank Conversion Rate | Conversion rate used by merchant’s or shopper’s payment or credit card provider when auto-converting from store’s transactional currency. This rate might not align to the BC conversion rate and BC has no visibility into it. |
-    | Multi Currency Pricing | Rather than opting for auto-converting product pricing from default currency using BC conversion rate, merchant has a choice to set price per product per currency. This will be implemented through price lists. |
+    | Bank Conversion Rate | Conversion rate used by merchant’s or shopper’s payment or credit card provider when auto-converting from store’s transactional currency. This rate might not align with the BigCommerce conversion rate and BigCommerce has no visibility into it. |
+    | Multi Currency Pricing | Rather than opting for auto-converting product pricing from default currency using BigCommerce conversion rate, merchant has a choice to set price per product per currency. This will be implemented through price lists. |
 
     ## FAQ
 
@@ -26,11 +26,11 @@ info:
 
     ## Resources
 
-    - [How Currencies Work](/api-docs/catalog/currencies/how-currencies-work)
-    - [Price List API](/docs/rest-management/price-lists)
-    - [Using Price Lists](https://support.bigcommerce.com/s/article/Price-Lists) (BigCommerce Knowledge Base)
-    - [Managing Currencies](https://support.bigcommerce.com/s/article/Managing-Currencies-Beta) (BigCommerce Knowledge Base)
-    - [Tax](https://support.bigcommerce.com/s/article/Manual-Tax-Setup#intro1) (BigCommerce Knowledge Base)
+    - [How Currencies Work](/api-docs/multi-currency/guide/how-currencies-work)
+    - [Price List API Reference](/docs/rest-management/price-lists)
+    - [Using Price Lists (Help Center)](https://support.bigcommerce.com/s/article/Price-Lists)
+    - [Managing Currencies (Help Center)](https://support.bigcommerce.com/s/article/Managing-Currencies-Beta) 
+    - [Tax (Help Center)](https://support.bigcommerce.com/s/article/Manual-Tax-Setup#intro1)
   version: ''
   termsOfService: 'https://www.bigcommerce.com/terms'
   contact:
@@ -52,7 +52,6 @@ tags:
 paths:
   /currencies:
     parameters:
-
       - $ref: '#/components/parameters/Accept'
     get:
       tags:
@@ -94,7 +93,7 @@ paths:
         * date_modified
 
 
-        The `is_default` property can only be set to true. The value of `is_default` cannot be unset, only overridden. To change the storeʼs default currency in the BigCommerce control panel, please see [Managing Currencies](https://support.bigcommerce.com/articles/Public/Managing-Currencies/?q=currency&l=en_US&fs=Search&pn=1#default).
+        The `is_default` property can only be set to true. The value of `is_default` cannot be unset, only overridden. To change the storeʼs default currency in the BigCommerce control panel, please see [Managing Currencies (Help Center)](https://support.bigcommerce.com/s/article/Managing-Currencies-Beta).
       parameters:
         - $ref: '#/components/parameters/ContentType'
       requestBody:
@@ -125,7 +124,6 @@ paths:
                 type: object
   /currencies/{id}:
     parameters:
-
       - $ref: '#/components/parameters/Accept'
       - name: id
         in: path
@@ -202,14 +200,14 @@ components:
     currency_Base:
       title: currency_Base
       required:
-      - currency_code
-      - currency_exchange_rate
-      - decimal_places
-      - decimal_token
-      - name
-      - thousands_token
-      - token
-      - token_location
+        - currency_code
+        - currency_exchange_rate
+        - decimal_places
+        - decimal_token
+        - name
+        - thousands_token
+        - token
+        - token_location
       type: object
       properties:
         is_default:

diff --git a/reference/orders.v2.oas2.yml b/reference/orders.v2.oas2.yml
@@ -3114,10 +3114,11 @@ components:
               coupons:
                 $ref: '#/components/schemas/coupons_Resource'
               external_id:
-                description: ID of the order in another system. For example, the Amazon Order ID if this is an Amazon order. This field can be updated in a POST request, but using a PUT request to update the order will return a 400 error. The field ''external_id'' cannot be written to. Please remove it from your request before trying again. It cannot be overwritten once set.
+                description: (Read-only) ID of the order in another system. For example, the Amazon order ID if this is an Amazon order.
                 example: null
                 type: string
                 nullable: true
+                readOnly: true
               external_merchant_id:
                 description: ID of the merchant.
                 example: null
@@ -3467,9 +3468,10 @@ components:
           items:
             $ref: '#/components/schemas/orderProductOptions'
         external_id:
-          description: ID of the order in another system. For example, the Amazon Order ID if this is an Amazon order. This field can be updated in a /POST, but using a /PUT to update the order will return a 400 error. The field ''external_id'' cannot be written to. Please remove it from your request before trying again. It cannot be overwritten once set.
+          description: (Read-only) ID of the order in another system. For example, the Amazon order ID if this is an Amazon order.
           type: string
           nullable: true
+          readOnly: true
         upc:
           type: string
           maxLength: 255
@@ -4242,11 +4244,11 @@ components:
           example: '0'
           type: string
         external_id:
-          description: The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it, you cannot write to or update the `external_id`. You can update this field using a POST request, but a PUT request to update the order will return a 400 error.  Please remove it from your request before trying again.
+          description: (Read-only) The order ID in another system, such as the Amazon order ID if this is an Amazon order.
           example: null
-          oneOf:
-            - type: string
+          type: string
           nullable: true
+          readOnly: true
         external_merchant_id:
           description: The merchant ID represents an upstream order from an external system. It is the source of truth for orders. After setting it, you cannot write to or update the `external_merchant_id`. For example, you can update the Facebook by Meta page ID in a POST request, but a PUT request to update the order will return a 400 error. Please remove it from your request before trying again.
           example: null
@@ -4372,7 +4374,7 @@ components:
         external_order_id:
           type: string
           example: external-order-id
-          description: The external id of the order.
+          description: The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it, you can update this field using a POST or PUT request.
         total_ex_tax:
           description: Override value for the total, excluding tax. If specified, the field `total_inc_tax` is also required. (Float, Float-As-String, Integer)
           example: '225.0000'
@@ -4928,11 +4930,11 @@ components:
               example: '0'
               type: string
             external_id:
-              description: The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it, you cannot write to or update the `external_id`. You can update this field using a POST request, but a PUT request to update the order will return a 400 error.  Please remove it from your request before trying again.
+              description: (Read-only) The order ID in another system, such as the Amazon Order ID if this is an Amazon order.  
               example: null
-              oneOf:
-                - type: string
+              type: string
               nullable: true
+              readOnly: true
             external_merchant_id:
               description: The merchant ID represents an upstream order from an external system. It is the source of truth for orders. After setting it, you cannot write to or update the `external_merchant_id`. For example, you can update the Facebook by Meta page ID in a POST request, but a PUT request to update the order will return a 400 error. Please remove it from your request before trying again.
               example: null
@@ -5066,7 +5068,7 @@ components:
             external_order_id:
               type: string
               example: external-order-id
-              description: The external id of the order.
+              description: The order ID in another system, such as the Amazon Order ID if this is an Amazon order. After setting it, you can update this field using a POST or PUT request. 
             total_ex_tax:
               description: Override value for the total, excluding tax. If specified, the field `total_inc_tax` is also required. (Float, Float-As-String, Integer)
               example: '225.0000'