GET
/
orders
/
{order_id}
/
refunds
[
  {
    "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": []
  }
]

Retrieve any refunds associated to an Order given its order_id.

Headers

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

Path Parameters

​
order_id
integer
required

Response

200 - 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

​
reason_code
enum<string>

Reason code for refund

Available options:
OTHER,
CUSTOMER,
INVENTORY,
FRAUD,
DECLINED
​
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

​
shipping
object | null

Details of any refunded shipping amounts.

​
tax_amount
integer | null

Tax amount being refunded. In Cents.

Required range: x > 0

Was this page helpful?

Refund BagGet Bag Refunds