chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
committed by
GitHub
parent
efdea04963
commit
658339767b
@@ -1,7 +1,7 @@
|
||||
title: Region
|
||||
description: >-
|
||||
Regions hold settings for how Customers in a given geographical location shop.
|
||||
The is, for example, where currencies and tax rates are defined. A Region can
|
||||
A region holds settings specific to a geographical location, including the
|
||||
currency, tax rates, and fulfillment and payment providers. A Region can
|
||||
consist of multiple countries to accomodate common shopping settings across
|
||||
countries.
|
||||
type: object
|
||||
@@ -30,14 +30,15 @@ properties:
|
||||
type: string
|
||||
example: EU
|
||||
currency_code:
|
||||
description: The 3 character currency code that the Region uses.
|
||||
description: The 3 character currency code used in the region.
|
||||
type: string
|
||||
example: usd
|
||||
externalDocs:
|
||||
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
||||
description: See a list of codes.
|
||||
currency:
|
||||
description: Available if the relation `currency` is expanded.
|
||||
description: The details of the currency used in the region.
|
||||
x-expandable: currency
|
||||
nullable: true
|
||||
$ref: ./Currency.yaml
|
||||
tax_rate:
|
||||
@@ -46,9 +47,10 @@ properties:
|
||||
example: 0
|
||||
tax_rates:
|
||||
description: >-
|
||||
The tax rates that are included in the Region. Available if the relation
|
||||
`tax_rates` is expanded.
|
||||
The details of the tax rates used in the region, aside from the default
|
||||
rate.
|
||||
type: array
|
||||
x-expandable: tax_rates
|
||||
items:
|
||||
$ref: ./TaxRate.yaml
|
||||
tax_code:
|
||||
@@ -67,10 +69,9 @@ properties:
|
||||
type: boolean
|
||||
default: true
|
||||
countries:
|
||||
description: >-
|
||||
The countries that are included in the Region. Available if the relation
|
||||
`countries` is expanded.
|
||||
description: The details of the countries included in this region.
|
||||
type: array
|
||||
x-expandable: countries
|
||||
items:
|
||||
$ref: ./Country.yaml
|
||||
tax_provider_id:
|
||||
@@ -79,26 +80,30 @@ properties:
|
||||
type: string
|
||||
example: null
|
||||
tax_provider:
|
||||
description: Available if the relation `tax_provider` is expanded.
|
||||
description: The details of the tax provider used in the region.
|
||||
x-expandable: tax_provider
|
||||
nullable: true
|
||||
$ref: ./TaxProvider.yaml
|
||||
payment_providers:
|
||||
description: >-
|
||||
The Payment Providers that can be used to process Payments in the Region.
|
||||
Available if the relation `payment_providers` is expanded.
|
||||
The details of the payment providers that can be used to process payments
|
||||
in the region.
|
||||
type: array
|
||||
x-expandable: payment_providers
|
||||
items:
|
||||
$ref: ./PaymentProvider.yaml
|
||||
fulfillment_providers:
|
||||
description: >-
|
||||
The Fulfillment Providers that can be used to fulfill orders in the
|
||||
Region. Available if the relation `fulfillment_providers` is expanded.
|
||||
The details of the fulfillment providers that can be used to fulfill items
|
||||
of orders and similar resources in the region.
|
||||
type: array
|
||||
x-expandable: fulfillment_providers
|
||||
items:
|
||||
$ref: ./FulfillmentProvider.yaml
|
||||
includes_tax:
|
||||
description: '[EXPERIMENTAL] Does the prices for the region include tax'
|
||||
description: Whether the prices for the region include tax
|
||||
type: boolean
|
||||
x-featureFlag: tax_inclusive_pricing
|
||||
default: false
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
@@ -119,3 +124,7 @@ properties:
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
Reference in New Issue
Block a user