chore(docs): manually generated API reference to fix load issue (#3286)
This commit is contained in:
@@ -82,12 +82,12 @@ properties:
|
||||
payment_session:
|
||||
description: The selected payment session in the cart.
|
||||
nullable: true
|
||||
$ref: ./PaymentSession.yaml
|
||||
type: object
|
||||
payment_sessions:
|
||||
description: The payment sessions created on the cart.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./PaymentSession.yaml
|
||||
type: object
|
||||
payment_id:
|
||||
description: The payment's ID if available
|
||||
nullable: true
|
||||
|
||||
@@ -20,7 +20,7 @@ properties:
|
||||
claim_item:
|
||||
description: A claim item object. Available if the relation `claim_item` is expanded.
|
||||
nullable: true
|
||||
$ref: ./ClaimItem.yaml
|
||||
type: object
|
||||
url:
|
||||
description: The URL of the image
|
||||
type: string
|
||||
|
||||
@@ -54,4 +54,4 @@ properties:
|
||||
region:
|
||||
description: A region object. Available if the relation `region` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Region.yaml
|
||||
type: object
|
||||
|
||||
@@ -23,14 +23,14 @@ properties:
|
||||
`customers` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./Customer.yaml
|
||||
type: object
|
||||
price_lists:
|
||||
description: >-
|
||||
The price lists that are associated with the customer group. Available if
|
||||
the relation `price_lists` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./PriceList.yaml
|
||||
type: object
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
|
||||
@@ -59,7 +59,7 @@ properties:
|
||||
parent_discount:
|
||||
description: Available if the relation `parent_discount` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Discount.yaml
|
||||
type: object
|
||||
starts_at:
|
||||
description: The time at which the discount can be used.
|
||||
type: string
|
||||
|
||||
@@ -54,7 +54,7 @@ properties:
|
||||
used. Available if the relation `conditions` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./DiscountCondition.yaml
|
||||
type: object
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
|
||||
@@ -19,7 +19,7 @@ properties:
|
||||
fulfillment:
|
||||
description: A fulfillment object. Available if the relation `fulfillment` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Fulfillment.yaml
|
||||
type: object
|
||||
item:
|
||||
description: Available if the relation `item` is expanded.
|
||||
nullable: true
|
||||
|
||||
@@ -20,7 +20,7 @@ properties:
|
||||
item:
|
||||
description: Available if the relation `item` is expanded.
|
||||
nullable: true
|
||||
$ref: ./LineItem.yaml
|
||||
type: object
|
||||
description:
|
||||
description: The line item's adjustment description
|
||||
type: string
|
||||
|
||||
@@ -35,7 +35,7 @@ properties:
|
||||
item:
|
||||
description: Available if the relation `item` is expanded.
|
||||
nullable: true
|
||||
$ref: ./LineItem.yaml
|
||||
type: object
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
|
||||
@@ -62,7 +62,7 @@ properties:
|
||||
price_list:
|
||||
description: Available if the relation `price_list` is expanded.
|
||||
nullable: true
|
||||
$ref: ./PriceList.yaml
|
||||
type: object
|
||||
variant_id:
|
||||
description: The id of the Product Variant contained in the Line Item.
|
||||
nullable: true
|
||||
@@ -73,7 +73,7 @@ properties:
|
||||
The Product Variant contained in the Line Item. Available if the relation
|
||||
`variant` is expanded.
|
||||
nullable: true
|
||||
$ref: ./ProductVariant.yaml
|
||||
type: object
|
||||
region_id:
|
||||
description: The region's ID
|
||||
nullable: true
|
||||
@@ -82,7 +82,7 @@ properties:
|
||||
region:
|
||||
description: A region object. Available if the relation `region` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Region.yaml
|
||||
type: object
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
|
||||
@@ -64,14 +64,14 @@ properties:
|
||||
parent_notification:
|
||||
description: Available if the relation `parent_notification` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Notification.yaml
|
||||
type: object
|
||||
resends:
|
||||
description: >-
|
||||
The resends that have been completed after the original Notification.
|
||||
Available if the relation `resends` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./Notification.yaml
|
||||
type: object
|
||||
provider_id:
|
||||
description: The id of the Notification Provider that handles the Notification.
|
||||
nullable: true
|
||||
|
||||
@@ -29,7 +29,7 @@ properties:
|
||||
order_edit:
|
||||
description: Available if the relation `order_edit` is expanded.
|
||||
nullable: true
|
||||
$ref: ./OrderEdit.yaml
|
||||
type: object
|
||||
original_line_item_id:
|
||||
description: The ID of the original line item in the order
|
||||
nullable: true
|
||||
|
||||
@@ -48,7 +48,7 @@ properties:
|
||||
description: Available if the relation `category_children` are expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./ProductCategory.yaml
|
||||
type: object
|
||||
parent_category_id:
|
||||
description: The ID of the parent category.
|
||||
nullable: true
|
||||
@@ -59,14 +59,14 @@ properties:
|
||||
A product category object. Available if the relation `parent_category` is
|
||||
expanded.
|
||||
nullable: true
|
||||
$ref: ./ProductCategory.yaml
|
||||
type: object
|
||||
products:
|
||||
description: >-
|
||||
Products associated with category. Available if the relation `products` is
|
||||
expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./Product.yaml
|
||||
type: object
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
|
||||
@@ -31,7 +31,7 @@ properties:
|
||||
relation `products` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./Product.yaml
|
||||
type: object
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
|
||||
@@ -35,7 +35,7 @@ properties:
|
||||
product:
|
||||
description: A product object. Available if the relation `product` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Product.yaml
|
||||
type: object
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
|
||||
@@ -31,7 +31,7 @@ properties:
|
||||
option:
|
||||
description: Available if the relation `option` is expanded.
|
||||
nullable: true
|
||||
$ref: ./ProductOption.yaml
|
||||
type: object
|
||||
variant_id:
|
||||
description: >-
|
||||
The ID of the Product Variant that the Product Option Value is defined
|
||||
@@ -41,7 +41,7 @@ properties:
|
||||
variant:
|
||||
description: Available if the relation `variant` is expanded.
|
||||
nullable: true
|
||||
$ref: ./ProductVariant.yaml
|
||||
type: object
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
|
||||
@@ -45,7 +45,7 @@ properties:
|
||||
product:
|
||||
description: A product object. Available if the relation `product` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Product.yaml
|
||||
type: object
|
||||
prices:
|
||||
description: >-
|
||||
The Money Amounts defined for the Product Variant. Each Money Amount
|
||||
|
||||
@@ -25,7 +25,7 @@ properties:
|
||||
variant:
|
||||
description: A ProductVariant object. Available if the relation `variant` is expanded.
|
||||
nullable: true
|
||||
$ref: ./ProductVariant.yaml
|
||||
type: object
|
||||
required_quantity:
|
||||
description: >-
|
||||
The quantity of an inventory item required for one quantity of the
|
||||
|
||||
@@ -25,7 +25,7 @@ properties:
|
||||
return_order:
|
||||
description: Available if the relation `return_order` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Return.yaml
|
||||
type: object
|
||||
item:
|
||||
description: Available if the relation `item` is expanded.
|
||||
nullable: true
|
||||
|
||||
@@ -39,10 +39,10 @@ properties:
|
||||
parent_return_reason:
|
||||
description: Available if the relation `parent_return_reason` is expanded.
|
||||
nullable: true
|
||||
$ref: ./ReturnReason.yaml
|
||||
type: object
|
||||
return_reason_children:
|
||||
description: Available if the relation `return_reason_children` is expanded.
|
||||
$ref: ./ReturnReason.yaml
|
||||
type: object
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
|
||||
@@ -25,7 +25,7 @@ properties:
|
||||
The sales channel the location is associated with. Available if the
|
||||
relation `sales_channel` is expanded.
|
||||
nullable: true
|
||||
$ref: ./SalesChannel.yaml
|
||||
type: object
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
|
||||
@@ -35,7 +35,7 @@ properties:
|
||||
shipping_method:
|
||||
description: Available if the relation `shipping_method` is expanded.
|
||||
nullable: true
|
||||
$ref: ./ShippingMethod.yaml
|
||||
type: object
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
|
||||
@@ -40,7 +40,7 @@ properties:
|
||||
region:
|
||||
description: A region object. Available if the relation `region` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Region.yaml
|
||||
type: object
|
||||
profile_id:
|
||||
description: >-
|
||||
The ID of the Shipping Profile that the shipping option belongs to.
|
||||
|
||||
@@ -23,7 +23,7 @@ properties:
|
||||
shipping_option:
|
||||
description: Available if the relation `shipping_option` is expanded.
|
||||
nullable: true
|
||||
$ref: ./ShippingOption.yaml
|
||||
type: object
|
||||
type:
|
||||
description: >-
|
||||
The type of the requirement, this defines how the value will be compared
|
||||
|
||||
@@ -38,7 +38,7 @@ properties:
|
||||
Available if the relation `products` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./Product.yaml
|
||||
type: object
|
||||
shipping_options:
|
||||
description: >-
|
||||
The Shipping Options that can be used to fulfill the Products in the
|
||||
@@ -46,7 +46,7 @@ properties:
|
||||
expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./ShippingOption.yaml
|
||||
type: object
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
|
||||
@@ -38,7 +38,7 @@ properties:
|
||||
region:
|
||||
description: A region object. Available if the relation `region` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Region.yaml
|
||||
type: object
|
||||
products:
|
||||
description: >-
|
||||
The products that belong to this tax rate. Available if the relation
|
||||
|
||||
@@ -35,7 +35,7 @@ properties:
|
||||
fulfillment:
|
||||
description: Available if the relation `fulfillment` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Fulfillment.yaml
|
||||
type: object
|
||||
idempotency_key:
|
||||
description: >-
|
||||
Randomly generated key used to continue the completion of a process in
|
||||
|
||||
Reference in New Issue
Block a user