注文メールアドレス更新
指定した注文の注文者のメールアドレスを設定します。
注文者の氏名や住所は変更しません。
次の場合は変更できず、422 を返します。
- メールアドレスがブロックリストに登録されている場合
- 注文の変更回数が上限に達している場合
- 注文状態や決済手段により変更できない場合
更新すると、ショップおよび購入者へメールアドレスの変更を知らせるメールを送信します。
更新後の購入者情報を取得できた場合は 200、更新は成功したものの購入者情報を取得できない場合は 204 を返します。
204 の場合は同じリクエストを再送しないでください。
5xx の場合は更新の成否を確定できないため、再送せずに GET /api/orders/{unique_key} で状態を確認してください。
リクエスト例
curl
curl -X PUT "https://apiv2.thebase.com/api/orders/<unique_key>/customer" \
-H "Authorization: Bearer <your-token>" \
-H "Content-Type: application/json" \
-d '{
"mail_address": "customer@example.com"
}'
パラメータ
unique_key
OrderUniqueKey · path
必須
注文の一意キー(16 桁の半角英数字)。小文字は大文字として扱います。
リクエストボディ application/json
- mail_addressstring (email)必須255 文字以下注文者のメールアドレス(255 文字以内)
レスポンス
200
更新成功。更新後の購入者情報を返します。
204
更新成功。更新後の購入者情報を取得できないため、レスポンス本文は返しません。
200 のレスポンスボディ(application/json):
- nameOrderCustomerName必須
- firststring必須名
- laststring必須姓
- first_kanastring必須nullable名(カナ)。未登録時は null です。
- last_kanastring必須nullable姓(カナ)。未登録時は null です。
- mail_addressstring必須購入時に登録されたメールアドレス。未登録時は空文字です。
- addressOrderCustomerAddress必須
- countrystring必須国名。日本国内であれば 'Japan' です。
- country_codestring必須nullable国コード(ISO 3166-1 alpha-2)。国コードを特定できない場合は null です。
- zip_codestring必須郵便番号。ハイフンの有無は保存時のままです。
- prefecturestring必須都道府県
- addressstring必須市区町村・番地
- address2string必須建物名・部屋番号など
- telstring必須nullable電話番号。未登録時は null です。
エラー
エラーは application/problem+json の Problem 形式で返します。
認証・スコープ・予期しない内部エラーなど、すべてのエンドポイントに共通のエラーと
構造・判別方法は エラーレスポンス を参照してください。
このエンドポイントが返すその他のエラーは次のとおりです。
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 が処理を完了するために必要な内部処理が制限時間内に完了しなかった場合に返します。 |