This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock
- Store API
- Admin API
- Auth
- Apps Oauth
- Batch Jobs
- Currencies
- Customers
- Customer Groups
- Products
- Discounts
- Draft Orders
- Gift Cards
- Inventory Items
- Invites
- Notes
- Notifications
- Orders
- Create a ReservationPOST
- Cancel Claim's FulfillmentPOST
- Ship a Claim's FulfillmentPOST
- Cancel Swap's FulfilmmentPOST
- Get Order ReservationsGET
- Add a Shipping MethodPOST
- Create a RefundPOST
- Get an OrderGET
- Update an OrderPOST
- Create a FulfillmentPOST
- Cancel a SwapPOST
- List OrdersGET
- Create a SwapPOST
- Complete an OrderPOST
- Create a Swap FulfillmentPOST
- Cancel a ClaimPOST
- Process a Swap PaymentPOST
- Ship a FulfillmentPOST
- Capture an Order's PaymentsPOST
- Archive OrderPOST
- Update a ClaimPOST
- Request a ReturnPOST
- Create a Claim FulfillmentPOST
- Ship a Swap's FulfillmentPOST
- Cancel a FulfilmmentPOST
- Create a ClaimPOST
- Cancel an OrderPOST
- Order Edits
- Payments
- Payment Collections
- Product Collections
- Product Tags
- Product Types
- Product Variants
- Price Lists
- Product Categories
- Publishable Api Keys
- Reservations
- Regions
- Return Reasons
- Returns
- Sales Channels
- Shipping Options
- Shipping Profiles
- Stock Locations
- Store
- Swaps
- Uploads
- Tax Rates
- Users
Create a Refund
POST
/admin/orders/{id}/refund
refundable_amount of the order.Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://mock.apidog.com/m1/543334-0-default/admin/orders//refund' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 0,
"reason": "string",
"note": "string",
"no_notification": true
}'Response Response Example
200 - Example 1
Request
Path Params
Query Params
Body Params application/json
Examples
Responses
🟢200OK
application/json
Body
🟠400Client Error or Multiple Errors
🟠401User is not authorized. Must log in first
🟠404Not Found Error
🟠409Invalid State Error
🟠422Invalid Request Error
🔴500Server Error
Modified at 2024-05-20 07:45:58