Refunds API
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 73
- Forks
- 76
- PR merge metrics
- No merged PRs in 30d
Description
As we want to make refunds as useful as it's possible for Sylius, I think it's crucial to introduce at least basic refunds API. It should consist of:
/admin/orders/{orderNumber}/refund-units- refund units of a specific order/admin/credit-memos/- list of all credit memos/admin/orders/{orderNumber}/credit-memos- list of all credit memos of a specific order/admin/orders/{orderNumber}/credit-memos/{id}- details of a specific credit memo/admin/orders/{orderNumber}/refund-payments- list of all refund payments of a specific order/admin/orders/{orderNumber}/refund-payments/{id}/complete- complete a refund payment
The tricky part an URL for a customer, to list all credit memos of their order. As shop API for Sylius is provided as a plugin, maybe it would be the best option to detect is it installed and if yes, then include a /credit-memos/{id}/download route? That for sure need to be considered carefully 🚀 🐎
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named. Start by reviewing the existing RefundPlugin structure and the six proposed admin endpoints, then clarify the customer credit-memo route and plugin integration before implementation; done means the agreed refunds, credit-memo, and refund-payment operations are available with coverage for their behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- api, payments
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100