OrderAdjustment

object

Requires read_orders access scope or read_marketplace_orders access scope.

An order adjustment accounts for the difference between a calculated and actual refund amount.

Anchor to FieldsFields

Anchor to amountSetamountSet • MoneyBag!non-null: The amount of the order adjustment in shop and presentment currencies.
Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to reasonreason • OrderAdjustmentDiscrepancyReason: An optional reason that explains a discrepancy between calculated and actual refund amounts.
Anchor to taxAmountSettaxAmountSet • MoneyBag!non-null: The tax amount of the order adjustment in shop and presentment currencies.
Anchor to kindkind • OrderAdjustmentKind!non-nullDeprecated: The order adjustment type. OrderAdjustmentKind will be removed from unstable. Use Refund.refundShippingLines to query for refunded shipping costs.

Was this section helpful?

Was this section helpful?