Skip to the page

Praecise Platform

Rivier/ Reference/ shop

Ask to send shipped lines back

post/shop/orders/{id}/returns

Ask to send shipped lines back. Only units that shipped and are not already returned or waiting can be asked for.

Before you call

Credential: Authorization: Bearer $KEY
Scope: shop:write
Mcp: rivier_shop_return_request
Graphql: Mutation.requestShopReturn
Sdk: shop.return.request
Cli: shop return request

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

lineslist of objectrequired
- lineIdstring (uuid)required
- quantityintegerrequired
  At least 1. At most 1000.
reasonstringrequired
At most 500 characters.
restockboolean
Default: true.

Responses

201application/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}/returns' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "lines": [
    {
      "lineId": "string",
      "quantity": 0
    }
  ],
  "reason": "string"
}'

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

This page as Markdown