API リファレンス / 注文

注文配送先更新

リクエスト例

curl -X PUT "https://apiv2.thebase.com/api/orders/<unique_key>/shipping" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": {
    "first": "太郎",
    "last": "山田"
  },
  "address": {
    "zip_code": "0000000",
    "prefecture": "東京都",
    "address": "サンプル市1-2-3",
    "address2": "サンプルビル101",
    "tel": "0000000000"
  }
}'

パラメータ

リクエストボディ application/json

• nameOrderShippingUpdateName必須
  • firststring必須1 文字以上 / 255 文字以下
    配送先の名（1〜255 文字）
  • laststring必須1 文字以上 / 255 文字以下
    配送先の姓（1〜255 文字）
• addressOrderShippingUpdateAddress必須
  • zip_codestring必須1 文字以上 / 10 文字以下
    配送先の郵便番号（1〜10 文字）
  • prefecturestring必須1 文字以上 / 40 文字以下
    配送先の都道府県または州（1〜40 文字）
  • addressstring必須1 文字以上 / 255 文字以下
    配送先の市区町村・番地（1〜255 文字）
  • address2string必須1 文字以上 / 255 文字以下
    配送先の建物名・部屋番号など（1〜255 文字）
  • telstring必須1 文字以上 / 15 文字以下 / pattern: ^\+?\d+$
    配送先の電話番号（15 文字以内）。数字のみ、または先頭に + を付けた番号を指定できます。

レスポンス

200 のレスポンスボディ（application/json）:

• nameOrderShippingName必須
  • firststring必須nullable
    名。配送先未登録時は null です。
  • laststring必須nullable
    姓。配送先未登録時は null です。
• addressOrderShippingAddress必須
  • countrystring必須nullable
    国名。配送先未登録時は null です。
  • country_codestring必須nullable
    国コード（ISO 3166-1 alpha-2）。未登録または国コードを特定できない場合は null です。
  • zip_codestring必須nullable
    郵便番号。配送先未登録時は null です。
  • prefecturestring必須nullable
    都道府県。配送先未登録時は null です。
  • addressstring必須nullable
    市区町村・番地。配送先未登録時は null です。
  • address2string必須nullable
    建物名・部屋番号など。配送先未登録時は null です。
  • telstring必須nullable
    電話番号。未登録時は null です。

エラー

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

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