GET
/
orders
/
{order_id}
/
bags
/
{bag_id}
/
refunds
curl --request GET \
  --url https://sandbox-api.violet.io/v1/orders/{order_id}/bags/{bag_id}/refunds
[
  {
    "id": 123,
    "order_id": 123,
    "bag_id": 123,
    "merchant_id": 123,
    "app_id": 123,
    "transaction_id": 123,
    "gateway_transaction_id": "<string>",
    "amount": 123,
    "merchant_transfer_reversal_amount_usd": 123,
    "developer_transfer_reversal_amount_usd": 123,
    "reason": "<string>",
    "refund_currency": "<string>",
    "status": "PROCESSING",
    "skus": [
      {
        "id": 123,
        "refund_id": 123,
        "bag_id": 123,
        "quantity_refunded": 123,
        "external_id": "<string>",
        "order_sku_id": 123
      }
    ],
    "date_created": "2023-11-07T05:31:56Z",
    "date_last_modified": "2023-11-07T05:31:56Z",
    "external_id": "<string>",
    "errors": [
      {
        "id": 123,
        "error_code": 123,
        "error_message": "<string>",
        "refund_id": 123
      }
    ]
  }
]

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

X-Violet-Token
string
X-Violet-App-Secret
string
X-Violet-App-Id
integer

Path Parameters

order_id
integer
required
bag_id
integer
required

Response

default - application/json
id
integer
order_id
integer
required

ID of the Order being refunded

bag_id
integer

ID of the Bag being refunded

merchant_id
integer
required

ID of the merchant making the refund

app_id
integer
required

ID of the App that created the Order

transaction_id
integer
required

ID of the Transaction being refunded

gateway_transaction_id
string
required

ID of the Transaction in the Payment Gateway

amount
integer
required

Amount being refunded. In Cents

merchant_transfer_reversal_amount_usd
integer

Amount being taken back from the associated transfer to the merchant. In Cents

developer_transfer_reversal_amount_usd
integer

Amount being taken back from the associated transfer to the developer. In Cents

reason
string

Reason for refund

refund_currency
string

Currency set for this refund by the external ecom platform

status
enum<string>

Status of the Refund

Available options:
PROCESSING,
COMPLETED,
CANCELED,
PARTIALLY_COMPLETED,
FAILED,
EXTERNAL
skus
object[]

SKUs the refund applies to

date_created
string

Date of creation

date_last_modified
string

Date of last update

external_id
string

ID of the refund on the external commerce platform. This value will only be populated if the external commerce platform supports refund ID's.

errors
object[]

List of errors associated to this refund during processing. This value will only be populated if there are errors during processing