Refund order
Create a refund against an order. Multiple refunds are supported, but the total refunded quantity cannot exceed the original order quantity for each item. IMPORTANT: Refund prices and tax amounts are automatically calculated from the order. If the order had discounts applied, refunds will reflect the discounted prices (the actual amount paid). Do not send price or tax fields in the refund request - only itemId and quantity are required. Pass an idempotencyKey to make retries safe — a second request with the same key returns the original refund (HTTP 200) instead of creating a new one. Omitting idempotencyKey returns an X-TaxCloud-Warning response header recommending one; the refund is still created.
Authentication
Path parameters
Request
Optional opaque key uniquely identifying this refund within the (connection, order). When present, a second create attempt with the same key returns the original refund (HTTP 200) instead of creating a new one. Recommended for ETL or Service Bus consumers that may retry. Use a stable identifier from your source system (e.g. a Shopify refund GID), not a request UUID.
represents the items of the refund request, if an empty lists or no lists is passed it is assumed the entire order will be refunded. IMPORTANT: Prices and tax amounts are automatically calculated from the order. If the order had discounts, refunds will use the discounted prices (actual amount paid).
The date of the return; defaults to the current timestamp. Leave empty (recommended) to deduct the refund from the current month's filing. Setting to a prior-month date may trigger an amended filing.