指定した配送先の発送情報を更新します。

対象の受注の発送情報（送り状番号・到着予定日・発送処理日）を追加し、発送日を追記することで発送ステータスを「未発送」から「発送済み」に更新することができます。
受注ごとに最大100件まで更新できます。

まずはじめに、「概要」「共通仕様」について、futureshop APIv2についてをご覧ください。

ポイント基本設定-ポイント有効処理設定ポイント基本設定-ポイント有効処理にて「発送時に有効」チェックONの場合でも、API経由のステータス変更では、ポイントは自動的に有効となりません。

URL
HTTPメソッド
リクエストヘッダー
リクエストボディ
レスポンス
エラーコード

更新/更新予定

※日付が「予定日」のものは、更新内容が変わる可能性がございます。

更新日/予定日	更新内容		更新理由
2022.08.31	リクエストボディ-invoiceNo	byte数修正　20→100		参照
2022.06.23	エラーコード-results	「CannotUpdateStorePickup」追加	店舗受取オプションの追加対応	参照

更新履歴はAPI更新履歴一覧をご覧ください。

URL

https://{APIドメイン}/admin-api/v1/shipping/status

HTTPメソッド

POST

リクエストヘッダー

アクセストークンなどの詳細はアクセストークンによる認証を参照してください。

リクエストボディ(json)

「必須」：jsonのキーとして必須の場合「〇」

key				項目名	必須	型	byte	内容
orderList				受注リスト	○	Array	-	受注ごとに配列出力。最大100件
	orderNo			受注コード	○	String	12
	shipmentList			お届け先情報	○	Array	-	お届け先ごと
		shipmentNo		お届け先No	○	Number	3
		shippingInfo		配送情報	○	String	-
			invoiceNo	送り状番号	○	String	100	半角/全角可指定がない場合は空白でも更新可能。ただし指定がある場合に空白にすると、空白で上書きされます。
			expectedArrival	到着予定日	○	String	10	「yyyy-mm-dd」形式指定がない場合は空白でも更新可能。ただし指定がある場合に空白にすると、空白で上書きされます。
			shippingDate	発送処理日	○	String	10	「yyyy-mm-dd」形式指定がない場合は空白でも更新可能。ただし指定がある場合に空白にすると、空白で上書きされます。

サンプル

{
    "orderList": [
        {
            "orderNo": "100000002828",
            "shipmentList": [
                {
                    "shipmentNo": 1,
                    "shippingInfo": {
                        "invoiceNo": "111111",
                        "expectedArrival": "2020-10-02",
                        "shippingDate": "2020-09-26"
                    }
                }
            ]
        }
    ]
}

レスポンス

key		項目名	必須	型	byte	内容
status		ステータス	○	String	-	成功：success 失敗：failed ※一部更新失敗の場合、failedを出力
errors		エラーリスト		Array	-	リクエストのエラー発生時に出力
	code	コード	○	String	-
	path	パス		String	-	入力値エラーの場合、対象のjson位置を出力
	message	メッセージ	○	String	-
results		エラーリスト		Array	-	処理結果
	status	ステータス	○	String	-	成功：success 失敗：failed
	orderNo	受注コード		String	-
	shipmentNo	お届け先No		String	-	指定したお届け先Noがない場合に出力
	code	コード	○	String	-
	message	メッセージ	○	String	-

エラーコード

errors
コード	メッセージ	説明
WrongFormat	リクエストデータがjson形式ではありません	json形式ではない場合に返却されます。
InvalidDateFormat	◯◯の日付フォーマットを正しく指定してください	日付のフォーマットが不正の場合に出力します。
ErrorsPresent	エラーが発生した商品があります	更新時に問題が発生した場合に返却されます。resultsのエラー内容をご確認下さい。

results
コード	メッセージ	説明
TooMany	ordersListの指定は100件までです	受注リストの数が100件を超過した場合に返却されます。
TooLong	orderNoは12文字以内で指定してください	orderNoが長過ぎます。12文字以下で指定して下さい。
InvalidValue	orderNoの指定が不正です	数値が正しく指定されてない場合に返却されます。
TooLong	shipmentNoは3文字以内で指定してください	shipmentNoが長過ぎます。3文字以内で指定して下さい。
InvalidValue	shipmentNoの指定が不正です	数値が正しく指定されてない場合に返却されます。
TooMany	shipmentListの指定は20件までです	お届け先情報の数が20件を超過した場合に返却されます。
TooLong	invoiceNoは100文字以内で指定してください	invoiceNoが長過ぎます。100文字以内で指定して下さい。
InvalidDateFormat	expectedArrivalの日付フォーマットを正しく指定してください	「yyyy-mm-dd」の形式で指定して下さい。
InvalidDateFormat	shippingDateの日付フォーマットを正しく指定してください	「yyyy-mm-dd」の形式で指定して下さい。
OrderLocked	指定された受注はロックされています	決済方法がPAYPAYの場合、増額売上げ承認待ち時に受注更新が不可となるため時間を空けてリクエストして下さい。
OrderNotFound	指定された受注が登録されていません	受注データが存在しない場合に返却されます。
CannotUpdateShippingStatus	予約受注のため出荷の更新は行えません	予約受注の場合、出荷処理を行えないため、通常受注へ変更後に更新可能となります。
DeliveryChanged	指定されたお届け先情報が変更されました	処理中にお届け先が変更され更新不可となった場合に返却されます。画面等で情報を変更している可能性があるため、時間を空けてリクエストして下さい。
DeliveryNotFound	指定されたお届け先が登録されていません	指定されたお届け先がない場合に返却されます。
CannotUpdateStorePickup	店舗受取受注のため、送り状番号・着予定の更新は行えません	店舗受取受注に対して、送り状番号、着予定のいずれかに値を設定していた場合に返却されます。

サンプル（エラー時）

{
    "status": "failed",
    "errors": [
        {
            "code": "ErrorsPresent",
            "message": "エラーが発生した商品があります"
        }
    ],
    "results": [
        {
            "orderNo": "100000002828",
            "errorCode": "OrderLocked",
            "message": "指定された受注はロックされています",
            "status": "failed"
        }
    ]
}

サンプル（成功時）

{
  "status": "success",
  "results": [
    {
      "orderNo": "100000067730",
      "status": "success"
    },
    {
      "orderNo": "100000066248",
      "status": "success"
    }
  ]
}

サンプル（一部失敗/一部成功時）

{
  "status": "failed",
  "errors": [
    {
      "code": "ErrorsPresent",
      "message": "エラーが発生しました"
    }
  ],
  "results": [
    {
      "orderNo": "100000067730",
      "status": "success"
    },
    {
      "orderNo": "100000067731",
      "errorCode": "OrderNotFound",
      "message": "指定された受注が登録されていません",
      "status": "failed"
    }
  ]
}

発送API