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

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

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-12-22 17:09:49 +02:00
committed by GitHub
parent 233d6904f8
commit 4814045036
477 changed files with 17312 additions and 17713 deletions
Download Patch File Download Diff File Expand all files Collapse all files

105
docs/api/admin/paths/draft-orders.yaml
View File

@@ -7,106 +7,7 @@ post:
content:
application/json:
schema:
type: object
required:
- email
- items
- region_id
- shipping_methods
properties:
status:
description: The status of the draft order
type: string
enum:
- open
- completed
email:
description: The email of the customer of the draft order
type: string
format: email
billing_address:
description: The Address to be used for billing purposes.
anyOf:
- $ref: ../components/schemas/address_fields.yaml
- type: string
shipping_address:
description: The Address to be used for shipping.
anyOf:
- $ref: ../components/schemas/address_fields.yaml
- type: string
items:
description: The Line Items that have been received.
type: array
items:
type: object
required:
- quantity
properties:
variant_id:
description: >-
The ID of the Product Variant to generate the Line Item
from.
type: string
unit_price:
description: The potential custom price of the item.
type: integer
title:
description: The potential custom title of the item.
type: string
quantity:
description: The quantity of the Line Item.
type: integer
metadata:
description: >-
The optional key-value map with additional details about
the Line Item.
type: object
region_id:
description: The ID of the region for the draft order
type: string
discounts:
description: The discounts to add on the draft order
type: array
items:
type: object
required:
- code
properties:
code:
description: The code of the discount to apply
type: string
customer_id:
description: The ID of the customer to add on the draft order
type: string
no_notification_order:
description: >-
An optional flag passed to the resulting order to determine use
of notifications.
type: boolean
shipping_methods:
description: The shipping methods for the draft order
type: array
items:
type: object
required:
- option_id
properties:
option_id:
description: The ID of the shipping option in use
type: string
data:
description: >-
The optional additional data needed for the shipping
method
type: object
price:
description: The potential custom price of the shipping
type: integer
metadata:
description: >-
The optional key-value map with additional details about the
Draft Order.
type: object
$ref: ../components/schemas/AdminPostDraftOrdersReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
@@ -130,7 +31,7 @@ post:
type: object
properties:
draft_order:
$ref: ../components/schemas/draft-order.yaml
$ref: ../components/schemas/DraftOrder.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -193,7 +94,7 @@ get:
draft_orders:
type: array
items:
$ref: ../components/schemas/draft-order.yaml
$ref: ../components/schemas/DraftOrder.yaml
count:
type: integer
description: The total number of items available