daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
3.8 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminPostOrdersOrderReq
internal.internal.AdminPostOrdersOrderReq
Schema
AdminPostOrdersOrderReq
type: object
properties:
email:
description: the email associated with the order
type: string
billing_address:
description: The order's billing address
$ref: "#/components/schemas/AddressPayload"
shipping_address:
description: The order's shipping address
$ref: "#/components/schemas/AddressPayload"
items:
description: The line items of the order
type: array
items:
$ref: "#/components/schemas/LineItem"
region:
description: ID of the region that the order is associated with.
type: string
discounts:
description: The discounts applied to the order
type: array
items:
$ref: "#/components/schemas/Discount"
customer_id:
description: The ID of the customer associated with the order.
type: string
payment_method:
description: The payment method chosen for the order.
type: object
properties:
provider_id:
type: string
description: The ID of the payment provider.
data:
description: Any data relevant for the given payment method.
type: object
shipping_method:
description: The Shipping Method used for shipping the order.
type: object
properties:
provider_id:
type: string
description: The ID of the shipping provider.
profile_id:
type: string
description: The ID of the shipping profile.
price:
type: integer
description: The price of the shipping.
data:
type: object
description: Any data relevant to the specific shipping method.
items:
type: array
items:
$ref: "#/components/schemas/LineItem"
description: Items to ship
no_notification:
description: If set to true, no notification will be sent to the customer related to this order.
type: boolean
Properties
billing_address
• Optional billing_address: AddressPayload
Defined in
packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:136
customer_id
• Optional customer_id: string
Defined in
packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:141
discounts
• Optional discounts: Record<string, unknown>[]
Defined in
packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:140
• Optional email: string
Defined in
packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:135
items
• Optional items: Record<string, unknown>[]
Defined in
packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:138
no_notification
• Optional no_notification: boolean
Defined in
packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:144
payment_method
• Optional payment_method: PaymentMethod
Defined in
packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:142
region
• Optional region: string
Defined in
packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:139
shipping_address
• Optional shipping_address: AddressPayload
Defined in
packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:137
shipping_method
• Optional shipping_method: ShippingMethod[]
Defined in
packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:143