chore(docs): Refactor API Reference (#1883)
This commit is contained in:
@@ -0,0 +1,36 @@
|
||||
title: Shipping Tax Rate
|
||||
description: >-
|
||||
Associates a tax rate with a shipping option to indicate that the shipping
|
||||
option is taxed in a certain way
|
||||
x-resourceId: shipping_tax_rate
|
||||
required:
|
||||
- shipping_option_id
|
||||
- rate_id
|
||||
properties:
|
||||
shipping_option_id:
|
||||
description: The ID of the Shipping Option
|
||||
type: string
|
||||
example: so_01G1G5V27GYX4QXNARRQCW1N8T
|
||||
shipping_option:
|
||||
description: Available if the relation `shipping_option` is expanded.
|
||||
$ref: ./shipping_option.yaml
|
||||
rate_id:
|
||||
description: The ID of the Tax Rate
|
||||
type: string
|
||||
example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
|
||||
tax_rate:
|
||||
description: Available if the relation `tax_rate` is expanded.
|
||||
$ref: ./tax_rate.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
example:
|
||||
car: white
|
||||
Reference in New Issue
Block a user