Refund Bag
Bag refunds is in beta. Please report any errors to Violet.
Initiate a refund on a Bag. This can be a full refund or a partial refund depending on the amounts you provide. This action will attempt to refund the external order in the merchants system.
The Bag must be in a refundable state. Any Bag’s that have a status of IN_PROGRESS, REFUNDED, or CANCELED cannot be refunded.
Body
Request used to initiate a bag refund.
Custom reason message for the refund.
255Should the items be restocked. Set to true when the order is being returned.
Should the customer be notified by the merchants system of the refund. If no value is provided the merchants default system configuration for this feature will be used.
Amount that should be refunded in cents. If no value is provided the full bag amount will be refunded.
x > 0Details of any shipping refunds.
Sku level refund data. If no Sku's are provided then all Skus will be refunded.
Response
Order Refund
ID of the Order being refunded
ID of the merchant making the refund
ID of the App that created the Order
ID of the Transaction being refunded
ID of the Transaction in the Payment Gateway
Amount being refunded. In Cents
ID of the Bag being refunded
Amount being taken back from the associated transfer to the merchant. In Cents
Amount being taken back from the associated transfer to the developer. In Cents
Reason for refund
Reason code for refund
OTHER, CUSTOMER, INVENTORY, FRAUD, DECLINED Currency set for this refund by the external ecom platform
Status of the Refund
PROCESSING, COMPLETED, CANCELED, PARTIALLY_COMPLETED, FAILED, EXTERNAL SKUs the refund applies to
Date of creation
Date of last update
ID of the refund on the external commerce platform. This value will only be populated if the external commerce platform supports refund ID's.
List of errors associated to this refund during processing. This value will only be populated if there are errors during processing
Details of any refunded shipping amounts.
Tax amount being refunded. In Cents.
x > 0Was this page helpful?