medusa-store/www/api-reference/specs/admin/components/schemas/ClaimOrder.yaml

title: Claim
description: >-
  A Claim represents a group of faulty or missing items. It consists of claim
  items that refer to items in the original order that should be replaced or
  refunded. It also includes details related to shipping and fulfillment.
type: object
required:
  - canceled_at
  - created_at
  - deleted_at
  - fulfillment_status
  - id
  - idempotency_key
  - metadata
  - no_notification
  - order_id
  - payment_status
  - refund_amount
  - shipping_address_id
  - type
  - updated_at
properties:
  id:
    description: The claim's ID
    type: string
    example: claim_01G8ZH853Y6TFXWPG5EYE81X63
  type:
    description: The claim's type
    type: string
    enum:
      - refund
      - replace
  payment_status:
    description: The status of the claim's payment
    type: string
    enum:
      - na
      - not_refunded
      - refunded
    default: na
  fulfillment_status:
    description: The claim's fulfillment status
    type: string
    enum:
      - not_fulfilled
      - partially_fulfilled
      - fulfilled
      - partially_shipped
      - shipped
      - partially_returned
      - returned
      - canceled
      - requires_action
    default: not_fulfilled
  claim_items:
    description: The details of the items that should be replaced or refunded.
    type: array
    x-expandable: claim_items
    items:
      $ref: ./ClaimItem.yaml
  additional_items:
    description: >-
      The details of the new items to be shipped when the claim's type is
      `replace`
    type: array
    x-expandable: additional_items
    items:
      $ref: ./LineItem.yaml
  order_id:
    description: The ID of the order that the claim comes from.
    type: string
    example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
  order:
    description: The details of the order that this claim was created for.
    x-expandable: order
    nullable: true
    type: object
  return_order:
    description: >-
      The details of the return associated with the claim if the claim's type is
      `replace`.
    x-expandable: return_order
    nullable: true
    type: object
  shipping_address_id:
    description: The ID of the address that the new items should be shipped to
    nullable: true
    type: string
    example: addr_01G8ZH853YPY9B94857DY91YGW
  shipping_address:
    description: The details of the address that new items should be shipped to.
    x-expandable: shipping_address
    nullable: true
    $ref: ./Address.yaml
  shipping_methods:
    description: >-
      The details of the shipping methods that the claim order will be shipped
      with.
    type: array
    x-expandable: shipping_methods
    items:
      $ref: ./ShippingMethod.yaml
  fulfillments:
    description: The fulfillments of the new items to be shipped
    type: array
    x-expandable: fulfillments
    items:
      type: object
  refund_amount:
    description: The amount that will be refunded in conjunction with the claim
    nullable: true
    type: integer
    example: 1000
  canceled_at:
    description: The date with timezone at which the claim was canceled.
    nullable: true
    type: string
    format: date-time
  created_at:
    description: The date with timezone at which the resource was created.
    type: string
    format: date-time
  updated_at:
    description: The date with timezone at which the resource was updated.
    type: string
    format: date-time
  deleted_at:
    description: The date with timezone at which the resource was deleted.
    nullable: true
    type: string
    format: date-time
  metadata:
    description: An optional key-value map with additional details
    nullable: true
    type: object
    example:
      car: white
    externalDocs:
      description: Learn about the metadata attribute, and how to delete and update it.
      url: >-
        https://docs.medusajs.com/development/entities/overview#metadata-attribute
  no_notification:
    description: >-
      Flag for describing whether or not notifications related to this should be
      send.
    nullable: true
    type: boolean
    example: false
  idempotency_key:
    description: >-
      Randomly generated key used to continue the completion of the cart
      associated with the claim in case of failure.
    nullable: true
    type: string
    externalDocs:
      url: https://docs.medusajs.com/development/idempotency-key/overview.md
      description: Learn more how to use the idempotency key.