Skip to main content
Skip to main content

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

idstringRequired
The claim item's ID
created_atDateRequired
The date with timezone at which the resource was created.
updated_atDateRequired
The date with timezone at which the resource was updated.
deleted_atnull | DateRequired
The date with timezone at which the resource was deleted.
imagesClaimImage[]Required
The claim images that are attached to the claim item.
claim_order_idstringRequired
The ID of the claim this item is associated with.
claim_orderClaimOrderRequired
The details of the claim this item belongs to.
item_idstringRequired
The ID of the line item that the claim item refers to.
itemLineItemRequired
The details of the line item in the original order that this claim item refers to.
variant_idstringRequired
The ID of the product variant that is claimed.
variantProductVariantRequired
The details of the product variant to potentially replace the item in the original order.
reasonClaimReasonRequired
The reason for the claim
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.
tagsClaimTag[]Required
User defined tags for easy filtering and grouping.
metadataRecord<string, unknown>Required
An optional key-value map with additional details
Was this section helpful?