Skip to the page

Praecise Platform

Rivier/ Reference/ shop

Cancel a paid order that has not shipped and ask for its refund

post/shop/orders/{id}/cancel-paid

Cancel a paid order that has not shipped and ask for its refund. A person's decision.

Before you call

Credential: Authorization: Bearer $KEY
Scope: shop:write
Sdk: shop.order.cancelPaid
Cli: shop order cancel paid

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

reasonstring
Default: . At most 300 characters.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/shop/orders/{id}/cancel-paid' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "reason": ""
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown