# PUT /api/orders/{unique_key}/shop_memo

注文ショップメモ更新

指定した注文のショップ内部メモを設定します。

空文字を指定するとメモを削除します。
注文の種類や状態により変更できない場合は `422` を返します。
この更新では、ショップおよび購入者へメールを送信しません。

更新後のショップメモを取得できた場合は `200`、更新は成功したもののショップメモを取得できない場合は `204` を返します。
`204` の場合は同じリクエストを再送しないでください。
`5xx` の場合は更新の成否を確定できないため、再送せずに `GET /api/orders/{unique_key}` で状態を確認してください。

## 要求スコープ

- `orders.read`
- `orders.update`

## パラメータ

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `unique_key` | path | `OrderUniqueKey` | 必須 | 注文の一意キー（16 桁の半角英数字）。小文字は大文字として扱います。 |

## リクエストボディ

`application/json`

- `text` string（必須 / 1000 文字以下）: ショップメモ本文（最大 1000 文字）。削除する場合は空文字列を指定します。

## レスポンスボディ（200）

`application/json`

- `text` string（必須）: ショップメモ本文。未入力の場合は空文字列です。

## リクエスト例

```sh
curl -X PUT "https://apiv2.thebase.com/api/orders/<unique_key>/shop_memo" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "string"
}'
```

## レスポンス

| Status | Description |
| --- | --- |
| `200` | 更新成功。更新後のショップメモを返します。 |
| `204` | 更新成功。更新後のショップメモを取得できないため、レスポンス本文は返しません。 |

## エラー

エラーは `application/problem+json` の Problem 形式で返します。認証・スコープ・予期しない内部エラーなど、すべてのエンドポイントに共通のエラーと構造・判別方法は [エラーレスポンス](/docs/errors.md) を参照してください。

このエンドポイントが返すその他のエラーは次のとおりです。

| Status | Type | Description |
| --- | --- | --- |
| `400` | `/errors/request/malformed-body` | リクエストボディをこのエンドポイントが要求する形式として解釈できない場合に返します。 |
| `400` | `/errors/orders/invalid-body` | リクエストボディがエンドポイントのスキーマを満たさない場合に返します。 |
| `400` | `/errors/request/invalid-params` | 1 つ以上のパスパラメータがエンドポイントのスキーマを満たさない場合に返します。 |
| `404` | `/errors/orders/not-found` | 指定した注文が存在しない、または呼び出し元から参照できない場合に返します。 |
| `413` | `/errors/request/body-too-large` | JSON リクエストボディが 1 MiB の上限を超える場合に返します。 |
| `415` | `/errors/request/unsupported-media-type` | JSON 形式のリクエストボディを要求するエンドポイントに、対応していない Content-Type が指定された、または Content-Type が指定されていない場合に返します。 |
| `422` | `/errors/orders/update-rejected` | 注文状態、決済手段、指定値、更新回数などの業務ルールにより、注文内容、メールアドレス、配送先、配送希望日時、またはショップメモを更新できない場合に返します。 |
| `502` | `/errors/internal/bad-gateway` | BASE API が処理を完了するために必要な内部処理で不整合が発生した場合に返します。 |
| `504` | `/errors/internal/gateway-timeout` | BASE API が処理を完了するために必要な内部処理が制限時間内に完了しなかった場合に返します。 |