開発者向けサポート

/items

商品一覧情報です。クエリを使用して検索をすることができます。

必要権限

  • item

提供メソッド

GET

サンプル
リクエスト
GET /items.json?select=ITEM_CD,ITEM_NAME,TEIKA,categories(CATEGORY_NAME)
レスポンス
200 OK

[
	{"ITEM_CD": "item1", "ITEM_NAME": "商品1", "TEIKA": 1000, "categories": [{"CATEGORY_NAME": "カテゴリ1"}]},
	{"ITEM_CD": "item2", "ITEM_NAME": "商品2", "TEIKA": 2000, "categories": [{"CATEGORY_NAME": "カテゴリ1"}]},
	{"ITEM_CD": "item3", "ITEM_NAME": "商品3", "TEIKA": 4000, "categories": [{"CATEGORY_NAME": "カテゴリ1"}]}
]
リクエスト文説明
クエリーパラメータ

select
取得する列名を指定します。指定しない場合は ITEM_ID,ITEM_CD,ITEM_NAME,TEIKA,MAKER_TEIKA,ITEM_APPEAL_IMAGE,ITEM_APPEAL,ITEM_IMAGE1,ITEM_INFO1,M_ITEM_APPEAL_IMAGE,M_ITEM_APPEAL,M_ITEM_IMAGE1,M_ITEM_INFO1,SALE_DATE,ZAIKO_FLG,ZAIKO_DISP_FLG,MIN_ZAIKO,MIN_QUANTITY,DISCOUNT_FLG,MEMBER_WARIBIKI,NEW_UPDATE_DATE,SORYO_FREE_FLG を指定した場合と同じ動作をします。
"count(*)"のみを指定した時は、商品のリストではなく、条件にマッチする件数を返します。このとき結果は次の形式になります。[{"count(*)": 件数数値}]
item_property_name_list_delimiter
バリエーション名リスト(ITEMPROPERTY_NAME_LIST)で使用する区切り文字を指定します。
query
検索条件をJSON形式で指定します。詳細はデータアクセスAPIのページの共通パラメータを参照してください。
search_order
検索結果の順序を指定します。
search_orderが未指示、もしくはデータの無い値だけを指定した場合、sort_orderでソートされます。
sort_orderにおいても未指示の場合、商品コード(ITEM_CD)を昇順でソートします。また、ITEM_CDは一意の項目です。
result_count
検索結果の取得数を指定します。1～100で指定してください。未指定の場合、結果は20件分返します。
search_group
GROUPBY句で指定するカラムを指定します。search_groupを指定した場合、selectにcategories等のサブリソースを指定することはできません。
page
取得するページ番号 ((page-1)*resultCount)+1件目からpage*resultCount件目までのデータが取得対象となります。未指定の場合は1が指定されたものとして動作します。
item_code
指定した商品コードが一致する商品情報を検索します。
sort_order
検索結果のソート方法として以下のいずれかを指定できます。未指定の場合は商品コードの昇順となります。
1
新着順用更新日で降順にソートします。
2
販売価格で昇順にソートします。
3
販売価格で降順にソートします。
4
商品名(カナ)で昇順にソートします。

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

商品情報を格納したJSON値を返します。

POST

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

{"ITEM_CD":"ITEM1","ITEM_NAME":"商品１","ITEM_KANA":"ショウヒンイチ","TEIKA":100}
レスポンス
200 OK

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

data_type
multi_update:複数更新を行う場合に指定します。一度に更新できる件数は1000件までになります。自由項目のみ更新可能です。
multi_upsert:複数データの登録・更新を行う場合に指定します。商品コードが存在する場合、更新を行い、存在しない場合、登録を行います。一度に指定できる商品は100件までになります。
update_by_query:条件を指定して商品を更新します。予約フラグ、利用制限決済、自由項目のみ更新可能です。
not_reconstruct_skus
data_typeがmulti_upsertで、更新が行われる場合に使用されるパラメータです。未指定、またはfalseの場合、送信されたskus、stocksを元にSKU情報、在庫情報を洗い替えします。trueを指定した場合、洗い替えを行わず、送信されたデータの追加、更新のみを行います。
delete_skus_in_stock
data_typeがmulti_upsertで、更新が行われる場合に使用されるパラメータです。未指定、またはfalseの場合、送信されたskusにより在庫のある商品バリエーションが削除対象なるとエラーになります。trueを指定した場合、在庫のある商品バリエーションが削除対象となった場合、削除を行います。
blank_set_delete_recommends
data_typeがmulti_upsertで、更新が行われる場合に使用されるパラメータです。trueを指定した場合、recommendsに空のリストを設定するとおすすめ商品情報を削除します。未指定、またはfalseの場合、recommendsに空のリストを設定するとおすすめ商品の更新を行いません。

ボディー文字列

商品の情報を格納したJSON文字列、形式はGETと同一です。トランザクションには未対応です。
カテゴリはカテゴリID、カテゴリコードが指定可能です。他の値が指定された場合、エラーとなります。カテゴリID、カテゴリコードの両方が指定されていた場合、カテゴリIDを優先して使用します。
バリエーションごとの在庫を指定する場合、バリエーションのオブジェクト数と在庫のオブジェクト数が一致している必要があります。
multi_updateを指定した場合、現在できるのは商品のFREE_ITEMのみです。
data_typeがmulti_upsertでcalculate_columnsにカラム名を指定した場合、登録済みの値と指定した値を元に加算もしくは減算を行うSQL文を構築し実行します。

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

商品ID。