chore(docs): Updated API Reference (v2) (#9148)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
a63f6910d0
commit
56ee4d6aad
@@ -1,5 +1,5 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
description: The tax region's details.
|
||||
x-schemaName: AdminCreateTaxRegion
|
||||
required:
|
||||
- country_code
|
||||
@@ -8,6 +8,7 @@ properties:
|
||||
type: string
|
||||
title: country_code
|
||||
description: The tax region's country code.
|
||||
example: us
|
||||
province_code:
|
||||
type: string
|
||||
title: province_code
|
||||
@@ -15,7 +16,7 @@ properties:
|
||||
parent_id:
|
||||
type: string
|
||||
title: parent_id
|
||||
description: The tax region's parent id.
|
||||
description: The ID of the parent tax region.
|
||||
default_tax_rate:
|
||||
type: object
|
||||
description: The tax region's default tax rate.
|
||||
@@ -25,22 +26,26 @@ properties:
|
||||
rate:
|
||||
type: number
|
||||
title: rate
|
||||
description: The default tax rate's rate.
|
||||
description: The rate to charge.
|
||||
example: 10
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: The default tax rate's code.
|
||||
description: The code the tax rate is identified by
|
||||
name:
|
||||
type: string
|
||||
title: name
|
||||
description: The default tax rate's name.
|
||||
example: VAT
|
||||
is_combinable:
|
||||
type: boolean
|
||||
title: is_combinable
|
||||
description: The default tax rate's is combinable.
|
||||
description: Whether the tax rate should be combined with parent rates.
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
|
||||
metadata:
|
||||
type: object
|
||||
description: The default tax rate's metadata.
|
||||
description: The default tax rate's metadata, used to store custom key-value pairs.
|
||||
metadata:
|
||||
type: object
|
||||
description: The tax region's metadata.
|
||||
description: The tax region's metadata, used to store custom key-value pairs.
|
||||
|
||||
Reference in New Issue
Block a user