Refund List By Order

GET 
/openapi/2022-01/orders/:id/refund

Returns all refund records attached to the specified order, along with the order's payment and order status at the moment of query.

Request

Path Parameters

id stringrequired

Order's ID

Responses

200

200

application/json

Schema

Schema

all_refundedboolean
Default value: true
Example: false
order_financial_statusstring
Example: partially_refunded
order_statusstring
Example: finished
refund_discount_totalstring
Example:
refund_statusstring
Example:
refund_tax_totalstring
Example:
refund_totalstring
Example:
refunds object[]
Array [
created_atstring
Example: 2024-07-15T09:17:26Z
currencystring
Example: USD
idstring
Example: 402390816770768890
notestring
Example:
order_idstring
Example: 10234-00020257
payment_details object[]
Array [
finished_atstring
Example: 2024-07-15T09:17:28Z
payment_channelstring
Example: stripe
payment_methodstring
Example: credit_card
refund_pricestring
Example: 14.83
]
refund_line_items object[]
Array [
discountstring
Example: 1.00
line_item object
base_pricestring
Example: 0.00
compare_at_pricestring
Example: 15.99
custom_properties object
object
discount_applicationsstring
Example: [{"type":"discount_flashsale","subtype":"discount_flashsale","discount_id":"f8d442e1-ed00-4f56-9c2a-02db77ebf41a","title":"专辑","value":"","discount_type":"","value_type":"","allocation_method":"","target_selection":"","target_type":"","total_discount_amount":"0","discount_amount":"0","is_free_gift":false,"discount_quantity":1,"is_need_split":true,"discount_text":"Flash Sale","groups":null,"extents":null},{"type":"discount_rebate","subtype":"discount_rebate","discount_id":"20e26ce3-eb11-4c4a-944f-b7aee1f0bf1a","title":"全场满减","value":"","discount_type":"fixed_amount","value_type":"fixed_amount","allocation_method":"across","target_selection":"all","target_type":"line_item","total_discount_amount":"1","discount_amount":"1","is_free_gift":false,"discount_quantity":1,"is_need_split":false,"discount_text":"Threshold Promo","groups":null,"extents":null}]
fulfillment_statusstring
Example: returned
idstring
Example: df111f19-b1f2-4ffc-b293-743a432f9f64
imagestring
Example: {"alt":"","height":0,"path":"be0a695b89eb1070e7d418d276ef1f15.jpeg","src":"//img.staticdj.com/be0a695b89eb1070e7d418d276ef1f15.jpeg","width":0}
notestring
Example:
pricestring
Example: 15.83
product_handlestring
Example: counted-stamped-big-size-ginkgo-biloba-3-strands-cross-stitch-60-60cm
product_idstring
Example: 81b93917-b32b-481a-a654-d5f659bcc9a2
product_titlestring
Example: (Counted/Stamped)(Big Size) 11CT Ginkgo biloba- Cross Stitch 60*60cm/23.62*23.62in
product_urlstring
Example: /products/counted-stamped-big-size-ginkgo-biloba-3-strands-cross-stitch-60-60cm
properties object[]
Array [
namestring
Example: Style
valuestring
Example: 11CT Stamped
]
quantityinteger
Default value: 0
Example: 1
refund_quantityinteger
Default value: 0
Example: 1
refund_totalstring
Example: 15.83
requires_shippingboolean
Default value: true
Example: true
skustring
Example: 452933.01
totalstring
Example: 15.83
variant_idstring
Example: 28c7edc7-a90b-47e8-a6ae-52708676d9cd
variant_titlestring
Example: 11CT Stamped
vendorstring
Example: tapestrymarket
weightstring
Example: 0.00
weight_unitstring
Example: kg
line_item_idstring
Example: df111f19-b1f2-4ffc-b293-743a432f9f64
refund_quantityinteger
Default value: 0
Example: 1
sub_totalstring
Example: 15.83
taxstring
Example: 0.00
totalstring
Example: 14.83
]
refund_methodstring
Example: general
refund_pricestring
Example: 14.83
refund_shippingstring
Example: 0.00
refund_shipping_taxstring
Example: 0.00
refund_statusstring
Example: finished
updated_atstring
Example: 2024-07-15T09:17:28Z
]

Example

{
  "all_refunded": false,
  "order_financial_status": "partially_refunded",
  "order_status": "finished",
  "refund_discount_total": "",
  "refund_status": "",
  "refund_tax_total": "",
  "refund_total": "",
  "refunds": [
    {
      "created_at": "2024-07-15T09:17:26Z",
      "currency": "USD",
      "id": "402390816770768890",
      "note": "",
      "order_id": "10234-00020257",
      "payment_details": [
        {
          "finished_at": "2024-07-15T09:17:28Z",
          "payment_channel": "stripe",
          "payment_method": "credit_card",
          "refund_price": "14.83"
        }
      ],
      "refund_line_items": [
        {
          "discount": "1.00",
          "line_item": {
            "base_price": "0.00",
            "compare_at_price": "15.99",
            "custom_properties": {},
            "discount_applications": "[{\"type\":\"discount_flashsale\",\"subtype\":\"discount_flashsale\",\"discount_id\":\"f8d442e1-ed00-4f56-9c2a-02db77ebf41a\",\"title\":\"专辑\",\"value\":\"\",\"discount_type\":\"\",\"value_type\":\"\",\"allocation_method\":\"\",\"target_selection\":\"\",\"target_type\":\"\",\"total_discount_amount\":\"0\",\"discount_amount\":\"0\",\"is_free_gift\":false,\"discount_quantity\":1,\"is_need_split\":true,\"discount_text\":\"Flash Sale\",\"groups\":null,\"extents\":null},{\"type\":\"discount_rebate\",\"subtype\":\"discount_rebate\",\"discount_id\":\"20e26ce3-eb11-4c4a-944f-b7aee1f0bf1a\",\"title\":\"全场满减\",\"value\":\"\",\"discount_type\":\"fixed_amount\",\"value_type\":\"fixed_amount\",\"allocation_method\":\"across\",\"target_selection\":\"all\",\"target_type\":\"line_item\",\"total_discount_amount\":\"1\",\"discount_amount\":\"1\",\"is_free_gift\":false,\"discount_quantity\":1,\"is_need_split\":false,\"discount_text\":\"Threshold Promo\",\"groups\":null,\"extents\":null}]",
            "fulfillment_status": "returned",
            "id": "df111f19-b1f2-4ffc-b293-743a432f9f64",
            "image": "{\"alt\":\"\",\"height\":0,\"path\":\"be0a695b89eb1070e7d418d276ef1f15.jpeg\",\"src\":\"//img.staticdj.com/be0a695b89eb1070e7d418d276ef1f15.jpeg\",\"width\":0}",
            "note": "",
            "price": "15.83",
            "product_handle": "counted-stamped-big-size-ginkgo-biloba-3-strands-cross-stitch-60-60cm",
            "product_id": "81b93917-b32b-481a-a654-d5f659bcc9a2",
            "product_title": "(Counted/Stamped)(Big Size) 11CT Ginkgo biloba- Cross Stitch  60*60cm/23.62*23.62in",
            "product_url": "/products/counted-stamped-big-size-ginkgo-biloba-3-strands-cross-stitch-60-60cm",
            "properties": [
              {
                "name": "Style",
                "value": "11CT Stamped"
              }
            ],
            "quantity": 1,
            "refund_quantity": 1,
            "refund_total": "15.83",
            "requires_shipping": true,
            "sku": "452933.01",
            "total": "15.83",
            "variant_id": "28c7edc7-a90b-47e8-a6ae-52708676d9cd",
            "variant_title": "11CT Stamped",
            "vendor": "tapestrymarket",
            "weight": "0.00",
            "weight_unit": "kg"
          },
          "line_item_id": "df111f19-b1f2-4ffc-b293-743a432f9f64",
          "refund_quantity": 1,
          "sub_total": "15.83",
          "tax": "0.00",
          "total": "14.83"
        }
      ],
      "refund_method": "general",
      "refund_price": "14.83",
      "refund_shipping": "0.00",
      "refund_shipping_tax": "0.00",
      "refund_status": "finished",
      "updated_at": "2024-07-15T09:17:28Z"
    }
  ]
}

Result

{
  "all_refunded": false,
  "order_financial_status": "partially_refunded",
  "order_status": "finished",
  "refund_discount_total": "",
  "refund_status": "",
  "refund_tax_total": "",
  "refund_total": "",
  "refunds": [
    {
      "created_at": "2024-07-15T09:17:26Z",
      "currency": "USD",
      "id": "402390816770768890",
      "note": "",
      "order_id": "10234-00020257",
      "payment_details": [
        {
          "finished_at": "2024-07-15T09:17:28Z",
          "payment_channel": "stripe",
          "payment_method": "credit_card",
          "refund_price": "14.83"
        }
      ],
      "refund_line_items": [
        {
          "discount": "1.00",
          "line_item": {
            "base_price": "0.00",
            "compare_at_price": "15.99",
            "custom_properties": {},
            "discount_applications": "[{\"type\":\"discount_flashsale\",\"subtype\":\"discount_flashsale\",\"discount_id\":\"f8d442e1-ed00-4f56-9c2a-02db77ebf41a\",\"title\":\"专辑\",\"value\":\"\",\"discount_type\":\"\",\"value_type\":\"\",\"allocation_method\":\"\",\"target_selection\":\"\",\"target_type\":\"\",\"total_discount_amount\":\"0\",\"discount_amount\":\"0\",\"is_free_gift\":false,\"discount_quantity\":1,\"is_need_split\":true,\"discount_text\":\"Flash Sale\",\"groups\":null,\"extents\":null},{\"type\":\"discount_rebate\",\"subtype\":\"discount_rebate\",\"discount_id\":\"20e26ce3-eb11-4c4a-944f-b7aee1f0bf1a\",\"title\":\"全场满减\",\"value\":\"\",\"discount_type\":\"fixed_amount\",\"value_type\":\"fixed_amount\",\"allocation_method\":\"across\",\"target_selection\":\"all\",\"target_type\":\"line_item\",\"total_discount_amount\":\"1\",\"discount_amount\":\"1\",\"is_free_gift\":false,\"discount_quantity\":1,\"is_need_split\":false,\"discount_text\":\"Threshold Promo\",\"groups\":null,\"extents\":null}]",
            "fulfillment_status": "returned",
            "id": "df111f19-b1f2-4ffc-b293-743a432f9f64",
            "image": "{\"alt\":\"\",\"height\":0,\"path\":\"be0a695b89eb1070e7d418d276ef1f15.jpeg\",\"src\":\"//img.staticdj.com/be0a695b89eb1070e7d418d276ef1f15.jpeg\",\"width\":0}",
            "note": "",
            "price": "15.83",
            "product_handle": "counted-stamped-big-size-ginkgo-biloba-3-strands-cross-stitch-60-60cm",
            "product_id": "81b93917-b32b-481a-a654-d5f659bcc9a2",
            "product_title": "(Counted/Stamped)(Big Size) 11CT Ginkgo biloba- Cross Stitch  60*60cm/23.62*23.62in",
            "product_url": "/products/counted-stamped-big-size-ginkgo-biloba-3-strands-cross-stitch-60-60cm",
            "properties": [
              {
                "name": "Style",
                "value": "11CT Stamped"
              }
            ],
            "quantity": 1,
            "refund_quantity": 1,
            "refund_total": "15.83",
            "requires_shipping": true,
            "sku": "452933.01",
            "total": "15.83",
            "variant_id": "28c7edc7-a90b-47e8-a6ae-52708676d9cd",
            "variant_title": "11CT Stamped",
            "vendor": "tapestrymarket",
            "weight": "0.00",
            "weight_unit": "kg"
          },
          "line_item_id": "df111f19-b1f2-4ffc-b293-743a432f9f64",
          "refund_quantity": 1,
          "sub_total": "15.83",
          "tax": "0.00",
          "total": "14.83"
        }
      ],
      "refund_method": "general",
      "refund_price": "14.83",
      "refund_shipping": "0.00",
      "refund_shipping_tax": "0.00",
      "refund_status": "finished",
      "updated_at": "2024-07-15T09:17:28Z"
    }
  ]
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Unable to find resource"
  ]
}

Result

{
  "errors": [
    "Unable to find resource"
  ]
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Invalid ID"
  ]
}

Result

{
  "errors": [
    "Invalid ID"
  ]
}