メインコンテンツへスキップ
バージョン: 最新版

スケジュールの一括削除

1つまたは複数の課金スケジュールを単一のリクエストで完全に削除します。削除されたスケジュールは今後の実行を行わず、復元することはできません。過去の実行と関連する課金は履歴記録として保持されます。


🔑API認証情報

リクエストパラメータ

必須 - 1フィールド必須パラメータ
`schedule_ids`ARRAY(required)
削除するスケジュールIDの配列。各IDはschd_で始まる必要があります。リクエスト当たり最大100 ID。
Example:"[\"schd_test_5xuy4w91xqz7d1w9u0t\", \"schd_test_5xuy4w91xqz7d1w9u0s\"]"
Constraints:リクエスト当たり最大100 ID, 削除は永続的で元に戻せません

レスポンス

200

スケジュール削除

各スケジュールの詳細を含む一括削除操作のサマリーを返します。

レスポンスに含まれる内容:
  • object - 常に "bulk_operation"
  • operation - "delete"
  • total_count - 提供されたスケジュールIDの総数
  • successful_count - 正常に削除されたスケジュール数
  • failed_count - 削除に失敗したスケジュール数
  • results - 各スケジュールの結果オブジェクトの配列
各結果オブジェクトに含まれる内容:
  • schedule_id - スケジュールID
  • status - "success" または "failed"
  • schedule - deleted=trueの削除されたスケジュールオブジェクト(成功時)
  • error_code - エラーコード(失敗時)
  • error_message - エラーの説明(失敗時)
重要な注意事項:
  • 削除は永続的で元に戻せません
  • 削除されたスケジュールによって作成された過去の課金は影響を受けません
  • 本日予定されている保留中の実行は、まだ実行される可能性があります

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

一般的な原因:
  • schedule_idsパラメータが欠落
  • schedule_idsが配列ではない
  • 空のschedule_ids配列
  • 100を超えるスケジュールIDが提供された
  • 無効なスケジュールID形式

401

認証エラー

認証に失敗しました。APIキーが無効または欠落しています。

一般的な原因:
  • Authorizationヘッダーが欠落
  • 無効なシークレットキー
  • シークレットキーの代わりにパブリックキーを使用
  • HTTP Basic Auth形式が不正

404

見つかりません

エンドポイントが見つからないか、機能が有効になっていません。

一般的な原因:
  • アカウントで一括操作機能が有効になっていない
  • APIエンドポイントURLが不正

5xx

サーバーエラー

サーバー側でエラーが発生しました。これらは稀ですが、適切に処理する必要があります。

対処方法:
  • 指数バックオフでリクエストをリトライ
  • status.omise.coでサービスインシデントを確認
  • 詳細なガイダンスはエラー処理を参照

コードサンプル

# 複数のスケジュールを削除
curl https://api.omise.co/schedules/bulk_delete \
-X DELETE \
-u skey_test_5xuy4w91xqz7d1w9u0t: \
-H "Content-Type: application/json" \
-d '{
"schedule_ids": [
"schd_test_5xuy4w91xqz7d1w9u0t",
"schd_test_5xuy4w91xqz7d1w9u0s",
"schd_test_5xuy4w91xqz7d1w9u0r"
]
}'

エラーと結果コード

一般的なエラーコード

コード説明解決方法
authentication_failure無効なAPIキーシークレットキーが正しいことを確認
invalid_schedule_ids無効または欠落したschedule_ids有効なスケジュールID配列を提供
too_many_ids100を超えるIDが提供された複数のリクエストに分割

スケジュール別エラーコード

コード説明解決方法
schedule_not_foundスケジュールIDが存在しないスケジュールIDが正しいことを確認
schedule_already_deletedスケジュールは既に削除済みアクション不要

削除後のスケジュールステータス

フィールド
statusdeleted
deletedtrue
deleted_at削除のタイムスタンプ

試してみる

必須 - 1項目
あなたのIP: ...読み込み中...