Ask to return shipped lines, through the order's link

Before you call

Credential

Authorization: Bearer $KEY

Scope

shop:read

Sdk

shop.publicOrder.return

Cli

shop public order return

Publishable

yes

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.
• tokenstringrequired
  At most 4000 characters.

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