type: object
description: The details of the claim to be created.
required:
  - type
  - claim_items
properties:
  type:
    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.
    type: string
    enum:
      - replace
      - refund
  claim_items:
    description: The Claim Items that the Claim will consist of.
    type: array
    items:
      type: object
      required:
        - item_id
        - quantity
      properties:
        item_id:
          description: The ID of the Line Item that will be claimed.
          type: string
        quantity:
          description: The number of items that will be returned
          type: integer
        note:
          description: Short text describing the Claim Item in further detail.
          type: string
        reason:
          description: The reason for the Claim
          type: string
          enum:
            - missing_item
            - wrong_item
            - production_failure
            - other
        tags:
          description: A list of tags to add to the Claim Item
          type: array
          items:
            type: string
        images:
          description: A list of image URL's that will be associated with the Claim
          items:
            type: string
  return_shipping:
    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.
    type: object
    properties:
      option_id:
        type: string
        description: The ID of the Shipping Option to create the Shipping Method from.
      price:
        type: integer
        description: The price to charge for the Shipping Method.
  additional_items:
    description: >-
      The new items to send to the Customer. This is only used if the claim's
      type is `replace`.
    type: array
    items:
      type: object
      required:
        - variant_id
        - quantity
      properties:
        variant_id:
          description: The ID of the Product Variant.
          type: string
        quantity:
          description: The quantity of the Product Variant.
          type: integer
  shipping_methods:
    description: >-
      The Shipping Methods to send the additional Line Items with. This is only
      used if the claim's type is `replace`.
    type: array
    items:
      type: object
      properties:
        id:
          description: The ID of an existing Shipping Method
          type: string
        option_id:
          description: The ID of the Shipping Option to create a Shipping Method from
          type: string
        price:
          description: The price to charge for the Shipping Method
          type: integer
        data:
          description: An optional set of key-value pairs to hold additional information.
          type: object
  shipping_address:
    description: >-
      An optional shipping address to send the claimed items to. If not
      provided, the parent order's shipping address will be used.
    $ref: ./AddressPayload.yaml
  refund_amount:
    description: >-
      The amount to refund the customer. This is used when the claim's type is
      `refund`.
    type: integer
  no_notification:
    description: If set to true no notification will be send related to this Claim.
    type: boolean
  return_location_id:
    description: The ID of the location used for the associated return.
    type: string
  metadata:
    description: An optional set of key-value pairs to hold additional information.
    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