定期購入APIで共通に利用する定義

定期購入APIで共通に利用する各種コードやエラーコードなどの定義をまとめて記載しております。

配送会社コード

配送会社コードの一覧は以下をご覧ください。

注文詳細API - 配送会社コード（ShipCompanyCode）

解約理由コード

出店者様からの親注文解約理由（お客様都合）

解約理由コード 解約理由
100 解約
110 返品
120 未入金
130 住所不明
140 受け取り拒否
150 連絡不通
160 重複注文
170 決済審査不可
180 その他

出店者様からの親注文解約理由（出店者様都合）

解約理由コード 解約理由
200 決済方法都合
210 欠品
220 販売中止
230 その他
240 商品価格の切替
250 商品のリニューアル等による切替
260 商品価格の変更、リニューアル等による切替

お客様からの親注文解約理由

解約理由コード 解約理由
800 誤って定期購入を申し込んでしまったため
810 クーポンを利用し忘れたため
820 他に安い価格の商品を見つけたため
830 送料が高かったため
840 商品が希望時期に届かないため
850 商品の在庫がなかったため
860 商品が必要なくなったため
870 別の商品に切り替えたいため
890 その他

子注文フェーズ

子注文フェーズ 子注文の状態
0 生成後 子注文フェーズの初期値で子注文が生成
1 リマインドメール送信済み リマインドメール送信完了
2 発注情報取得待ち 注文情報の生成開始
4 注文要求成功 注文情報の生成処理中
5 注文生成リトライ待ち（翌日） 注文情報生成時に商品の在庫や、決済等でエラーが発生し、
翌日に注文情報生成のリトライを実施予定
6 注文生成リトライ待ち（即日） 注文情報生成時に何らかのエラーが発生し、
即日で注文情報生成のリトライを実施予定
7 注文完了 注文情報の生成完了
8 キャンセル 以下いずれかの理由による状態
・親注文の解約により、次回の注文情報を生成する子注文がキャンセル
・「7（注文完了）」で生成した注文情報がキャンセル
9 スキップ 以下いずれかの理由による状態
・お客様またはストアによりスキップ操作された
・「2（発注情報取得待ち）」にて即スキップとなるエラー（ストアの一時休店、退店など）が発生した
・「5 および 6（注文生成リトライ待ち）」でリトライ後もエラーが解消されなかった
99 結果不明 システムエラーが発生
ストアクリエイターProで「定期購入注文実績」を確認した際の「表示文言：その他」と同じ状況のため
詳細は 「ストアクリエイターPro」対応のマニュアル を参照ください
子注文フェーズ

変更要求ステータスと変更要求詳細フェーズの遷移について

変更要求ステータス変更要求詳細フェーズ詳細
1:変更対象抽出待ち-（レコードなし:0）一括変更の変更要求で、変更対象になる注文の抽出が終わっていない状態
2:有効（＝取り消し可能な変更要求）通知待ち:2有効な変更要求があり、ユーザに変更通知前の状態
3:完了通知済み:3通知待ちステータスの変更要求をリマインドメールで通知した後に遷移する。
ユーザの定期購入履歴に変更後の商品で再注文の案内が表示される。
4:無効キャンセル:5ストアが変更要求をキャンセルしたときに遷移する。
変更要求不要:6変更通知前に親注文が解約になった場合、変更要求不要に遷移する。
重複キャンセル:7すでに変更要求がある注文の商品に対して、新たに変更要求が発生した場合、古い変更要求をこのステータスに変更する。

エラーコード

レスポンスフィールド

要素名称型
errorエラーコードstring
messageエラーメッセージstring

サンプルレスポンス（JSON）

{
  "error": "SUBSCRIPTION-ORDER-API-0001",
  "message": "Entrypoint does not exist."
}

エラーコード一覧

エラーコードHTTPステータスコード
（※1）		エラーメッセージ例
（※2）		内容
SUBSCRIPTION-ORDER-API-0001404Entrypoint does not exist.誤ったリクエストURLでアクセスした場合
SUBSCRIPTION-ORDER-API-0011404Could not find the resource: <リソース名>要求されたデータが存在しなかった場合
SUBSCRIPTION-ORDER-API-0022405Request method not allowed: <メソッド名>許可されていないメソッドで実行された場合
SUBSCRIPTION-ORDER-API-0101500DB get failure. <詳細メッセージ>DBからの読み込みに失敗した場合
SUBSCRIPTION-ORDER-API-0102500DB update failure. <詳細メッセージ>DBの更新に失敗した場合
SUBSCRIPTION-ORDER-API-0103500SellerDB Error.DBから取得した値のパースに失敗した場合
SUBSCRIPTION-ORDER-API-0201400Cannot change origin or replica.変更不可能な親注文、及び子注文を更新しようとした場合（変更、お届け予定日変更、スキップ、解約）
SUBSCRIPTION-ORDER-API-0202400Change history exceeds the limit.変更可能回数を超えている場合
SUBSCRIPTION-ORDER-API-0211400Cannot change ship date.変更しようとしたお届け予定日が変更不可能な日付の場合
SUBSCRIPTION-ORDER-API-0221400Cannot change <パラメータ名>.変更しようとした値がパラメータエラーの場合（変更不可能な項目の場合も含む）
SUBSCRIPTION-ORDER-API-0301400Cannot transfer the phase.現在の子注文フェーズから移行不可能なフェーズに移行しようとした場合
SUBSCRIPTION-ORDER-API-0401400Skip target date is over a year ahead.スキップ可能なお届け予定日を超えてスキップしようとした場合
SUBSCRIPTION-ORDER-API-1011400Insufficient parameter: <パラメータ名>リクエスト内容が不正の場合
SUBSCRIPTION-ORDER-API-1021409Request conflict: <詳細>リクエストが重複している場合
SUBSCRIPTION-ORDER-API-2011401（なし）認証エラーの場合
SUBSCRIPTION-ORDER-API-2021403Invalid authority.認可エラーの場合（異なるセラーの情報にアクセスしようとしているなど）
SUBSCRIPTION-ORDER-API-3011503Service unavailable.メンテナンス中の場合
SUBSCRIPTION-ORDER-API-4011500Internal API error.DB接続失敗
SUBSCRIPTION-ORDER-API-4012500Internal API error. 親注文情報の取得に失敗した場合
SUBSCRIPTION-ORDER-API-4014500Internal API error.変更履歴詳細の取得に失敗した場合
SUBSCRIPTION-ORDER-API-4015500Internal API error.更新および変更履歴の登録に失敗した場合
SUBSCRIPTION-ORDER-API-4016500Internal API error.初回受注に失敗した場合
SUBSCRIPTION-ORDER-API-4017500Internal API error. 子注文情報の取得に失敗した場合
SUBSCRIPTION-ORDER-API-4018500Internal Server Error.商品情報の参照に失敗した場合
SUBSCRIPTION-ORDER-API-0601500Item info get error.変更要求時に対象のアイテムIDが存在しない場合
SUBSCRIPTION-ORDER-API-0602500Target Order NotFound Error.変更要求時に対象の有効な定期購入親注文が存在しない場合
SUBSCRIPTION-ORDER-API-0603400Cannot change this change request.変更不可であるフェーズの変更要求に対しリクエストされた場合
SUBSCRIPTION-ORDER-API-0604400The request contains current price.一括変更要求において、現在設定されている商品の価格と同一の価格がリクエストに変更対象として含まれる場合
SUBSCRIPTION-ORDER-API-0605400invalid subscription item.一括変更要求において、現在設定されている商品情報が定期商品でなかった場合
SUBSCRIPTION-ORDER-API-0606404Change Request NotFound.指定された変更要求が存在しなかった場合
SUBSCRIPTION-ORDER-API-9999500Unknown error.その他想定外のエラーの場合

※1 HTTPステータスコードの400番台は、APIをご利用頂いているストア側のリクエストに問題があって発生したエラーになります。
※2 記載しているエラーメッセージは、該当エラーコードで返却される一例のため、エラーの判定には message のエラーメッセージは使わず、error のエラーコードで判別してください。

アプリケーションの管理

目次

利用のルール

開発のヒント