GET

/v1/orders/{order_id}/refunds/{refund_id}

X-Violet-Token
X-Violet-App-Secret
X-Violet-App-Id
curl --request GET \
  --url https://sandbox-api.violet.io/v1/orders/{order_id}/refunds/{refund_id}
{
  "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 information about a specific refund given an order_id and refund_id.

Headers

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

Path Parameters

order_idrequired
integer
refund_idrequired
integer

Response

200 - application/json
amountrequired
integer

Amount being refunded

app_idrequired
integer

ID of the App that created the Order

bag_id
integer

ID of the Bag being refunded

date_created
string

Date of creation

date_last_modified
string

Date of last update

developer_transfer_reversal_amount_usd
integer

Amount being taken back from the associated transfer to the developer

errors
object[]

List of errors associated to this refund during processing.

external_id
string

ID of the refund on the external commerce platform.

gateway_transaction_idrequired
string

ID of the Transaction in the Payment Gateway

id
integer
merchant_idrequired
integer

ID of the merchant making the refund

merchant_transfer_reversal_amount_usd
integer

Amount being taken back from the associated transfer to the merchant

order_idrequired
integer

ID of the Order being refunded

reason
string

Reason for refund

refund_currency
string

Currency set for this refund by the external ecom platform

skus
object[]

SKUs the refund applies to

status
enum<string>

Status of the Refund

Available options:
PROCESSING,
COMPLETED,
CANCELED,
PARTIALLY_COMPLETED,
FAILED,
EXTERNAL
transaction_idrequired
integer

ID of the Transaction being refunded

Get Bag RefundsSet Shipping Methods