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
@@ -2,55 +2,62 @@ title: Order Item Change
|
||||
description: Represents an order edit item change
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
- created_at
|
||||
- deleted_at
|
||||
- id
|
||||
- line_item_id
|
||||
- order_edit_id
|
||||
- original_line_item_id
|
||||
- type
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The order item change's ID
|
||||
type: string
|
||||
example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK
|
||||
type:
|
||||
type: string
|
||||
description: The order item change's status
|
||||
type: string
|
||||
enum:
|
||||
- item_add
|
||||
- item_remove
|
||||
- item_update
|
||||
order_edit_id:
|
||||
type: string
|
||||
description: The ID of the order edit
|
||||
type: string
|
||||
example: oe_01G2SG30J8C85S4A5CHM2S1NS2
|
||||
order_edit:
|
||||
description: Available if the relation `order_edit` is expanded.
|
||||
nullable: true
|
||||
$ref: ./OrderEdit.yaml
|
||||
original_line_item_id:
|
||||
type: string
|
||||
description: The ID of the original line item in the order
|
||||
nullable: true
|
||||
type: string
|
||||
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
|
||||
original_line_item:
|
||||
description: Available if the relation `original_line_item` is expanded.
|
||||
nullable: true
|
||||
$ref: ./LineItem.yaml
|
||||
line_item_id:
|
||||
type: string
|
||||
description: The ID of the cloned line item.
|
||||
nullable: true
|
||||
type: string
|
||||
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
|
||||
line_item:
|
||||
description: Available if the relation `line_item` is expanded.
|
||||
nullable: true
|
||||
$ref: ./LineItem.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
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user