chore(docs): Generated API Reference (#2572)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
co-authored by
shahednasser
parent
884322447e
commit
325b1e9017
@@ -16,11 +16,11 @@ properties:
|
||||
description: The ID of the order that is edited
|
||||
example: order_01G2SG30J8C85S4A5CHM2S1NS2
|
||||
order:
|
||||
description: Order object
|
||||
description: Available if the relation `order` is expanded.
|
||||
$ref: ./order.yaml
|
||||
changes:
|
||||
type: array
|
||||
description: Line item changes array.
|
||||
description: Available if the relation `changes` is expanded.
|
||||
items:
|
||||
$ref: ./order_item_change.yaml
|
||||
internal_note:
|
||||
@@ -92,8 +92,32 @@ properties:
|
||||
The difference between the total amount of the order and total amount of
|
||||
edited order.
|
||||
example: 8200
|
||||
status:
|
||||
type: string
|
||||
description: The status of the order edit.
|
||||
enum:
|
||||
- confirmed
|
||||
- declined
|
||||
- requested
|
||||
- created
|
||||
- canceled
|
||||
items:
|
||||
type: array
|
||||
description: Computed line items from the changes.
|
||||
description: Available if the relation `items` is expanded.
|
||||
items:
|
||||
$ref: ./line_item.yaml
|
||||
payment_collection_id:
|
||||
type: string
|
||||
description: The ID of the payment collection
|
||||
example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
|
||||
payment_collection:
|
||||
description: Available if the relation `payment_collection` is expanded.
|
||||
$ref: ./payment_collection.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
format: date-time
|
||||
|
||||
Reference in New Issue
Block a user