RefundLineItem object

Version 2020-01 (Release candidate)

Represents the details about a refunded line item.

Required access

read_orders access scope

Fields

lineItem (LineItem!)

Returns a LineItem resource. This represents the LineItem in the non-refund context.

location (Location)

The inventory restock location.

priceSet (MoneyBag!)

Returns the price of a refunded line item in shop and presentment currencies.

quantity (Int!)

Returns the quantity of a refunded line item.

restockType (RefundLineItemRestockType!)

Represents the type of restock for the refunded line item.

restocked (Boolean!)

Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund.

subtotalSet (MoneyBag!)

Returns the subtotal price of a refunded line item in shop and presentment currencies.

totalTaxSet (MoneyBag!)

Returns the total tax charged on a refunded line item in shop and presentment currencies.

Types that return RefundLineItem

Deprecated fields

Show/Hide
price (Money!) deprecated

Returns the price of a refunded line item.

Deprecation warning

Use priceSet instead

refundType (RefundLineItemRefundType!) deprecated

Represents the type of restock for the refunded line item.

Deprecation warning

Use restockType instead

subtotal (Money!) deprecated

Returns the subtotal price of a refunded line item.

Deprecation warning

Use subtotalSet instead

totalTax (Money!) deprecated

Returns the total tax charged on a refunded line item.

Deprecation warning

Use totalTaxSet instead

Version 2019-10 (Latest)

Represents the details about a refunded line item.

Required access

read_orders access scope

Fields

lineItem (LineItem!)

Returns a LineItem resource. This represents the LineItem in the non-refund context.

location (Location)

The inventory restock location.

priceSet (MoneyBag!)

Returns the price of a refunded line item in shop and presentment currencies.

quantity (Int!)

Returns the quantity of a refunded line item.

restockType (RefundLineItemRestockType!)

Represents the type of restock for the refunded line item.

restocked (Boolean!)

Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund.

subtotalSet (MoneyBag!)

Returns the subtotal price of a refunded line item in shop and presentment currencies.

totalTaxSet (MoneyBag!)

Returns the total tax charged on a refunded line item in shop and presentment currencies.

Types that return RefundLineItem

Deprecated fields

Show/Hide
price (Money!) deprecated

Returns the price of a refunded line item.

Deprecation warning

Use priceSet instead

refundType (RefundLineItemRefundType!) deprecated

Represents the type of restock for the refunded line item.

Deprecation warning

Use restockType instead

subtotal (Money!) deprecated

Returns the subtotal price of a refunded line item.

Deprecation warning

Use subtotalSet instead

totalTax (Money!) deprecated

Returns the total tax charged on a refunded line item.

Deprecation warning

Use totalTaxSet instead

Version 2019-07

Represents the details about a refunded line item.

Required access

read_orders access scope

Fields

lineItem (LineItem!)

Returns a LineItem resource. This represents the LineItem in the non-refund context.

location (Location)

The inventory restock location.

priceSet (MoneyBag!)

Returns the price of a refunded line item in shop and presentment currencies.

quantity (Int!)

Returns the quantity of a refunded line item.

restockType (RefundLineItemRestockType!)

Represents the type of restock for the refunded line item.

restocked (Boolean!)

Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund.

subtotalSet (MoneyBag!)

Returns the subtotal price of a refunded line item in shop and presentment currencies.

totalTaxSet (MoneyBag!)

Returns the total tax charged on a refunded line item in shop and presentment currencies.

Types that return RefundLineItem

Deprecated fields

Show/Hide
price (Money!) deprecated

Returns the price of a refunded line item.

Deprecation warning

Use priceSet instead

refundType (RefundLineItemRefundType!) deprecated

Represents the type of restock for the refunded line item.

Deprecation warning

Use restockType instead

subtotal (Money!) deprecated

Returns the subtotal price of a refunded line item.

Deprecation warning

Use subtotalSet instead

totalTax (Money!) deprecated

Returns the total tax charged on a refunded line item.

Deprecation warning

Use totalTaxSet instead

Version 2019-04

Represents the details about a refunded line item.

Required access

read_orders access scope

Fields

lineItem (LineItem!)

Returns a LineItem resource. This represents the LineItem in the non-refund context.

location (Location)

The inventory restock location.

priceSet (MoneyBag!)

Returns the price of a refunded line item in shop and presentment currencies.

quantity (Int!)

Returns the quantity of a refunded line item.

restockType (RefundLineItemRestockType!)

Represents the type of restock for the refunded line item.

restocked (Boolean!)

Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund.

subtotalSet (MoneyBag!)

Returns the subtotal price of a refunded line item in shop and presentment currencies.

totalTaxSet (MoneyBag!)

Returns the total tax charged on a refunded line item in shop and presentment currencies.

Types that return RefundLineItem

Deprecated fields

Show/Hide
price (Money!) deprecated

Returns the price of a refunded line item.

Deprecation warning

Use priceSet instead

refundType (RefundLineItemRefundType!) deprecated

Represents the type of restock for the refunded line item.

Deprecation warning

Use restockType instead

subtotal (Money!) deprecated

Returns the subtotal price of a refunded line item.

Deprecation warning

Use subtotalSet instead

totalTax (Money!) deprecated

Returns the total tax charged on a refunded line item.

Deprecation warning

Use totalTaxSet instead

Sign up for a Partner account to get started.

Sign up