asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated API Reference (#4706)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/api/admin/components/schemas/AdminPostRegionsRegionReq.yaml
View File

@@ -4,46 +4,51 @@ properties:
description: The name of the Region
type: string
currency_code:
description: The 3 character ISO currency code to use for the Region.
description: The 3 character ISO currency code to use in the Region.
type: string
externalDocs:
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
description: See a list of codes.
automatic_taxes:
description: >-
If true Medusa will automatically calculate taxes for carts in this
region. If false you have to manually call POST /carts/:id/taxes.
If set to `true`, the Medusa backend will automatically calculate taxes
for carts in this region. If set to `false`, the taxes must be calculated
manually.
externalDocs:
url: https://docs.medusajs.com/modules/taxes/storefront/manual-calculation
description: How to calculate taxes in a storefront.
type: boolean
gift_cards_taxable:
description: >-
Whether gift cards in this region should be applied sales tax when
purchasing a gift card
description: If set to `true`, taxes will be applied on gift cards.
type: boolean
tax_provider_id:
description: The ID of the tax provider to use; if null the system tax provider is used
description: >-
The ID of the tax provider to use. If none provided, the system tax
provider is used.
type: string
tax_code:
description: An optional tax code the Region.
description: The tax code of the Region.
type: string
tax_rate:
description: The tax rate to use on Orders in the Region.
description: The tax rate to use in the Region.
type: number
includes_tax:
description: '[EXPERIMENTAL] Tax included in prices of region'
x-featureFlag: tax_inclusive_pricing
description: Whether taxes are included in the prices of the region.
type: boolean
payment_providers:
description: A list of Payment Provider IDs that should be enabled for the Region
description: A list of Payment Provider IDs that can be used in the Region
type: array
items:
type: string
fulfillment_providers:
description: A list of Fulfillment Provider IDs that should be enabled for the Region
description: A list of Fulfillment Provider IDs that can be used in the Region
type: array
items:
type: string
countries:
description: >-
A list of countries' 2 ISO Characters that should be included in the
A list of countries' 2 ISO characters that should be included in the
Region.
type: array
items: