order.return.approve

Approve a return — issues the instructions the shopper sees (snapshotted as evidence).

• scope: orders:write
• storefront-visible (bumps the catalog generation): no
• destructive: no

Payload

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "returnId": {
      "type": "string",
      "pattern": "^ret_[a-zA-Z0-9]{1,32}$"
    },
    "instructions": {
      "type": "object",
      "properties": {
        "address": {
          "type": "string",
          "minLength": 1,
          "maxLength": 300
        },
        "carrierName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60
        },
        "costBearer": {
          "type": "string",
          "enum": [
            "merchant",
            "consumer"
          ]
        },
        "costKurus": {
          "type": "integer",
          "minimum": 0,
          "maximum": 10000000000000
        },
        "note": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        }
      },
      "required": [
        "address",
        "costBearer"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "returnId",
    "instructions"
  ],
  "additionalProperties": false
}