Refund
Requires access scope or access scope.
A Product or being refunded from an order. Each refund line item tracks the quantity, pricing, and restocking details for items returned to the merchant.
The refund line item links to the original from the Order and includes financial information such as the refunded price, subtotal, and taxes in both shop and presentment currencies. The field indicates whether and how the merchant restocks the returned items to inventory, while the location field specifies where restocking occurs.
Anchor to FieldsFields
- id (ID)
- lineItem (LineItem!)
- location (Location)
- priceSet (MoneyBag!)
- quantity (Int!)
- restocked (Boolean!)
- restockType (RefundLineItemRestockType!)
- subtotalSet (MoneyBag!)
- totalTaxSet (MoneyBag!)
- •ID
A globally-unique ID.
- Anchor to lineItemline•Line
Item Item! non-null The
resource associated to the refunded line item.- Anchor to locationlocation•Location
The inventory restock location.
- Anchor to priceSetprice•Money
Set Bag! non-null The price of a refunded line item in shop and presentment currencies.
- Anchor to quantityquantity•Int!non-null
The quantity of a refunded line item.
- Anchor to restockedrestocked•Boolean!non-null
Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund.
- Anchor to restockTyperestock•Refund
Type Line Item Restock Type! non-null The type of restock for the refunded line item.
- Anchor to subtotalSetsubtotal•Money
Set Bag! non-null The subtotal price of a refunded line item in shop and presentment currencies.
- Anchor to totalTaxSettotal•Money
Tax Set Bag! non-null The total tax charged on a refunded line item in shop and presentment currencies.
Deprecated fields
- price (Money!): deprecated
- subtotal (Money!): deprecated
- totalTax (Money!): deprecated
- Anchor to priceprice•Money!non-nullDeprecated
- Anchor to subtotalsubtotal•Money!non-nullDeprecated
- Anchor to totalTaxtotal•Money!
Tax non-nullDeprecated