開発者向けサポート

/item_serials

商品シリアル情報一覧を取得します。

必要権限

  • item

提供メソッド

GET

サンプル
リクエスト
GET item_serials.json?query=%5B%7B%22cast_to%22%3Anull%2C%22coalesce%22%3Anull%2C%22column%22%3Anull%2C%22column_postfix%22%3Anull%2C%22column_prefix%22%3Anull%2C%22lower_or_upper%22%3Anull%2C%22operand%22%3A%5B%7B%22cast_to%22%3Anull%2C%22coalesce%22%3Anull%2C%22column%22%3A%22ITEM_ID%22%2C%22column_postfix%22%3Anull%2C%22column_prefix%22%3Anull%2C%22lower_or_upper%22%3Anull%2C%22operand%22%3Anull%2C%22operator%22%3A%22equals%22%2C%22to_char_format%22%3Anull%2C%22value%22%3A20481%7D%5D%2C%22operator%22%3A%22and%22%2C%22to_char_format%22%3Anull%2C%22value%22%3Anull%7D%5D&result_count=10&page=1&select=ITEM_ID%2CITEM_SERIAL_ID%2CITEM_SERIAL_NO%2CITEM_SERIAL_NAME
レスポンス
200 OK
			
			[
				{"ITEM_ID": 1, "ITEM_SERIAL_ID": 1, "ITEM_SERIAL_NO": "123", "ITEM_SERIAL_NAME": "SERIAL1"},
				{"ITEM_ID": 1, "ITEM_SERIAL_ID": 2, "ITEM_SERIAL_NO": "321", "ITEM_SERIAL_NAME": "SERIAL2"},
			]
リクエスト文説明
クエリーパラメータ

select
取得する列名を指定します。指定しない場合は ITEM_SERIAL_ID, ITEM_ID, ITEM_SERIAL_NO, ITEM_SERIAL_NAME, ITEM_SERIAL_KBN, ORDER_NO, ORDER_D_NO, ITEM_SERIAL_USE を指定した場合と同じ動作をします。
"count(*)"のみを指定した時は、商品シリアルのリストではなく、条件にマッチする件数を返します。このとき結果は次の形式になります。[{"count(*)": 件数数値}]
query
検索条件をJSON形式で指定します。詳細はデータアクセスAPIのページの共通パラメータを参照してください。
result_count
検索結果の取得数を指定します。1～100で指定してください。未指定の場合、結果は20件分返します。
page
取得するページ番号 ((page-1)*resultCount)+1件目からpage*resultCount件目までのデータが取得対象となります。未指定の場合は1が指定されたものとして動作します。

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

商品シリアル情報を格納したJSON値を返します。

POST

サンプル
リクエスト
POST item_serials.json?data_type=multi_upsert&use_item_cd=true
			
			[
				{"ITEM_CD": "ITEM1", "ITEM_SERIAL_NO": "serial1", "ITEM_SERIAL_NAME": "SERIAL1"},
				{"ITEM_CD": "ITEM2", "ITEM_SERIAL_NO": "serial2", "ITEM_SERIAL_NAME": "SERIAL2"}
			]
レスポンス
200 OK
			
			{
				"errorInfoList":[],
				"successInfoList":[
					{"itemCd":"ITEM1","itemSerialNo":"serial1"},
					{"itemCd":"ITEM2","itemSerialNo":"serial2"}
				]
			}
リクエスト文説明
クエリーパラメータ

data_type
multi_upsert:複数データの登録・更新を行う場合に指定します。商品コードが存在する場合、更新を行い、存在しない場合、登録を行います。一度に指定できる商品は100件までになります。
use_item_cd
data_type=multi_upsertを指定した場合、この値にtrueを設定すると商品IDではなく商品コードを指定することが可能です。現在trueしか許容していません。

ボディー文字列

商品シリアルの情報を格納したJSON文字列です。トランザクションには未対応です。

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

data_type=multi_upsertの場合、以下の形式をレスポンスとして返します。
{
"successInfoList":[{"itemCd":"商品コード","itemSerialNo":"商品シリアル番号"}],
"errorInfoList":[{"index":1,"itemCd":"商品コード","itemSerialNo":"商品シリアル番号","messages":["エラーメッセージ"]}]
}

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