Create refund for invoice

POST /V1/invoice/{invoiceId}/refund

Path parameters

invoiceId integer Required

Body

items array[object]

Interface CreditmemoItemCreationInterface

Interface CreditmemoItemCreationInterface
Hide items attributes Show items attributes object
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemCreationInterface
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  status string
- order_item_id integer Required
  
  Order item ID.
- qty number Required
  
  Quantity.
isOnline boolean
notify boolean
appendComment boolean
comment object

Interface CreditmemoCommentCreationInterface
Hide comment attributes Show comment attributes object
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentCreationInterface
- comment string Required
  
  Comment.
- is_visible_on_front integer Required
  
  Is-visible-on-storefront flag value.
arguments object

Interface CreditmemoCreationArgumentsInterface
Hide arguments attributes Show arguments attributes object
- shipping_amount number
  
  Credit memo shipping amount.
- adjustment_positive number
  
  Credit memo positive adjustment.
- adjustment_negative number
  
  Credit memo negative adjustment.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCreationArgumentsInterface
  Hide extension_attributes attribute Show extension_attributes attribute object
  
  return_to_stock_items array[integer]

Responses

200

200 Success.
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

POST /V1/invoice/{invoiceId}/refund

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/invoice/{invoiceId}/refund' \
 --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]}}}'

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
      ]
    }
  }
}

Response examples (200)

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 (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}