Skip to main content
RefundedLineItem

Refunded products object schema.

Frank Birzle avatar
Written by Frank Birzle
Updated over a week ago

id

Type: string

Description: The (technical) unique identifier of the refunded line item of this order.

Example Value(s): '123123452345234908' or 'A-1231234-B-42342342-C'

lineItemId

Type: string

Description: The (technical) unique identifier of the order item in this order that was refunded, must correspond with the id used in the LineItem object.

Example Value(s): '123456789' or 'A-2344234230-B'

reasonDescriptor

Type: string

Description: Reason for returning that lineItem.

Example Value(s): 'too_small' or 'too_big' or 'other'

refundedQuantity

Type: number

Description: Amount of lineItems of that lineItemId that where refunded.

Example Value(s): 2

refundQuantity (DEPRECATED)

Type: string

Description: Amount of lineItems of that lineItemId that where refunded.

Example Value(s): '2'

createdAt

Type: number

Description: Unix timestamp in seconds of the time when the refund for that lineItem was created.

Example Value(s): 1678376546

processedAt

Type: number

Description: Unix timestamp in seconds of the time when the refund for that lineItem was processed.

Example Value(s): 1678376546

Did this answer your question?