Files
medusa-store/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml

52 lines
1.2 KiB
YAML

type: object
description: The region's details.
x-schemaName: AdminRegion
required:
- name
- currency_code
- id
properties:
id:
type: string
title: id
description: The region's ID.
name:
type: string
title: name
description: The region's name.
currency_code:
type: string
title: currency_code
description: The region's currency code.
example: usd
automatic_taxes:
type: boolean
title: automatic_taxes
description: Whether taxes are applied automatically during checkout.
countries:
type: array
description: The region's countries.
items:
$ref: ./AdminRegionCountry.yaml
payment_providers:
type: array
description: The region's payment providers.
items:
$ref: ./AdminPaymentProvider.yaml
metadata:
type: object
description: The region's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata
created_at:
type: string
format: date-time
title: created_at
description: The date the region was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The date the region was updated.