Files
medusa-store/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsReq.yaml
Shahed Nasser 7d650771d1 docs: generate medusa-react reference (#6004)
* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
2024-01-05 17:03:38 +02:00

49 lines
1.2 KiB
YAML

type: object
description: The details of the region to create.
required:
- name
- currency_code
- tax_rate
- payment_providers
- fulfillment_providers
- countries
properties:
name:
description: The name of the Region
type: string
currency_code:
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.
tax_code:
description: The tax code of the Region.
type: string
tax_rate:
description: The tax rate to use in the Region.
type: number
payment_providers:
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 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
Region.
example:
- US
type: array
items:
type: string
includes_tax:
x-featureFlag: tax_inclusive_pricing
description: Whether taxes are included in the prices of the region.
type: boolean