RefundItem

Overview

Provides details on individual line items for partial refunds. Line items can be identified using either LineItemID or SKU. If both are supplied, LineItemID takes precedence.

Field Name

Data Type

Description

LineItemID

int

Line item identifier generated by ChannelAdvisor and provided in GetOrderList. Required if SKU is not supplied.

SKU

string

SKU identifier of the item. Required if LineItemID is not supplied.

Amount

decimal

Amount to refund from the item price. This is the amount to refund for all refunded quantity, not per unit. Required if no other refund amounts are specified.

ShippingAmount

decimal

Amount to refund from the shipping cost for all refunded quantity.

ShippingTaxAmount

decimal

Amount to refund from the shipping tax for all refunded quantity.

TaxAmount

decimal

Amount to refund from the order tax for all refunded quantity.

RecyclingFee

decimal

Amount to refund from the recycling fee for all refunded quantity.

GiftWrapAmount

decimal

Amount to refund from the gift wrap cost for all refunded quantity.

GiftWrapTaxAmount

decimal

Amount to refund from the gift wrap tax for all refunded quantity.

Quantity

int

Quantity of items being refunded. Cannot be zero.

RefundRequestID

int

In the response to SubmitOrderRefund, contains the ID of the refund generated by ChannelAdvisor. Ignored in the request.

RefundRequested

boolean

In the response to SubmitOrderRefund, set to true if a refund is initiated or false if a refund is not initiated because the request failed validation. Ignored in request.

AdjustmentReason

RefundAdjustmentReason

Reason for the refund request. If a value is not supplied, then it defaults to GeneralAdjustment.

RestockQuantity

boolean

In the request, optionally specifies if inventory item quantity should be restocked from refunded line items and defaults to false if absent.
In the response, indicates if restocking successfully occurred.

SellerRefundID

string

An optional identifier provided by the seller.

References