---
displayed_sidebar: homepage
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# AdminPostDraftOrdersReq

## Properties

<ParameterTypes parameters={[
  {
    "name": "billing_address",
    "type": "`string` \\| [AddressPayload](medusa.AddressPayload.mdx)",
    "description": "The Address to be used for billing purposes.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "customer_id",
    "type": "`string`",
    "description": "The ID of the customer this draft order is associated with.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "discounts",
    "type": "[Discount](medusa.Discount.mdx)[]",
    "description": "The discounts to add to the draft order",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "code",
        "type": "`string`",
        "description": "The code of the discount to apply",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "email",
    "type": "`string`",
    "description": "The email of the customer of the draft order",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "items",
    "type": "[Item](medusa.Item-1.mdx)[]",
    "description": "The draft order's line items.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "metadata",
        "type": "`Record<string, unknown>`",
        "description": "The optional key-value map with additional details about the line item.",
        "optional": true,
        "defaultValue": "{}",
        "expandable": false,
        "children": []
      },
      {
        "name": "quantity",
        "type": "`number`",
        "description": "The quantity of the line item.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "title",
        "type": "`string`",
        "description": "The title of the line item if `variant\\_id` is not provided.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "unit_price",
        "type": "`number`",
        "description": "The custom price of the line item. If a `variant\\_id` is supplied, the price provided here will override the variant's price.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "variant_id",
        "type": "`string`",
        "description": "The ID of the Product Variant associated with the line item. If the line item is custom, the `variant\\_id` should be omitted.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "metadata",
    "type": "`Record<string, unknown>`",
    "description": "The optional key-value map with additional details about the Draft Order.",
    "optional": true,
    "defaultValue": "{}",
    "expandable": false,
    "children": []
  },
  {
    "name": "no_notification_order",
    "type": "`boolean`",
    "description": "An optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "region_id",
    "type": "`string`",
    "description": "The ID of the region for the draft order",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "shipping_address",
    "type": "`string` \\| [AddressPayload](medusa.AddressPayload.mdx)",
    "description": "The Address to be used for shipping purposes.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "shipping_methods",
    "type": "[ShippingMethod](medusa.ShippingMethod.mdx)[]",
    "description": "The shipping methods for the draft order",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "data",
        "type": "`Record<string, unknown>`",
        "description": "The optional additional data needed for the shipping method",
        "optional": true,
        "defaultValue": "{}",
        "expandable": false,
        "children": []
      },
      {
        "name": "option_id",
        "type": "`string`",
        "description": "The ID of the shipping option in use",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "price",
        "type": "`number`",
        "description": "The price of the shipping method.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "status",
    "type": "`string`",
    "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.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
