注文ステータス変更APIリファレンス（広告主向け）

概要

広告主向け管理画面で提供している注文ステータス変更機能と同等の情報を提供するAPIについての仕様書です。 このAPIをリクエストするためには、事前に「広告主向けトークン取得API」へリクエストを行い、有効なトークンを取得している必要があります。ステータス変更に関するリクエストが反映されるまで、最大1時間かかります。

有効期限

このAPIのトークンの有効期限は30分間です。期限が切れるとリクエスト時にエラーメッセージ「invalid_token」が返却されますので、トークン取得APIに再度リクエストを行い、最新のトークンを取得し、指定してください。 エラーメッセージについては「レスポンスヘッダー」の章を参照ください。

利用制限

このAPIでは30分間以内に30回を超える正常リクエストが行われた場合に30分間ロックされます。ロック中のリクエスト時にはエラーメッセージ「locked」が返却されますので、時間を置いて再度リクエストしてください。 エラーメッセージについては「レスポンスヘッダー」の章を参照ください。

リクエスト

エンドポイント

POST https://api.valuecommerce.com/modify/v1/merchant/transaction/status/

リクエストヘッダー

リクエストヘッダーには下記を指定してください。

  • Authorization: Bearer [bearer_token] ※1
  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

リクエストボディー

パラメーター名説明必須許容文字列許容バイト数
callback(※2)コールバック関数名×半角英数および記号【_-】50バイト以下

【注意事項】
1.[bearer_token]部分に、トークン取得APIから取得したbearer_tokenを指定してください。
2.JSONP返却を求める場合のみ指定してください。

ペイロード

パラメーター名説明必須初期値許容文字列許容バイト数
order下記セットの配列を「list」キーの値としたJSONの書式で指定する ※別表参照
JSONの中身は数値、文字列問わずダブルクオートを必須とする		○null半角英数記号JSON書式8,000バイト以下

orderフィールド一覧

フィールド名説明必須初期値許容文字列許容バイト数指定例
id注文番号○null指定なし300"id":"123"
st変更後の注文ステータス
下記から択一指定
a：承認
c：拒否		○null下記半角英字a,c1"st":"a"

指定例

order

「注文ID：123をAに、注文ID：234をC」に変更する場合

{"list":[{"id":"123","st":"a"},{"id":"234", "st":"c"}]}

レスポンス

レスポンスヘッダー

エラーメッセージ

error="XXX"error_description="XXX"の表記で、発生したエラーメッセージを示します。正常レスポンス時にはこの項目は返却しません。各エラーメッセージの示す内容は以下のとおりです。

errorerror_descriptionHTTP STATUS CODE意味対応要求
invalid_requestAuthorization request header is in invalid format (or may not be encoded).401Authorizationヘッダー不正、指定されていない、Base64エンコードされていない場合Authorizationヘッダーの値、生成方法を確認してください
詳しくは「リクエストヘッダー」章を参照ください
invalid_credentialInactive credential value.401Authorizationヘッダーが正常だが、アクティブなサイト署名情報とひもづかない不正値管理画面で表示されているCLIENT_KEY/CLIENT_SECRETを再度ご確認ください
再生成されている可能性があります（このエラーメッセージはトークン取得APIに限り返却します）
invalid_tokenThe current bearer token is invalid or already expired. Please get a new one.401トークンが不正値、または有効期限切れトークン取得APIにリクエストを行い、最新のトークンを取得し、指定してください（このエラーメッセージは認証下APIに限り返却します）
lockedThe endpoint has been locked due to the requests limit. Please try again later.403期間内利用回数の上限を超え、ロック中のエンドポイントに対するアクセス時間をおいて再度リクエストしてください
invalid_parametersSome of request parameters are invalid.400いずれかのリクエストパラメーターが不正値リクエストボディー章をご確認ください
not_found-404存在しないエンドポイントに対するアクセスリクエストされたURLをご確認ください
server_error-500システムメンテナンス中時間をおいて再度リクエストしてください

レスポンスボディー

パラメータ名説明説明詳細正常時返却異常時返却
errorエラー概要レスポンスヘッダー「error」と同一×○
error_descriptionエラー詳細レスポンスヘッダー「error_description」と同一×○
resultSet正常時レスポンスフィールドセット正常処理時のリクエスト・およびレスポンスに関する情報○×
responseInfoレスポンス情報正常処理時のレスポンスに関する情報○×
numberOfTotalResult総件数1（固定）○×
numberOfResult取得件数rowDataフィールド要素数1（固定）○×
responseTimeレスポンス返却日時JST yyyy-mm-dd hh:ii:ss○×
requestInfoリクエスト情報正常処理時のリクエスト要求に関する情報○×
requestTimeリクエスト受付日時JST yyyy-mm-dd hh:ii:ss○×
rowData詳細情報正常処理時のリクエスト要求に対する詳細情報○×
result受付結果true/false
リクエストがすべて正常で、処理を受け付けられたかどうかを返却非同期で処理を行うため、true=処理完了を示すものではない		○×
← 注文レポートAPIリファレンス