WooCommerce REST API 文档 文档中心 › WooCommerce REST API 文档

title: "退款 #" post_status: publish comment_status: open taxonomy: category: - woocommerce-rest-api post_tag: - Wp Api V1 - Includes - Source

退款

退款 API 允许您创建、查看和删除单个退款记录。

退款属性

属性名 类型 描述
id integer 资源的唯一标识符。只读
date_created date-time 订单退款创建的日期，使用站点时区。只读
amount string 退款金额。必需
reason string 退款原因。
line_items array 订单行项目数据。详见退款行项目属性。

Refund line item properties

Attribute Type Description
id integer Item ID. read-only
name string Product name. read-only
sku string Product SKU. read-only
product_id integer Product ID.
variation_id integer Variation ID, if applicable.
quantity integer Quantity ordered.
tax_class string Tax class of product. read-only
price string Product price. read-only
subtotal string Line subtotal (before discounts).
subtotal_tax string Line subtotal tax (before discounts).
total string Line total (after discounts).
total_tax string Line total tax (after discounts).
taxes array Line total tax with id, total and subtotal. read-only
meta array Line item meta data with key, label and value. read-only

创建退款

此 API 可帮助您为订单创建新的退款。

HTTP 请求

POST
/wp-json/wc/v1/orders/<id>/refunds
curl -X POST https://example.com/wp-json/wc/v1/orders/116/refunds \
    -u consumer_key:consumer_secret \
    -H "Content-Type: application/json" \
    -d '{
  "amount": "10"
}'

const data = {
  amount: "10"
};

WooCommerce.post("orders/116/refunds", data)
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php
$data = [
    'amount' => '10'
];

print_r($woocommerce->post('orders/116/refunds', $data));
?>

data = {
    "amount": "10"
}

print(wcapi.post("orders/116/refunds", data).json())

data = {
  amount: "10"
}

woocommerce.post("orders/116/refunds", data).parsed_response

JSON 响应示例：

{
  "id": 150,
  "date_created": "2016-05-30T17:28:05",
  "amount": "10.00",
  "reason": "",
  "line_items": [],
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v1/orders/116/refunds/150"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v1/orders/116/refunds"
      }
    ],
    "up": [
      {
        "href": "https://example.com/wp-json/wc/v1/orders/116"
      }
    ]
  }
}

获取退款详情

此 API 允许您检索并查看订单中的特定退款。

HTTP 请求

GET
/wp-json/wc/v1/orders/<id>/refunds/<refund_id>
curl https://example.com/wp-json/wc/v1/orders/116/refunds/150 \
    -u consumer_key:consumer_secret

WooCommerce.get("orders/116/refunds/150")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php print_r($woocommerce->get('orders/116/refunds/150')); ?>

print(wcapi.get("orders/116/refunds/150").json())

woocommerce.get("orders/116/refunds/150").parsed_response

JSON 响应示例：

{
  "id": 150,
  "date_created": "2016-05-30T17:28:05",
  "amount": "10.00",
  "reason": "",
  "line_items": [],
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v1/orders/116/refunds/150"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v1/orders/116/refunds"
      }
    ],
    "up": [
      {
        "href": "https://example.com/wp-json/wc/v1/orders/116"
      }
    ]
  }
}

Available parameters

Parameter Type Description
dp string Number of decimal points to use in each resource.

列出所有退款

此 API 可帮助您查看订单的所有退款。

HTTP 请求

GET
/wp-json/wc/v1/orders/<id>/refunds
curl https://example.com/wp-json/wc/v1/orders/116/refunds \
    -u consumer_key:consumer_secret

WooCommerce.get("orders/116/refunds")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php print_r($woocommerce->get('orders/116/refunds')); ?>

print(wcapi.get("orders/116/refunds").json())

woocommerce.get("orders/116/refunds").parsed_response

JSON 响应示例：

[
  {
    "id": 151,
    "date_created": "2016-05-30T17:31:48",
    "amount": "2.00",
    "reason": "",
    "line_items": [
      {
        "id": 11,
        "name": "Woo Single #2",
        "sku": "12345",
        "product_id": 99,
        "variation_id": 0,
        "quantity": -1,
        "tax_class": "",
        "price": "-2.00",
        "subtotal": "-2.00",
        "subtotal_tax": "0.00",
        "total": "-2.00",
        "total_tax": "0.00",
        "taxes": [],
        "meta": []
      }
    ],
    "_links": {
      "self": [
        {
          "href": "https://example.com/wp-json/wc/v1/orders/116/refunds/151"
        }
      ],
      "collection": [
        {
          "href": "https://example.com/wp-json/wc/v1/orders/116/refunds"
        }
      ],
      "up": [
        {
          "href": "https://example.com/wp-json/wc/v1/orders/116"
        }
      ]
    }
  },
  {
    "id": 150,
    "date_created": "2016-05-30T17:28:05",
    "amount": "10.00",
    "reason": "",
    "line_items": [],
    "_links": {
      "self": [
        {
          "href": "https://example.com/wp-json/wc/v1/orders/116/refunds/150"
        }
      ],
      "collection": [
        {
          "href": "https://example.com/wp-json/wc/v1/orders/116/refunds"
        }
      ],
      "up": [
        {
          "href": "https://example.com/wp-json/wc/v1/orders/116"
        }
      ]
    }
  }
]

Available parameters

Parameter Type Description
context string Scope under which the request is made; determines fields present in response. Options: view and edit.
page integer Current page of the collection.
per_page integer Maximum number of items to be returned in result set.
search string Limit results to those matching a string.
after string Limit response to resources published after a given ISO8601 compliant date.
before string Limit response to resources published before a given ISO8601 compliant date.
dates_are_gmt boolean Interpret after and before as UTC dates when true.
exclude string Ensure result set excludes specific ids.
include string Limit result set to specific ids.
offset integer Offset the result set by a specific number of items.
order string Order sort attribute ascending or descending. Default is asc. Options: asc and desc.
orderby string Sort collection by object attribute. Default is date, Options: date, id, include, title and slug.
dp string Number of decimal points to use in each resource.

删除退款

此 API 可帮助您删除订单退款。

HTTP 请求

DELETE
/wp-json/wc/v1/orders/<id>/refunds/<refund_id>
curl -X DELETE https://example.com/wp-json/wc/v1/orders/116/refunds/150?force=true \
    -u consumer_key:consumer_secret

WooCommerce.delete("orders/116/refunds/150", {
  force: true
})
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });

<?php print_r($woocommerce->delete('orders/116/refunds/150', ['force' => true])); ?>

print(wcapi.delete("orders/116/refunds/150", params={"force": True}).json())

woocommerce.delete("orders/116/refunds/150", force: true).parsed_response

JSON 响应示例：

{
  "id": 150,
  "date_created": "2016-05-30T17:28:05",
  "amount": "10.00",
  "reason": "",
  "line_items": [],
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v1/orders/116/refunds/150"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v1/orders/116/refunds"
      }
    ],
    "up": [
      {
        "href": "https://example.com/wp-json/wc/v1/orders/116"
      }
    ]
  }
}

Available parameters

Parameter Type Description
force string Required to be true, as resource does not support trashing.
← 返回文档中心