查询订单退款记录列表

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

返回指定订单上的全部退款记录，同时返回查询时刻订单的支付状态和订单状态。

请求

Path参数

id string必填

Order's ID

响应

200

200

application/json

数据结构

数据结构

all_refundedboolean
默认值： true
示例： false
order_financial_statusstring
示例： partially_refunded
order_statusstring
示例： finished
refund_discount_totalstring
示例：
refund_statusstring
示例：
refund_tax_totalstring
示例：
refund_totalstring
示例：
refunds object[]
Array [
created_atstring
示例： 2024-07-15T09:17:26Z
currencystring
示例： USD
idstring
示例： 402390816770768890
notestring
示例：
order_idstring
示例： 10234-00020257
payment_details object[]
Array [
finished_atstring
示例： 2024-07-15T09:17:28Z
payment_channelstring
示例： stripe
payment_methodstring
示例： credit_card
refund_pricestring
示例： 14.83
]
refund_line_items object[]
Array [
discountstring
示例： 1.00
line_item object
base_pricestring
示例： 0.00
compare_at_pricestring
示例： 15.99
custom_properties object
object
discount_applicationsstring
示例： [{"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
示例： returned
idstring
示例： df111f19-b1f2-4ffc-b293-743a432f9f64
imagestring
示例： {"alt":"","height":0,"path":"be0a695b89eb1070e7d418d276ef1f15.jpeg","src":"//img.staticdj.com/be0a695b89eb1070e7d418d276ef1f15.jpeg","width":0}
notestring
示例：
pricestring
示例： 15.83
product_handlestring
示例： counted-stamped-big-size-ginkgo-biloba-3-strands-cross-stitch-60-60cm
product_idstring
示例： 81b93917-b32b-481a-a654-d5f659bcc9a2
product_titlestring
示例： (Counted/Stamped)(Big Size) 11CT Ginkgo biloba- Cross Stitch 60*60cm/23.62*23.62in
product_urlstring
示例： /products/counted-stamped-big-size-ginkgo-biloba-3-strands-cross-stitch-60-60cm
properties object[]
Array [
namestring
示例： Style
valuestring
示例： 11CT Stamped
]
quantityinteger
默认值： 0
示例： 1
refund_quantityinteger
默认值： 0
示例： 1
refund_totalstring
示例： 15.83
requires_shippingboolean
默认值： true
示例： true
skustring
示例： 452933.01
totalstring
示例： 15.83
variant_idstring
示例： 28c7edc7-a90b-47e8-a6ae-52708676d9cd
variant_titlestring
示例： 11CT Stamped
vendorstring
示例： tapestrymarket
weightstring
示例： 0.00
weight_unitstring
示例： kg
line_item_idstring
示例： df111f19-b1f2-4ffc-b293-743a432f9f64
refund_quantityinteger
默认值： 0
示例： 1
sub_totalstring
示例： 15.83
taxstring
示例： 0.00
totalstring
示例： 14.83
]
refund_methodstring
示例： general
refund_pricestring
示例： 14.83
refund_shippingstring
示例： 0.00
refund_shipping_taxstring
示例： 0.00
refund_statusstring
示例： finished
updated_atstring
示例： 2024-07-15T09:17:28Z
]

示例

{
  "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

数据结构

数据结构

errorsstring[]

示例

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

Result

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

422

422

application/json

数据结构

数据结构

errorsstring[]

示例

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

Result

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