1. オンラインマニュアル
  2. 外部連携・フィード・API
  3. APIについて
  4. 受注ステータス変更(処理済)API
コマースクリエイターでのショップ開店がはじめての方はこちら ショップ開店ガイド
管理画面メニューガイド
  • まずはじめに
  • [TOP]
  • [commerce creator]メニュー
  • [設定]メニュー
  • [システム]メニュー
  • [管理]メニュー
  • [運用]メニュー
コマースクリエイター構築ガイド
  • はじめてのコマースクリエイター
  • 使いこなそうコマースクリエイター
  • ユーザー画面リファレンス
  • 仕様・初期値
  • 画像登録
  • コマースクリエイターへの移行
決済機能について
外部連携・フィード・API
一括登録・一括取得
  • 一括登録のエラー内容について
  • 商品基本データ
  • 予約データ
  • グループデータ
  • 会員・メールマガジン会員
  • ポイント・クーポン
  • 定期・頒布会データ
  • STAFF START関連
  • 受注データ
オプション
  • フューチャーカートリカバリー
  • futureサジェストリンク
  • futureRecommend2
その他
  • セキュリティ対策について
コマースクリエイターでのショップ開店がはじめての方はこちら ショップ開店ガイド
管理画面メニューガイド
  • まずはじめに
  • [TOP]
  • [commerce creator]メニュー
  • [設定]メニュー
  • [システム]メニュー
  • [管理]メニュー
  • [運用]メニュー
コマースクリエイター構築ガイド
  • はじめてのコマースクリエイター
  • 使いこなそうコマースクリエイター
  • ユーザー画面リファレンス
  • 仕様・初期値
  • 画像登録
  • コマースクリエイターへの移行
決済機能について
外部連携・フィード・API
一括登録・一括取得
  • 一括登録のエラー内容について
  • 商品基本データ
  • 予約データ
  • グループデータ
  • 会員・メールマガジン会員
  • ポイント・クーポン
  • 定期・頒布会データ
  • STAFF START関連
  • 受注データ
オプション
  • フューチャーカートリカバリー
  • futureサジェストリンク
  • futureRecommend2
その他
  • セキュリティ対策について
コマースクリエイターでのショップ開店がはじめての方はこちら ショップ開店ガイド
管理画面メニューガイド
  • まずはじめに
  • [TOP]
  • [commerce creator]メニュー
  • [設定]メニュー
  • [システム]メニュー
  • [管理]メニュー
  • [運用]メニュー
コマースクリエイター構築ガイド
  • はじめてのコマースクリエイター
  • 使いこなそうコマースクリエイター
  • ユーザー画面リファレンス
  • 仕様・初期値
  • 画像登録
  • コマースクリエイターへの移行
決済機能について
外部連携・フィード・API
一括登録・一括取得
  • 一括登録のエラー内容について
  • 商品基本データ
  • 予約データ
  • グループデータ
  • 会員・メールマガジン会員
  • ポイント・クーポン
  • 定期・頒布会データ
  • STAFF START関連
  • 受注データ
オプション
  • フューチャーカートリカバリー
  • futureサジェストリンク
  • futureRecommend2
その他
  • セキュリティ対策について

受注ステータス変更(処理済)API

指定した受注のステータスを処理済に更新します。

1リクエストで、最大100件の受注のステータスを「処理済」に更新できます。
「受注番号」を指定してリクエストします。

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

URL

https://{APIドメイン}/admin-api/v1/order/complete

HTTPメソッド

POST

リクエストヘッダー

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

リクエストボディ(json)

key 項目名 必須 byte 内容
orderList 受注リスト Array - 受注ごとに配列。最大100件
orderNo 受注番号 String 12
{
    "orderList": [
        {
            "orderNo": "100000002828"
        }
    ]
}

レスポンス

key 項目名 必須
status ステータス String - 成功:success
失敗:failed
※一部更新失敗の場合、failedを出力
errors エラーリスト Array - リクエストのエラー発生時に出力
code コード String -
path パス String - 入力値エラーの場合、対象のjson位置を出力
message メッセージ String -
results エラーリスト Array - 処理結果
status ステータス String - 成功:success
失敗:failed
orderNo 受注番号 String -
code コード String -
message メッセージ String -
コード メッセージ 説明
results
TooMany ordersListの指定は100件までです 受注リストの数が100件を超過した場合に返却されます。
TooLong orderNoは12文字以内で指定してください orderNoが長過ぎます。12文字以下で指定して下さい。
InvalidValue orderNoの指定が不正です 数値が正しく指定されてない場合に返却されます。
DuplicateOrderNo orderNoが重複しています orderList内に同じ受注番号が存在する場合に返却されます。
OrderLocked 指定された受注はロックされています 決済方法がPayPayの場合、増額売上げ承認待ち時に受注更新が不可となるため時間を空けてリクエストして下さい。
※増額売上承認待ちについて詳しくはPayPay画面遷移と対応機能-受注処理ロックについてをご覧ください。
OrderNotFound 指定された受注が登録されていません 指定された受注が存在しない場合に返却されます。
CannotUpdateOrderStatus 指定された受注の処理状況区分では処理できません 指定された受注のステータスが通常処理以外の場合、返却されます。
サンプル(エラー時)
{
    "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": "100000002828",
		"errorCode": "OrderLocked",
		"message": "指定された受注はロックされています",
		"status": "failed"
	  }
	]
  }