---
displayed_sidebar: servicesSidebar
---

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

# ClaimOrder

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.

## Constructors

#### constructor

`**new ClaimOrder**()`

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.

## Properties

<ParameterTypes parameters={[
  {
    "name": "additional_items",
    "type": "[LineItem](LineItem.mdx)[]",
    "description": "The details of the new items to be shipped when the claim's type is `replace`",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": []
  },
  {
    "name": "canceled_at",
    "type": "`Date`",
    "description": "The date with timezone at which the claim was canceled.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "claim_items",
    "type": "[ClaimItem](ClaimItem.mdx)[]",
    "description": "The details of the items that should be replaced or refunded.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": []
  },
  {
    "name": "created_at",
    "type": "`Date`",
    "description": "The date with timezone at which the resource was created.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "deleted_at",
    "type": "`Date`",
    "description": "The date with timezone at which the resource was deleted.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "fulfillment_status",
    "type": "[ClaimFulfillmentStatus](../enums/ClaimFulfillmentStatus.mdx)",
    "description": "The claim's fulfillment status",
    "optional": false,
    "defaultValue": "not_fulfilled",
    "expandable": false,
    "children": []
  },
  {
    "name": "fulfillments",
    "type": "[Fulfillment](Fulfillment.mdx)[]",
    "description": "The fulfillments of the new items to be shipped",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": []
  },
  {
    "name": "id",
    "type": "`string`",
    "description": "The claim's ID",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "idempotency_key",
    "type": "`string`",
    "description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "metadata",
    "type": "`Record<string, unknown>`",
    "description": "An optional key-value map with additional details",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "no_notification",
    "type": "`boolean`",
    "description": "Flag for describing whether or not notifications related to this should be send.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "order",
    "type": "[Order](Order.mdx)",
    "description": "The details of the order that this claim was created for.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": []
  },
  {
    "name": "order_id",
    "type": "`string`",
    "description": "The ID of the order that the claim comes from.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "payment_status",
    "type": "[ClaimPaymentStatus](../enums/ClaimPaymentStatus.mdx)",
    "description": "The status of the claim's payment",
    "optional": false,
    "defaultValue": "na",
    "expandable": false,
    "children": []
  },
  {
    "name": "refund_amount",
    "type": "`number`",
    "description": "The amount that will be refunded in conjunction with the claim",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "return_order",
    "type": "[Return](Return.mdx)",
    "description": "The details of the return associated with the claim if the claim's type is `replace`.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": []
  },
  {
    "name": "shipping_address",
    "type": "[Address](Address.mdx)",
    "description": "The details of the address that new items should be shipped to.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": []
  },
  {
    "name": "shipping_address_id",
    "type": "`string`",
    "description": "The ID of the address that the new items should be shipped to",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "shipping_methods",
    "type": "[ShippingMethod](ShippingMethod.mdx)[]",
    "description": "The details of the shipping methods that the claim order will be shipped with.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": []
  },
  {
    "name": "type",
    "type": "[ClaimType](../enums/ClaimType.mdx)",
    "description": "The claim's type",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "updated_at",
    "type": "`Date`",
    "description": "The date with timezone at which the resource was updated.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

## Methods

#### beforeInsert

`Private **beforeInsert**(): void`

##### Returns

`void`

<ParameterTypes parameters={[
  {
    "name": "void",
    "type": "`void`",
    "optional": true,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />
