forked from magento/devdocs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
50 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 2 additions & 29 deletions
31
guides/v2.2/rest/modules/refunds-credits.md → guides/v2.2/rest/modules/sales/credits.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
group: rest-api | ||
title: Refunds | ||
functional_areas: | ||
- Integration | ||
- Catalog | ||
--- | ||
|
||
There are several options to choose when issuing a refund using the Magento Refund API. | ||
|
||
## salesRefundInvoiceV1 service | ||
|
||
With this service, you can initiate and process a refund based on an Invoice ID, created using an online payment method. | ||
|
||
### Endpoint | ||
|
||
`POST V1/invoice/:invoiceId/refund` | ||
|
||
{:.bs-callout-warning} | ||
If you try to apply the service to an invoice created using an offline payment method, the system will display a validation error. | ||
|
||
The `salesRefundInvoice` service allows you to: | ||
|
||
* Create a credit memo (complete or partial) for an invoice | ||
* Add details about the refunded items to the order | ||
* Change status and state of an order according to performed actions | ||
* Notify a customer about the performed refund operation | ||
* Designate whether the returned items are returned to stock | ||
|
||
## salesRefundOrderV1 service | ||
|
||
This service performs the same operations as the `RefundInvoice` service, but based on an Order ID. Use this service if the invoice was created using an offline payment method. | ||
|
||
### Endpoint | ||
|
||
`POST V1/order/:orderId/refund` | ||
|
||
## Related documentation | ||
|
||
* [Magento REST API documentation (Swagger)](https://devdocs.magento.com/swagger/index.html) |