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

---
displayed_sidebar: homepage
---

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

# AdminPostOrdersOrderSwapsReq

## Properties

<ParameterTypes parameters={[
  {
    "name": "additional_items",
    "type": "[AdditionalItem](medusa.AdditionalItem-1.mdx)[]",
    "description": "The new items to send to the Customer.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "quantity",
        "type": "`number`",
        "description": "The quantity of the Product Variant.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "variant_id",
        "type": "`string`",
        "description": "The ID of the Product Variant.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "allow_backorder",
    "type": "`boolean`",
    "description": "If set to `true`, swaps can be completed with items out of stock",
    "optional": true,
    "defaultValue": "true",
    "expandable": false,
    "children": []
  },
  {
    "name": "custom_shipping_options",
    "type": "[CustomShippingOption](medusa.CustomShippingOption.mdx)[]",
    "description": "An array of custom shipping options to potentially create a Shipping Method from to send the additional items.",
    "optional": true,
    "defaultValue": "[]",
    "expandable": false,
    "children": [
      {
        "name": "option_id",
        "type": "`string`",
        "description": "The ID of the Shipping Option.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "price",
        "type": "`number`",
        "description": "The custom price of the Shipping Option.",
        "optional": false,
        "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 Swap.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "return_items",
    "type": "[ReturnItem](medusa.ReturnItem.mdx)[]",
    "description": "The Line Items to associate with the swap's return.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "item_id",
        "type": "`string`",
        "description": "The ID of the Line Item that will be returned.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "note",
        "type": "`string`",
        "description": "An optional note with information about the Return.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "quantity",
        "type": "`number`",
        "description": "The number of items that will be returned",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "reason_id",
        "type": "`string`",
        "description": "The ID of the Return Reason to use.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "return_location_id",
    "type": "`string`",
    "description": "The ID of the location used for the associated return.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "return_shipping",
    "type": "[ReturnShipping](medusa.ReturnShipping-1.mdx)",
    "description": "The shipping method associated with the swap's return.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "option_id",
        "type": "`string`",
        "description": "The ID of the shipping option used for the return.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "price",
        "type": "`number`",
        "description": "The shipping method's price.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "sales_channel_id",
    "type": "`string`",
    "description": "The ID of the sales channel associated with the swap.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>