invoice/{invoiceId}/refund

Create refund for invoice

Request

path Parameters

invoiceId

required

integer

Request Body schema:
application/json

appendComment	boolean
	object (sales-data-creditmemo-creation-arguments-interface) Interface CreditmemoCreationArgumentsInterface
	object (sales-data-creditmemo-comment-creation-interface) Interface CreditmemoCommentCreationInterface
isOnline	boolean
	Array of objects (sales-data-creditmemo-item-creation-interface)
notify	boolean

Responses

200

200 Success.

401

401 Unauthorized

default

Unexpected error

post/V1/invoice/{invoiceId}/refund

Request samples

Payload

{"appendComment": true,
"arguments": {"adjustment_negative": 0,
"adjustment_positive": 0,
"extension_attributes": {"return_to_stock_items": [0
]
},
"shipping_amount": 0
},
"comment": {"comment": "string",
"extension_attributes": { },
"is_visible_on_front": 0
},
"isOnline": true,
"items": [{"extension_attributes": { },
"order_item_id": 0,
"qty": 0
}
],
"notify": true
}

Response samples

200
401
default

0

➔ Next to invoices

invoice/{invoiceId}/refund

invoice/{invoiceId}/refund

path Parameters

Request Body schema: application/jsonapplication/xmlapplication/json

Request Body schema:
application/json