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: DraftOrder
description: Represents a draft order
description: >-
A draft order is created by an admin without direct involvement of the
customer. Once its payment is marked as captured, it is transformed into an
order.
type: object
required:
- canceled_at
@@ -20,7 +23,9 @@ properties:
type: string
example: dorder_01G8TJFKBG38YYFQ035MSVG03C
status:
description: The status of the draft order
description: >-
The status of the draft order. It's changed to `completed` when it's
transformed to an order.
type: string
enum:
- open
@@ -36,16 +41,22 @@ properties:
type: string
example: cart_01G8ZH853Y6TFXWPG5EYE81X63
cart:
description: A cart object. Available if the relation `cart` is expanded.
description: The details of the cart associated with the draft order.
x-expandable: cart
nullable: true
type: object
order_id:
description: The ID of the order associated with the draft order.
description: >-
The ID of the order created from the draft order when its payment is
captured.
nullable: true
type: string
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
order:
description: An order object. Available if the relation `order` is expanded.
description: >-
The details of the order created from the draft order when its payment is
captured.
x-expandable: order
nullable: true
type: object
canceled_at:
@@ -86,3 +97,7 @@ properties:
type: object
example:
car: white
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute