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

Retrieves all refunds for a specific bag within an order. Returns an array of Refund objects filtered to the specified bag. Useful for checking the refund history of a single merchant's bag. Returns an empty array if no refunds exist for the bag. All monetary values are in the smallest currency unit (e.g. cents for USD).

Path parameters

order_idinteger · int64Required

ID of the order containing the bag

Example: 11111

bag_idinteger · int64Required

ID of the bag to retrieve refunds for

Example: 22222

Header parameters

X-Violet-TokenstringRequired

API token for authentication

X-Violet-App-SecretstringRequired

Application secret key

X-Violet-App-Idinteger · int32Required

Application ID

Example: 10000

Responses

200

success

application/json

Order Refund

idinteger · int64Read-onlyRequired

Unique ID of the Refund.

order_idinteger · int64Required

ID of the Order being refunded

bag_idinteger · int64Optional

ID of the Bag being refunded

merchant_idinteger · int32Required

ID of the merchant making the refund

app_idinteger · int32Required

ID of the App that created the Order

transaction_idinteger · int64Required

ID of the Transaction being refunded

payment_transaction_idinteger · int64Required

ID of the Payment Transaction in Violet

gateway_transaction_idstringRequired

ID of the Transaction in the Payment Gateway

amountinteger · int32Required

Amount being refunded. In Cents

merchant_transfer_reversal_amount_usdinteger · int32Optional

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

developer_transfer_reversal_amount_usdinteger · int32Optional

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

merchant_transfer_reversal_amount_platform_currencyinteger · int32Optional

Amount in fractional currency unit (e.g. cents) being taken back from the associated transfer to the merchant, in platform currency.

developer_transfer_reversal_amount_platform_currencyinteger · int32Optional

Amount in fractional currency unit (e.g. cents) being taken back from the associated transfer to the developer, in platform currency.

reasonstringOptional

Reason for refund

reason_codestring · enumOptional

Reason code for refund

Possible values:

refund_currencystringOptional

Currency set for this refund by the external ecom platform

platform_currencystringOptional

Currency used by the platform account for the payment provider that processed this Refund

statusstring · enumOptional

Status of the Refund

Possible values:

transfer_reversalsstring[]Optional

Unique identifiers of the Transfer Reversal objects in Violet that are associated with this transfer.

date_createdstring · date-timeOptional

Date of creation

date_last_modifiedstring · date-timeOptional

Date of last update

external_idstringOptional

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

tax_amountinteger · int32 · nullableOptional

Tax amount being refunded. In Cents.

404

not found

application/json

500

internal server error

application/json

get

/orders/{order_id}/bags/{bag_id}/refunds

HTTPcURLJavaScriptPython

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": []
  }
]