asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

44
docs/api/admin/components/schemas/AdminPostDraftOrdersReq.yaml
View File

@@ -5,7 +5,9 @@ required:
- shipping_methods
properties:
status:
description: The status of the draft order
description: >-
The status of the draft order. The draft order's default status is `open`.
It's changed to `completed` when its payment is marked as paid.
type: string
enum:
- open
@@ -20,12 +22,12 @@ properties:
- $ref: ./AddressPayload.yaml
- type: string
shipping_address:
description: The Address to be used for shipping.
description: The Address to be used for shipping purposes.
anyOf:
- $ref: ./AddressPayload.yaml
- type: string
items:
description: The Line Items that have been received.
description: The draft order's line items.
type: array
items:
type: object
@@ -33,27 +35,37 @@ properties:
- quantity
properties:
variant_id:
description: The ID of the Product Variant to generate the Line Item from.
description: >-
The ID of the Product Variant associated with the line item. If the
line item is custom, the `variant_id` should be omitted.
type: string
unit_price:
description: The potential custom price of the item.
description: >-
The custom price of the line item. If a `variant_id` is supplied,
the price provided here will override the variant's price.
type: integer
title:
description: The potential custom title of the item.
description: The title of the line item if `variant_id` is not provided.
type: string
quantity:
description: The quantity of the Line Item.
description: The quantity of the line item.
type: integer
metadata:
description: >-
The optional key-value map with additional details about the Line
Item.
The optional key-value map with additional details about the line
item.
type: object
externalDocs:
description: >-
Learn about the metadata attribute, and how to delete and update
it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute
region_id:
description: The ID of the region for the draft order
type: string
discounts:
description: The discounts to add on the draft order
description: The discounts to add to the draft order
type: array
items:
type: object
@@ -64,12 +76,12 @@ properties:
description: The code of the discount to apply
type: string
customer_id:
description: The ID of the customer to add on the draft order
description: The ID of the customer this draft order is associated with.
type: string
no_notification_order:
description: >-
An optional flag passed to the resulting order to determine use of
notifications.
An optional flag passed to the resulting order that indicates whether the
customer should receive notifications about order updates.
type: boolean
shipping_methods:
description: The shipping methods for the draft order
@@ -86,8 +98,12 @@ properties:
description: The optional additional data needed for the shipping method
type: object
price:
description: The potential custom price of the shipping
description: The price of the shipping method.
type: integer
metadata:
description: The optional key-value map with additional details about the Draft Order.
type: object
externalDocs:
description: Learn about the metadata attribute, and how to delete and update it.
url: >-
https://docs.medusajs.com/development/entities/overview#metadata-attribute