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.
Path parameters
order_idinteger · int64Required
bag_idinteger · int64Required
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body
Request used to initiate a bag refund.
reasonstring | nullableOptional
Custom reason message for the refund.
restock_itemsboolean | nullableOptionalDefault:
Should the items be restocked. Set to true
when the order is being returned.
false
notify_customerboolean | nullableOptionalDefault:
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.
false
amount_refundedinteger · int32 | nullableOptional
Amount that should be refunded in cents. If no value is provided the full bag amount will be refunded.
Responses
default
default response
application/json
post
POST /v1/orders/{order_id}/bags/{bag_id}/refunds HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 126
{
"amount_refunded": 1000,
"shipping": {
"amount": 500
},
"skus": [
{
"order_sku_id": 10000,
"quantity_refunded": 1,
"amount_refunded": 500
}
]
}
default
default response
{
"id": 1,
"order_id": 1,
"bag_id": 1,
"merchant_id": 1,
"app_id": 1,
"transaction_id": 1,
"payment_transaction_id": 1,
"gateway_transaction_id": "text",
"amount": 1,
"merchant_transfer_reversal_amount_usd": 1,
"developer_transfer_reversal_amount_usd": 1,
"merchant_transfer_reversal_amount_platform_currency": 1,
"developer_transfer_reversal_amount_platform_currency": 1,
"reason": "text",
"reason_code": "OTHER",
"refund_currency": "text",
"platform_currency": "text",
"status": "PROCESSING",
"skus": [
{
"id": 1,
"refund_id": 1,
"bag_id": 1,
"quantity_refunded": 1,
"external_id": "text",
"order_sku_id": 1
}
],
"transfer_reversals": [
"text"
],
"date_created": "2025-07-10T03:01:26.089Z",
"date_last_modified": "2025-07-10T03:01:26.089Z",
"external_id": "text",
"errors": [
{
"id": 1,
"error_code": 1,
"error_message": "text",
"resolved": true,
"date_resolved": "2025-07-10T03:01:26.089Z",
"date_created": "2025-07-10T03:01:26.089Z",
"refund_id": 1
}
],
"shipping": {
"amount": 1,
"tax_amount": 1,
"full_refund": true,
"discrepancy_reason": "text"
},
"tax_amount": 1
}
Last updated
Was this helpful?