Files
medusa-store/docs/api/admin/components/schemas/ShippingTaxRate.yaml
github-actions[bot] 658339767b chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-08-07 16:54:48 +03:00

47 lines
1.3 KiB
YAML

title: Shipping Tax Rate
description: This represents the tax rates applied on a shipping option.
type: object
required:
- created_at
- metadata
- rate_id
- shipping_option_id
- updated_at
properties:
shipping_option_id:
description: The ID of the shipping option.
type: string
example: so_01G1G5V27GYX4QXNARRQCW1N8T
shipping_option:
description: The details of the shipping option.
x-expandable: shipping_option
nullable: true
$ref: ./ShippingOption.yaml
rate_id:
description: The ID of the associated tax rate.
type: string
example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
tax_rate:
description: The details of the associated tax rate.
x-expandable: tax_rate
nullable: true
$ref: ./TaxRate.yaml
created_at:
description: The date with timezone at which the resource was created.
type: string
format: date-time
updated_at:
description: The date with timezone at which the resource was updated.
type: string
format: date-time
metadata:
description: An optional key-value map with additional details
nullable: true
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