medusa-store/www/apps/docs/content/references/medusa/classes/medusa.AdminPostOrdersOrderReq.mdx

---
displayed_sidebar: homepage
---

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

# AdminPostOrdersOrderReq

## Properties

<ParameterTypes parameters={[
  {
    "name": "billing_address",
    "type": "[AddressPayload](medusa.AddressPayload.mdx)",
    "description": "The order's billing address",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "address_1",
        "type": "`string`",
        "description": "Address line 1",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "address_2",
        "type": "`string`",
        "description": "Address line 2",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "city",
        "type": "`string`",
        "description": "City",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "company",
        "type": "`string`",
        "description": "Company",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "country_code",
        "type": "`string`",
        "description": "The 2 character ISO code of the country in lower case",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "first_name",
        "type": "`string`",
        "description": "First name",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "last_name",
        "type": "`string`",
        "description": "Last name",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "metadata",
        "type": "`Record<string, unknown>`",
        "description": "An optional key-value map with additional details",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "phone",
        "type": "`string`",
        "description": "Phone Number",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "postal_code",
        "type": "`string`",
        "description": "Postal Code",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "province",
        "type": "`string`",
        "description": "Province",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "customer_id",
    "type": "`string`",
    "description": "The ID of the customer associated with the order.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "discounts",
    "type": "`Record<string, unknown>`[]",
    "description": "The discounts applied to the order",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "email",
    "type": "`string`",
    "description": "The email associated with the order",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "items",
    "type": "`Record<string, unknown>`[]",
    "description": "The line items of the order",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "no_notification",
    "type": "`boolean`",
    "description": "If set to `true`, no notification will be sent to the customer related to this order.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "payment_method",
    "type": "[PaymentMethod](medusa.PaymentMethod.mdx)",
    "description": "The payment method chosen for the order.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "data",
        "type": "`Record<string, unknown>`",
        "description": "The data to attach to the payment.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "provider_id",
        "type": "`string`",
        "description": "The ID of the payment provider used in the order.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "region",
    "type": "`string`",
    "description": "ID of the region that the order is associated with.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "shipping_address",
    "type": "[AddressPayload](medusa.AddressPayload.mdx)",
    "description": "The order's shipping address",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "address_1",
        "type": "`string`",
        "description": "Address line 1",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "address_2",
        "type": "`string`",
        "description": "Address line 2",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "city",
        "type": "`string`",
        "description": "City",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "company",
        "type": "`string`",
        "description": "Company",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "country_code",
        "type": "`string`",
        "description": "The 2 character ISO code of the country in lower case",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "first_name",
        "type": "`string`",
        "description": "First name",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "last_name",
        "type": "`string`",
        "description": "Last name",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "metadata",
        "type": "`Record<string, unknown>`",
        "description": "An optional key-value map with additional details",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "phone",
        "type": "`string`",
        "description": "Phone Number",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "postal_code",
        "type": "`string`",
        "description": "Postal Code",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "province",
        "type": "`string`",
        "description": "Province",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "shipping_method",
    "type": "[ShippingMethod](medusa.ShippingMethod-3.mdx)[]",
    "description": "The Shipping Method used for shipping the order.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "data",
        "type": "`Record<string, unknown>`",
        "description": "The data to attach to the shipping method.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "items",
        "type": "`Record<string, unknown>`[]",
        "description": "The line items associated with this shipping methods.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "price",
        "type": "`number`",
        "description": "The price of the shipping method.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "profile_id",
        "type": "`string`",
        "description": "The ID of the shipping profile used in the order.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "provider_id",
        "type": "`string`",
        "description": "The ID of the shipping provider used in the order.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>