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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions
@@ -1,5 +1,8 @@
title: Order Item Change
description: Represents an order edit item change
description: >-
An order item change is a change made within an order edit to an order's
items. These changes are not reflected on the original order until the order
edit is confirmed.
type: object
required:
- created_at
@@ -27,7 +30,8 @@ properties:
type: string
example: oe_01G2SG30J8C85S4A5CHM2S1NS2
order_edit:
description: Available if the relation `order_edit` is expanded.
description: The details of the order edit the item change is associated with.
x-expandable: order_edit
nullable: true
type: object
original_line_item_id:
@@ -36,7 +40,10 @@ properties:
type: string
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
original_line_item:
description: Available if the relation `original_line_item` is expanded.
description: >-
The details of the original line item this item change references. This is
used if the item change updates or deletes the original item.
x-expandable: original_line_item
nullable: true
$ref: ./LineItem.yaml
line_item_id:
@@ -45,7 +52,10 @@ properties:
type: string
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
line_item:
description: Available if the relation `line_item` is expanded.
description: >-
The details of the resulting line item after the item change. This line
item is then used in the original order once the order edit is confirmed.
x-expandable: line_item
nullable: true
$ref: ./LineItem.yaml
created_at: