patch
https://api.hips.com/v2/orders//revoke
Run this API call when you want to void or refund an order. The revoke can be for the whole order or just a part of the order. If you want to revoke a part of the order you have to specify amount. Authentication Key Type: SalesChannelApiKey
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Run this API call when you want to void or refund an order. The revoke can be for the whole order or just a part of the order. If you want to revoke a part of the order you have to specify amount.
The revoke call can be made regardless of order status. Refunds will only be sent should there be any payments on the order.
Example
curl --request PATCH \
--url https://api.hips.com/v2/orders/UVWofp7AjHiRKNLjhUjMnhc3/revoke \
--header 'Accept: application/json' \
--header 'Authorization: private_9xxJrsc1u2TF6cPCm6JzG2ry' \
--header 'Content-Type: application/json' \
--data '{
"amount": 1000,
"items": [
{
"name": "T-shirt out of stock, sorry.",
"quantity": 1,
"vat_amount": -250,
"unit_price": -1000
}
]
}'