Get Bag Refunds

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.

Get Bag Refunds

get
Path parameters
order_idinteger · int64Required
bag_idinteger · int64Required
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Responses
200
success
application/json
get
GET /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
Accept: */*
[
  {
    "id": 10000,
    "order_id": 11111,
    "bag_id": 22222,
    "merchant_id": 11111,
    "app_id": 10000,
    "transaction_id": 99999,
    "amount": 2500,
    "reason": "Item is out of stock.",
    "refund_currency": "USD",
    "status": "COMPLETED",
    "skus": [
      {
        "id": 33333,
        "refund_id": 10000,
        "bag_id": 22222,
        "quantity_refunded": 1,
        "external_id": "43522846032108",
        "order_sku_id": 9999999999
      }
    ],
    "date_created": "2017-06-15T01:01:01+0000",
    "date_last_modified": "2017-06-15T01:01:01+0000",
    "external_id": "910123663596",
    "errors": []
  }
]

Last updated

Was this helpful?