Create refund with restock_all_items accounting for existing partial refunds
Authorizations
Bearer token authentication
Body
ID of the order to refund.
Which portion of the order to refund.
all, tax, shipping, product_price, cv, qv, partial Optional human-readable reason for the refund.
Amount to refund (used with partial/custom types).
Shipping amount to refund.
Tax amount to refund.
CV (commissionable volume) to deduct with the refund.
QV (qualifying volume) to deduct with the refund.
When true, restock every remaining (not-yet-refunded) order item.
Specific items to restock; ignored when restock_all_items is true.
When true and the order was paid with a split card+points payment, refund all redeemed points back to the customer. No-op if the order has no points portion or points have already been refunded.
Whether this refund also ends the sale. When true and the refund leaves the order fully refunded and still unshipped, the order is cancelled. Omit the field to take the company default; send false to refund without cancelling, as for a goodwill refund on an order that should still ship.
Response
Refund created
Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract.