--- displayed_sidebar: entitiesSidebar --- import ParameterTypes from "@site/src/components/ParameterTypes" # ClaimImage ## Properties [`ClaimItem`](ClaimItem.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](ClaimOrder.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "additional_items", "type": "[`LineItem`](LineItem.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "canceled_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "claim_items", "type": "[`ClaimItem`](ClaimItem.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "fulfillment_status", "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "fulfillments", "type": "[`Fulfillment`](Fulfillment.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "idempotency_key", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "no_notification", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "order", "type": "[`Order`](Order.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "order_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "payment_status", "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "refund_amount", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "return_order", "type": "[`Return`](Return.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_address", "type": "[`Address`](Address.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_address_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipping_methods", "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "type", "type": "[`ClaimType`](../enums/ClaimType.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "claim_order_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "images", "type": "[`ClaimImage`](ClaimImage.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ClaimImage`](ClaimImage.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "claim_item", "type": "[`ClaimItem`](ClaimItem.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "claim_item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "url", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "item", "type": "[`LineItem`](LineItem.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`LineItem`](LineItem.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "adjustments", "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "allow_discounts", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "cart", "type": "[`Cart`](Cart.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "cart_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "claim_order", "type": "[`ClaimOrder`](ClaimOrder.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "claim_order_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "description", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "discount_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "fulfilled_quantity", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "gift_card_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "has_shipping", "type": "``null`` \\| `boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "includes_tax", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_giftcard", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "is_return", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "order", "type": "[`Order`](Order.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "order_edit", "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "order_edit_id", "type": "``null`` \\| `string`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "order_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "original_item_id", "type": "``null`` \\| `string`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "original_tax_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "original_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "product_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "quantity", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "raw_discount_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "refundable", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "returned_quantity", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "shipped_quantity", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "should_merge", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "subtotal", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "swap", "type": "[`Swap`](Swap.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "swap_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_lines", "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "tax_total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "thumbnail", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "title", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "total", "type": "``null`` \\| `number`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "unit_price", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "variant", "type": "[`ProductVariant`](ProductVariant.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "variant_id", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "afterUpdateOrLoad", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeUpdate", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "note", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "quantity", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "reason", "type": "[`ClaimReason`](../enums/ClaimReason.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "MISSING_ITEM", "type": "``\"missing_item\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "OTHER", "type": "``\"other\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "PRODUCTION_FAILURE", "type": "``\"production_failure\"``", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "WRONG_ITEM", "type": "``\"wrong_item\"``", "description": "", "optional": true, "defaultValue": "", "children": [] } ] }, { "name": "tags", "type": "[`ClaimTag`](ClaimTag.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ClaimTag`](ClaimTag.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "value", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "variant", "type": "[`ProductVariant`](ProductVariant.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [ { "name": "constructor", "type": "() => [`ProductVariant`](ProductVariant.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "allow_backorder", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "barcode", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "ean", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "height", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "hs_code", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "inventory_items", "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "inventory_quantity", "type": "`number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "length", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "manage_inventory", "type": "`boolean`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "material", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "``null`` \\| Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "mid_code", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "options", "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "origin_country", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "prices", "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "product", "type": "[`Product`](Product.mdx)", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "product_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "purchasable", "type": "`boolean`", "description": "", "optional": true, "defaultValue": "", "children": [] }, { "name": "sku", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "title", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "upc", "type": "``null`` \\| `string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "variant_rank", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "weight", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "width", "type": "``null`` \\| `number`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "variant_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "beforeInsert", "type": "() => `void`", "description": "", "optional": false, "defaultValue": "", "children": [] } ] }, { "name": "claim_item_id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "created_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "deleted_at", "type": "``null`` \\| `Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "id", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "metadata", "type": "Record<`string`, `unknown`\\>", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "updated_at", "type": "`Date`", "description": "", "optional": false, "defaultValue": "", "children": [] }, { "name": "url", "type": "`string`", "description": "", "optional": false, "defaultValue": "", "children": [] } ]} />