ORDERS-6362: [add] is_tax_inclusive_pricing field in orders response

bigcommerce · Sep 18, 2024 · 9e577c6 · 9e577c6
1 parent 935cb6c
commit 9e577c6
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/reference/orders.v2.oas2.yml b/reference/orders.v2.oas2.yml
@@ -1429,6 +1429,7 @@ components:
                   total_ex_tax: '361.9500'
                   total_inc_tax: '361.9500'
                   total_tax: '0.0000'
+                  is_tax_inclusive_pricing: false
                   items_total: 17
                   items_shipped: 0
                   payment_method: Credit Card
@@ -1643,6 +1644,7 @@ components:
                 total_ex_tax: '64.5300'
                 total_inc_tax: '69.8400'
                 total_tax: '5.3100'
+                is_tax_inclusive_pricing: false
                 items_total: 4
                 items_shipped: 0
                 payment_method: Cash
@@ -1736,6 +1738,7 @@ components:
                 total_ex_tax: '931.86'
                 total_inc_tax: '1008.74'
                 total_tax: 76.88
+                is_tax_inclusive_pricing: false
                 items_total: 11
                 items_shipped: 0
                 payment_method: Test Payment Gateway
@@ -3915,6 +3918,10 @@ components:
           description: Override value for the total, including tax. If specified, the field `total_ex_tax` is also required. (Float, Float-As-String, Integer)
           example: '225.0000'
           type: string
+        is_tax_inclusive_pricing:
+          description: Indicates whether the order total is inclusive of tax.
+          example: false
+          type: boolean
         wrapping_cost_ex_tax:
           description: The value of the wrapping cost, excluding tax. (Float, Float-As-String, Integer)
           example: '0.0000'
@@ -4129,6 +4136,10 @@ components:
           description: Indicates whether the order is deleted/archived. When set to true in a PUT request, it has the same result as the DELETE an order request.
           example: false
           type: boolean
+        is_tax_inclusive_pricing:
+          description: Indicates whether the order total is inclusive of tax.
+          example: false
+          type: boolean
         is_email_opt_in:
           description: Indicates whether the shopper has selected an opt-in check box (on the checkout page) to receive emails. A read-only value. Do not pass in a POST or PUT.
           example: false