---
displayed_sidebar: homepage
---

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

# AdminPostOrdersOrderClaimsReq

The details of the claim to be created.

## Properties

<ParameterTypes parameters={[
  {
    "name": "additional_items",
    "type": "[AdditionalItem](medusa.AdditionalItem.mdx)[]",
    "description": "The new items to send to the Customer. This is only used if the claim's type is `replace`.",
    "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": "claim_items",
    "type": "[Item](medusa.Item-2.mdx)[]",
    "description": "The Claim Items that the Claim will consist of.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "images",
        "type": "`string`[]",
        "description": "A list of image URL's that will be associated with the Claim",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "item_id",
        "type": "`string`",
        "description": "The ID of the Line Item that will be claimed.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "note",
        "type": "`string`",
        "description": "Short text describing the Claim Item in further detail.",
        "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",
        "type": "[ClaimReason](../../entities/enums/entities.ClaimReason.mdx)",
        "description": "The reason for the Claim",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "tags",
        "type": "`string`[]",
        "description": "A list of tags to add to the Claim Item",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "metadata",
    "type": "`Record<string, unknown>`",
    "description": "An optional set of key-value pairs to hold additional information.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "no_notification",
    "type": "`boolean`",
    "description": "If set to true no notification will be send related to this Claim.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "refund_amount",
    "type": "`number`",
    "description": "The amount to refund the customer. This is used when the claim's type is `refund`.",
    "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.mdx)",
    "description": "Optional details for the Return Shipping Method, if the items are to be sent back. Providing this field will result in a return being created and associated with the claim.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "option_id",
        "type": "`string`",
        "description": "The ID of the shipping option used for the return.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "price",
        "type": "`number`",
        "description": "The shipping method's price.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "shipping_address",
    "type": "[AddressPayload](medusa.AddressPayload.mdx)",
    "description": "An optional shipping address to send the claimed items to. If not provided, the parent order's shipping address will be used.",
    "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_methods",
    "type": "[ShippingMethod](medusa.ShippingMethod-1.mdx)[]",
    "description": "The Shipping Methods to send the additional Line Items with. This is only used if the claim's type is `replace`.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "data",
        "type": "`Record<string, unknown>`",
        "description": "An optional set of key-value pairs to hold additional information.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of an existing Shipping Method",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "option_id",
        "type": "`string`",
        "description": "The ID of the Shipping Option to create a Shipping Method from",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "price",
        "type": "`number`",
        "description": "The price to charge for the Shipping Method",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "type",
    "type": "`\"replace\"` \\| `\"refund\"`",
    "description": "The type of the Claim. This will determine how the Claim is treated: `replace` Claims will result in a Fulfillment with new items being created, while a `refund` Claim will refund the amount paid for the claimed items.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
