ClaimItem

A claim item is an item created as part of a claim. It references an item in the order that should be exchanged or refunded.

Properties

claim_orderClaimOrderRequired

The details of the claim this item belongs to.

claim_order_idstringRequired

The ID of the claim this item is associated with.

created_atDateRequired

The date with timezone at which the resource was created.

deleted_atnull | DateRequired

The date with timezone at which the resource was deleted.

idstringRequired

The claim item's ID

imagesClaimImage[]Required

The claim images that are attached to the claim item.

itemLineItemRequired

The details of the line item in the original order that this claim item refers to.

item_idstringRequired

The ID of the line item that the claim item refers to.

metadataRecord<string, unknown>Required

An optional key-value map with additional details

notestringRequired

An optional note about the claim, for additional information

quantitynumberRequired

The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.

reasonClaimReasonRequired

The reason for the claim

tagsClaimTag[]Required

User defined tags for easy filtering and grouping.

updated_atDateRequired

The date with timezone at which the resource was updated.

variantProductVariantRequired

The details of the product variant to potentially replace the item in the original order.

variant_idstringRequired

The ID of the product variant that is claimed.