application/json
POST
/V1/invoice/{invoiceId}/refund
cURL (application/json)
curl \
--request POST 'https://magento2.winkelstraat.mac/rest/all/V1/invoice/{invoiceId}/refund' \
--header "Content-Type: application/json" \
--data '{"items":[{"extension_attributes":{"status":"string"},"order_item_id":42,"qty":42.0}],"isOnline":true,"notify":true,"appendComment":true,"comment":{"extension_attributes":{},"comment":"string","is_visible_on_front":42},"arguments":{"shipping_amount":42.0,"adjustment_positive":42.0,"adjustment_negative":42.0,"extension_attributes":{"return_to_stock_items":[42]}}}'curl \
--request POST 'https://magento2.winkelstraat.mac/rest/all/V1/invoice/{invoiceId}/refund' \
--header "Content-Type: application/xml"
Request examples
{
"items": [
{
"extension_attributes": {
"status": "string"
},
"order_item_id": 42,
"qty": 42.0
}
],
"isOnline": true,
"notify": true,
"appendComment": true,
"comment": {
"extension_attributes": {},
"comment": "string",
"is_visible_on_front": 42
},
"arguments": {
"shipping_amount": 42.0,
"adjustment_positive": 42.0,
"adjustment_negative": 42.0,
"extension_attributes": {
"return_to_stock_items": [
42
]
}
}
}
Request examples
<?xml version="1.0" encoding="UTF-8"?>
<root>
<items type="array">
<item>
<extension-attributes>
<status>string</status>
</extension-attributes>
<order-item-id type="integer">42</order-item-id>
<qty type="float">42.0</qty>
</item>
</items>
<isOnline type="boolean">true</isOnline>
<notify type="boolean">true</notify>
<appendComment type="boolean">true</appendComment>
<comment>
<extension-attributes>
</extension-attributes>
<comment>string</comment>
<is-visible-on-front type="integer">42</is-visible-on-front>
</comment>
<arguments>
<shipping-amount type="float">42.0</shipping-amount>
<adjustment-positive type="float">42.0</adjustment-positive>
<adjustment-negative type="float">42.0</adjustment-negative>
<extension-attributes>
<return-to-stock-items type="array">
<return-to-stock-item type="integer">42</return-to-stock-item>
</return-to-stock-items>
</extension-attributes>
</arguments>
</root>
Response examples (200)
42
Response examples (200)
42
Response examples (401)
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Response examples (401)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>
Response examples (default)
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>