Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2.7 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminPostRegionsReq
internal.internal.AdminPostRegionsReq
Schema
AdminPostRegionsReq type: object 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
Properties
countries
• countries: string[]
Defined in
packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:140
currency_code
• currency_code: string
Defined in
packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:135
fulfillment_providers
• fulfillment_providers: string[]
Defined in
packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:139
includes_tax
• Optional includes_tax: boolean
Defined in
packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:141
metadata
• Optional metadata: Record<string, unknown>
Defined in
packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:142
name
• name: string
Defined in
packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:134
payment_providers
• payment_providers: string[]
Defined in
packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:138
tax_code
• Optional tax_code: string
Defined in
packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:136
tax_rate
• tax_rate: number
Defined in
packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:137