medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersReq.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: AdminPostDraftOrdersReq

internal.internal.AdminPostDraftOrdersReq

Schema

AdminPostDraftOrdersReq type: object required:

• email
• region_id
• shipping_methods properties: status: 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, 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/AddressPayload"
  • type: string shipping_address: description: "The Address to be used for shipping purposes." anyOf:
  • $ref: "#/components/schemas/AddressPayload"
  • type: string items: description: The draft order's line items. type: array items: type: object required:
    • quantity properties: variant_id: 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 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 title of the line item if variant_id is not provided. 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 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 to 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 this draft order is associated with. type: string no_notification_order: description: 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 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 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"

Properties

billing_address

• Optional billing_address: string | AddressPayload

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:186

---

customer_id

• Optional customer_id: string

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:191

---

discounts

• Optional discounts: Discount[]

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:190

---

email

• email: string

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:185

---

items

• Optional items: Item[]

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:188

---

metadata

• Optional metadata: Record<string, unknown>

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:194

---

no_notification_order

• Optional no_notification_order: boolean

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:192

---

region_id

• region_id: string

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:189

---

shipping_address

• Optional shipping_address: string | AddressPayload

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:187

---

shipping_methods

• shipping_methods: ShippingMethod[]

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:193

---

status

• Optional status: string

Defined in

packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:184