Skip to content

Commit 73b2254

Browse files
committed
Mark order_taxes.tax_rate_id as deprecated, document sales_tax_id
1 parent 55920d1 commit 73b2254

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

reference/orders.v2.oas2.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2816,6 +2816,7 @@ components:
28162816
order_id: 138
28172817
order_address_id: 39
28182818
tax_rate_id: 1
2819+
sales_tax_id: 'TaxId123'
28192820
tax_class_id: 0
28202821
name: Tax
28212822
class: Default Tax Class
@@ -2828,6 +2829,7 @@ components:
28282829
order_id: 138
28292830
order_address_id: 40
28302831
tax_rate_id: 1
2832+
sales_tax_id: 'TaxId123'
28312833
tax_class_id: 0
28322834
name: Tax
28332835
class: Default Tax Class
@@ -3370,9 +3372,14 @@ components:
33703372
example: 29
33713373
type: integer
33723374
tax_rate_id:
3373-
description: The unique numeric identifier of the tax rate.
3375+
description: The unique numeric identifier of the tax rate. This field has been deprecated, use sales_tax_id instead.
33743376
example: 1
33753377
type: integer
3378+
deprecated: true
3379+
sales_tax_id:
3380+
description: A unique identifier for the applied tax rate. This may be a third-party tax provider's identifier.
3381+
example: 'TaxId123'
3382+
type: string
33763383
tax_class_id:
33773384
description: |-
33783385
A unique numeric identifier for the tax class. If not provided or null, the default fee tax class from the control panel is used.

0 commit comments

Comments
 (0)