Refunds

Columns

Name

Type

ReadOnly

Description

Id [KEY]

Long

True

The unique identifier for the refund.

OrderId

Long

False

The id of the order.

OrderUpdatedAt

Datetime

True

The date and time when the order was last modified.

Note

String

False

The optional note attached to a refund.

Restock

Boolean

True

Whether or not the line items were added back to the store inventory.

UserId

Long

True

The unique identifier of the user who performed the refund.

CreatedAt

Datetime

True

The date and time when the refund was created.

ProcessedAt

Datetime

True

The date and time when the refund was imported.

LineAggregate

String

False

A JSON aggregate of line items associated with the refund.

OrderTransactionAggregate

String

False

A JSON aggregate of transactions associated with the refund.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name

Type

Description

Notify

Boolean

Whether or not to send a refund notification to the customer.

DiscrepancyReason

String

An optional comment, used if there is a discrepancy between calculated and actual refund amounts (one of: restock, damage, customer, other)

ShippingAmount

Decimal

Set specific amount of shipping to refund. Takes precedence over FullRefund.

ShippingFullRefund

Boolean

Whether or not to to refund all remaining shipping.

CalculateRefund

Boolean

Set to true to simply calculate the refund but not process it

The default value is false.

Last updated