Get Bag Refunds
/v1/orders/{order_id}/bags/{bag_id}/refunds
curl --request GET \
--url https://sandbox-api.violet.io/v1/orders/{order_id}/bags/{bag_id}/refunds
[
{
"amount": "integer",
"app_id": "integer",
"bag_id": "integer",
"date_created": "string",
"date_last_modified": "string",
"developer_transfer_reversal_amount_usd": "integer",
"errors": [
{
"error_code": "integer",
"error_message": "string",
"id": "integer",
"refund_id": "integer"
}
],
"external_id": "string",
"gateway_transaction_id": "string",
"id": "integer",
"merchant_id": "integer",
"merchant_transfer_reversal_amount_usd": "integer",
"order_id": "integer",
"reason": "string",
"refund_currency": "string",
"skus": [
{
"bag_id": "integer",
"external_id": "string",
"id": "integer",
"order_sku_id": "integer",
"quantity_refunded": "integer",
"refund_id": "integer"
}
],
"status": "PROCESSING",
"transaction_id": "integer"
}
]
Retrieve any refunds associated to a Bag
given an order_id
and bag_id
.
Refunds are controlled by Merchants, which is why they are at the Bag
level. If your shopper placed an order that contained multiple merchants and only returned items for one merchant, then a refund record would only exist for one merchant.
Headers
Path Parameters
Response
Amount being refunded
ID of the App that created the Order
ID of the Bag being refunded
Date of creation
Date of last update
Amount being taken back from the associated transfer to the developer
List of errors associated to this refund during processing.
ID of the refund on the external commerce platform.
ID of the Transaction in the Payment Gateway
ID of the merchant making the refund
Amount being taken back from the associated transfer to the merchant
ID of the Order being refunded
Reason for refund
Currency set for this refund by the external ecom platform
SKUs the refund applies to
Status of the Refund
PROCESSING
, COMPLETED
, CANCELED
, PARTIALLY_COMPLETED
, FAILED
, EXTERNAL
ID of the Transaction being refunded
curl --request GET \
--url https://sandbox-api.violet.io/v1/orders/{order_id}/bags/{bag_id}/refunds
[
{
"amount": "integer",
"app_id": "integer",
"bag_id": "integer",
"date_created": "string",
"date_last_modified": "string",
"developer_transfer_reversal_amount_usd": "integer",
"errors": [
{
"error_code": "integer",
"error_message": "string",
"id": "integer",
"refund_id": "integer"
}
],
"external_id": "string",
"gateway_transaction_id": "string",
"id": "integer",
"merchant_id": "integer",
"merchant_transfer_reversal_amount_usd": "integer",
"order_id": "integer",
"reason": "string",
"refund_currency": "string",
"skus": [
{
"bag_id": "integer",
"external_id": "string",
"id": "integer",
"order_sku_id": "integer",
"quantity_refunded": "integer",
"refund_id": "integer"
}
],
"status": "PROCESSING",
"transaction_id": "integer"
}
]