POST /sites/{site_id}/orders/{order_id}/refund
This API will reverse a Stripe charge and refund an order back to a
customer. It will also set the order's status to refunded
.
Required scope | ecommerce:write
Servers
- https://api.webflow.com/v2
Path parameters
Name | Type | Required | Description |
---|---|---|---|
site_id |
String | Yes |
Unique identifier for a Site |
order_id |
String | Yes |
Unique identifier for an Order |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
reason |
String | No |
The reason for the refund Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.