type: object
description: The details of the draft order to create.
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: ./AddressPayload.yaml
      - type: string
  shipping_address:
    description: The Address to be used for shipping purposes.
    anyOf:
      - $ref: ./AddressPayload.yaml
      - 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