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:
committed by
GitHub
parent
efdea04963
commit
658339767b
@@ -1,5 +1,8 @@
|
||||
title: Order Edit
|
||||
description: Order edit keeps track of order items changes.
|
||||
description: >-
|
||||
Order edit allows modifying items in an order, such as adding, updating, or
|
||||
deleting items from the original order. Once the order edit is confirmed, the
|
||||
changes are reflected on the original order.
|
||||
type: object
|
||||
required:
|
||||
- canceled_at
|
||||
@@ -29,11 +32,13 @@ properties:
|
||||
type: string
|
||||
example: order_01G2SG30J8C85S4A5CHM2S1NS2
|
||||
order:
|
||||
description: Available if the relation `order` is expanded.
|
||||
description: The details of the order that this order edit was created for.
|
||||
x-expandable: order
|
||||
nullable: true
|
||||
type: object
|
||||
changes:
|
||||
description: Available if the relation `changes` is expanded.
|
||||
description: The details of all the changes on the original order's line items.
|
||||
x-expandable: changes
|
||||
type: array
|
||||
items:
|
||||
$ref: ./OrderItemChange.yaml
|
||||
@@ -135,8 +140,12 @@ properties:
|
||||
- created
|
||||
- canceled
|
||||
items:
|
||||
description: Available if the relation `items` is expanded.
|
||||
description: >-
|
||||
The details of the cloned items from the original order with the new
|
||||
changes. Once the order edit is confirmed, these line items are associated
|
||||
with the original order.
|
||||
type: array
|
||||
x-expandable: items
|
||||
items:
|
||||
$ref: ./LineItem.yaml
|
||||
payment_collection_id:
|
||||
@@ -145,7 +154,10 @@ properties:
|
||||
type: string
|
||||
example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
|
||||
payment_collection:
|
||||
description: Available if the relation `payment_collection` is expanded.
|
||||
description: >-
|
||||
The details of the payment collection used to authorize additional payment
|
||||
if necessary.
|
||||
x-expandable: payment_collection
|
||||
nullable: true
|
||||
$ref: ./PaymentCollection.yaml
|
||||
created_at:
|
||||
|
||||
Reference in New Issue
Block a user