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

26
docs/api/admin/components/schemas/AdminPostOrdersOrderReq.yaml
View File

@@ -1,39 +1,39 @@
type: object
properties:
email:
description: the email for the order
description: the email associated with the order
type: string
billing_address:
description: Billing address
description: The order's billing address
$ref: ./AddressPayload.yaml
shipping_address:
description: Shipping address
description: The order's shipping address
$ref: ./AddressPayload.yaml
items:
description: The Line Items for the order
description: The line items of the order
type: array
items:
$ref: ./LineItem.yaml
region:
description: ID of the region where the order belongs
description: ID of the region that the order is associated with.
type: string
discounts:
description: Discounts applied to the order
description: The discounts applied to the order
type: array
items:
$ref: ./Discount.yaml
customer_id:
description: ID of the customer
description: The ID of the customer associated with the order.
type: string
payment_method:
description: payment method chosen for the order
description: The payment method chosen for the order.
type: object
properties:
provider_id:
type: string
description: ID of the payment provider
description: The ID of the payment provider.
data:
description: Data relevant for the given payment method
description: Any data relevant for the given payment method.
type: object
shipping_method:
description: The Shipping Method used for shipping the order.
@@ -50,7 +50,7 @@ properties:
description: The price of the shipping.
data:
type: object
description: Data relevant to the specific shipping method.
description: Any data relevant to the specific shipping method.
items:
type: array
items:
@@ -58,6 +58,6 @@ properties:
description: Items to ship
no_notification:
description: >-
A flag to indicate if no notifications should be emitted related to the
updated order.
If set to `true`, no notification will be sent to the customer related to
this order.
type: boolean