chore(docs): Generated API Reference (#3211)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-02-09 09:50:55 +02:00
committed by GitHub
parent 9997485c55
commit 14b2de94e2
952 changed files with 13745 additions and 9192 deletions

View File

@@ -5,12 +5,18 @@ description: >-
particular Shipping Option
type: object
required:
- cart_id
- created_at
- deleted_at
- id
- metadata
- price
- shipping_option_id
- updated_at
properties:
id:
type: string
description: The custom shipping option's ID
type: string
example: cso_01G8X99XNB77DMFBJFWX6DN9V9
price:
description: >-
@@ -26,31 +32,33 @@ properties:
description: >-
A shipping option object. Available if the relation `shipping_option` is
expanded.
type: object
nullable: true
$ref: ./ShippingOption.yaml
cart_id:
description: The ID of the Cart that the custom shipping option is attached to
nullable: true
type: string
example: cart_01G8ZH853Y6TFXWPG5EYE81X63
cart:
description: A cart object. Available if the relation `cart` is expanded.
type: object
nullable: true
$ref: ./Cart.yaml
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
deleted_at:
type: string
description: The date with timezone at which the resource was deleted.
nullable: true
type: string
format: date-time
metadata:
type: object
description: An optional key-value map with additional details
nullable: true
type: object
example:
car: white
includes_tax:
description: '[EXPERIMENTAL] Indicates if the custom shipping option price include tax'
type: boolean