chore(docs): Generated API Reference (#3262)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
olivermrbl
parent
67f9429293
commit
4fb22e8ba5
@@ -4,19 +4,27 @@ description: >-
|
||||
within a given Region
|
||||
type: object
|
||||
required:
|
||||
- code
|
||||
- created_at
|
||||
- id
|
||||
- metadata
|
||||
- name
|
||||
- rate
|
||||
- region_id
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The tax rate's ID
|
||||
type: string
|
||||
example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
|
||||
rate:
|
||||
description: The numeric rate to charge
|
||||
nullable: true
|
||||
type: number
|
||||
example: 10
|
||||
code:
|
||||
description: A code to identify the tax type by
|
||||
nullable: true
|
||||
type: string
|
||||
example: tax01
|
||||
name:
|
||||
@@ -24,58 +32,57 @@ properties:
|
||||
type: string
|
||||
example: Tax Example
|
||||
region_id:
|
||||
type: string
|
||||
description: The id of the Region that the rate belongs to
|
||||
type: string
|
||||
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
|
||||
region:
|
||||
description: A region object. Available if the relation `region` is expanded.
|
||||
type: object
|
||||
nullable: true
|
||||
$ref: ./Region.yaml
|
||||
products:
|
||||
type: array
|
||||
description: >-
|
||||
The products that belong to this tax rate. Available if the relation
|
||||
`products` is expanded.
|
||||
items:
|
||||
type: object
|
||||
description: A product object.
|
||||
product_types:
|
||||
type: array
|
||||
items:
|
||||
$ref: ./Product.yaml
|
||||
product_types:
|
||||
description: >-
|
||||
The product types that belong to this tax rate. Available if the relation
|
||||
`product_types` is expanded.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
description: A product type object.
|
||||
$ref: ./ProductType.yaml
|
||||
shipping_options:
|
||||
type: array
|
||||
description: >-
|
||||
The shipping options that belong to this tax rate. Available if the
|
||||
relation `shipping_options` is expanded.
|
||||
items:
|
||||
type: object
|
||||
description: A shipping option object.
|
||||
$ref: ./ShippingOption.yaml
|
||||
product_count:
|
||||
description: The count of products
|
||||
type: integer
|
||||
example: null
|
||||
example: 10
|
||||
product_type_count:
|
||||
description: The count of product types
|
||||
type: integer
|
||||
example: null
|
||||
example: 2
|
||||
shipping_option_count:
|
||||
description: The count of shipping options
|
||||
type: integer
|
||||
example: null
|
||||
example: 1
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user