開発者向けサポート

/coupons

必要権限

  • system

提供メソッド

GET

サンプル
リクエスト
GET coupons.json?select=COUPON_ID,COUPON_CD&query=[{"column":"COUPON_CD","operator":"equals","value":"VGmfhEojALv2vXs"}]
レスポンス
200 OK

[
	{"COUPON_ID": 1,"COUPON_CD": "VGmfhEojALv2vXs"}
]
リクエスト文説明
クエリーパラメータ

select
取得する列名を指定します。指定しない場合は COUPON_ID,COUPON_CD,COUPON_NAME を指定した場合と同じ動作をします。
query
検索条件をJSON形式で指定します。詳細はデータアクセスAPIのページの共通パラメータを参照してください。
search_order
検索結果の順序を指定します。
指定しない場合はクーポンID（COUPON_ID）を基準に昇順で並べ変えられます。
また、COUPON_IDは一意の項目です。
result_count
検索結果の取得数を指定します。1～100で指定してください。未指定の場合、結果は20件分返します。
page
取得するページ番号 ((page-1)*resultCount)+1件目からpage*resultCount件目までのデータが取得対象となります。未指定の場合は1が指定されたものとして動作します。

応答値説明
ボディー文字列

ランキング情報を格納したJSON値を返します。

POST

サンプル
リクエスト
POST coupons.json

{"COUPON_CD":"COUPON1","COUPON_NAME":"クーポン１","COUPON_DISCOUNT":"100"}
レスポンス
200 OK

{"result": 1}
リクエスト文説明
ボディー文字列

クーポンの情報を格納したJSON文字列。

応答値説明
ボディー文字列

クーポンID

DELETE

サンプル
リクエスト
DELETE coupons.json?query=[{"column":"COUPON_CD","operator":"equals","value":"VGmfhEojALv2vXs"}]
レスポンス
200 OK

{"result": 1}
リクエスト文説明
クエリーパラメータ

query
削除対象の検索条件をJSON形式で指定します。詳細はデータアクセスAPIのページの共通パラメータを参照してください。（queryが未指定の場合エラーになります）
search_order
削除対象検索結果の順序を指定します。
指定しない場合はクーポンID（COUPON_ID）を基準に昇順で並べ変えられます。
また、COUPON_IDは一意の項目です。
delete_count
query指定時に一度に削除する最大件数を指定します。

応答値説明
ボディー文字列

削除件数

ここを見た方は他にもこんなページを見ています。