Refund

PreviousOrder NextShip

sales Refund Order V1Execute Post

Create offline refund for order

post

/V1/order/{orderId}/refund

Path parameters

orderIdstringrequired

(Required)

Example: <integer>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"items":[{"order_item_id":"<integer>","qty":"<number>","extension_attributes":"<object>"},{"order_item_id":"<integer>","qty":"<number>","extension_attributes":"<object>"}],"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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/order/{orderId}/refund' \
  --header 'Content-Type: application/json' \
  --data '{
    "items": [
      {
        "order_item_id": "<integer>",
        "qty": "<number>",
        "extension_attributes": "<object>"
      },
      {
        "order_item_id": "<integer>",
        "qty": "<number>",
        "extension_attributes": "<object>"
      }
    ],
    "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>"
        ]
      }
    }
  }'

200

401

500

66689314