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
idstringRequiredThe claim item's ID
created_atDateRequiredThe date with timezone at which the resource was created.
updated_atDateRequiredThe date with timezone at which the resource was updated.
deleted_atnull | DateRequiredThe date with timezone at which the resource was deleted.
The claim images that are attached to the claim item.
claim_order_idstringRequiredThe ID of the claim this item is associated with.
The details of the claim this item belongs to.
item_idstringRequiredThe ID of the line item that the claim item refers to.
The details of the line item in the original order that this claim item refers to.
variant_idstringRequiredThe ID of the product variant that is claimed.
The details of the product variant to potentially replace the item in the original order.
The reason for the claim
notestringRequiredAn optional note about the claim, for additional information
quantitynumberRequiredThe quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.
User defined tags for easy filtering and grouping.
metadataRecord<string, unknown>RequiredAn optional key-value map with additional details
Was this section helpful?