Skip to content

Commit

Permalink
Add target field object (with country_codes, subdivision_codes) to Ta…
Browse files Browse the repository at this point in the history
…x Provider Connection API docs (#723)

# [TAX-2166]

## What changed?
* Add `target` object to Tax Provider Connection API docs. Includes
`country_codes` and `subdivision_codes` fields.

## Release notes draft
- Allows users to inspect where their tax provider connection is active.
Useful for determining if there are outstanding steps in the merchant's
tax provider configuration.

[TAX-2166]:
https://bigcommercecloud.atlassian.net/browse/TAX-2166?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
theromulans authored Dec 30, 2024
1 parent a5aa6ef commit b9fef99
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions reference/tax.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -207,4 +207,20 @@ components:
Describes whether the stored credentials are considered complete and configured, ready to be used for Tax Provider API requests.
Merchants may enable any **configured** tax provider for storefront tax quotation.
target:
type: object
description: The countries and subdivisions in which this tax provider connection is active.
properties:
country_codes:
type: array
items:
type: string
description: The list of country codes where the tax provider connection is active. ISO 3166-1 alpha-2.
example: ['AU', 'US']
subdivision_codes:
type: array
items:
type: string
description: The list of subdivision codes where the tax provider connection is active. ISO 3166-2.
example: ['AU-NSW', 'US-OH']
x-internal: false

0 comments on commit b9fef99

Please sign in to comment.