Refund

sales Refund Invoice V1Execute Post

post

Create refund for invoice

Path parameters

invoiceIdstringRequired

(Required)

Example: <integer>

Header parameters

Content-TypestringOptionalExample: application/json

Body

application/json

objectOptionalExample: {"items":[{"order_item_id":"<integer>","qty":"<number>","extension_attributes":"<object>"},{"order_item_id":"<integer>","qty":"<number>","extension_attributes":"<object>"}],"isOnline":"<boolean>","notify":"<boolean>","appendComment":"<boolean>","comment":{"comment":"<string>","is_visible_on_front":"<integer>","extension_attributes":"<object>"},"arguments":{"shipping_amount":"<number>","adjustment_positive":"<number>","adjustment_negative":"<number>","extension_attributes":{"return_to_stock_items":["<integer>","<integer>"]}}}

Responses

200

OK

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/V1/invoice/{invoiceId}/refund

HTTPcURLJavaScriptPython

POST /V1/invoice/{invoiceId}/refund HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 530

{
  "items": [
    {
      "order_item_id": "<integer>",
      "qty": "<number>",
      "extension_attributes": "<object>"
    },
    {
      "order_item_id": "<integer>",
      "qty": "<number>",
      "extension_attributes": "<object>"
    }
  ],
  "isOnline": "<boolean>",
  "notify": "<boolean>",
  "appendComment": "<boolean>",
  "comment": {
    "comment": "<string>",
    "is_visible_on_front": "<integer>",
    "extension_attributes": "<object>"
  },
  "arguments": {
    "shipping_amount": "<number>",
    "adjustment_positive": "<number>",
    "adjustment_negative": "<number>",
    "extension_attributes": {
      "return_to_stock_items": [
        "<integer>",
        "<integer>"
      ]
    }
  }
}

66689314