開発者向けサポート

/order_details

必要権限

  • privacy

提供メソッド

GET

サンプル
リクエスト
GET /order_details.json?select=ORDER_NO,ITEM_ID,TEIKA,QUANTITY&query=%5b%7b%22operand%22%3a%5b%7b%22column%22%3a%22ITEM_ID%22%2c%22operator%22%3a%22equals%22%2c%22value%22%3a1%7d%2c%7b%22column%22%3a%22ORDER_NO%22%2c%22operator%22%3a%22equals%22%2c%22value%22%3a2%7d%5d%2c%22operator%22%3a%22and%22%7d%5d
レスポンス
200 OK

[
	{"ORDER_NO": 2,"ITEM_ID": 2,"TEIKA": 100,"QUANTITY": 1}
]
リクエスト文説明
クエリーパラメータ

select
取得する列名を指定します。指定しない場合は ORDER_NO,ORDER_D_NO,ITEM_ID,ITEM_ITEMPROPERTY_CD,ITEM_NAME,LOT_COUNT,TEIKA を指定した場合と同じ動作をします。
"count(*)"のみを指定した時は、受注明細のリストではなく、条件にマッチする件数を返します。このとき結果は次の形式になります。[{"count(*)": 件数数値}]
query
検索条件データをJSON形式で指定します。
search_order
ORDERBY句で指定するカラムを指定します。
search_groupを指定しておらず、かつsearch_orderを指定しない場合は受注番号(ORDER_NO),明細番号(ORDER_D_NO)を基準に昇順で並べ変えられます。
また、ORDER_NO, ORDER_D_NOは一意の項目です。
search_group
GROUPBY句で指定するカラムを指定します。
result_count
検索結果の取得数を指定します。1～100で指定してください。未指定の場合、結果は20件分返します。
page
取得するページ番号 ((page-1)*resultCount)+1件目からpage*resultCount件目までのデータが取得対象となります。未指定の場合は1が指定されたものとして動作します。

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

受注明細情報を格納したJSON値を返します。

POST

サンプル
リクエスト
POST order_details.json?data_type=multi_update

[
	{
		"ORDER_NO": "1",
		"ORDER_D_NO": "1",
		"FREE_ITEM1": "2"
	},
	{
		"ORDER_NO": "20000000",
		"ORDER_D_NO": "1",
		"FREE_ITEM1": "2"
	}
]
レスポンス
200 OK

{
	"errorOrderDetails": [
		{
			"ORDER_NO": "20000000",
			"ORDER_D_NO": "1",
			"index": 1,
			"messages": [
				"order not found"
			]
		}
	],
	"succeededOrderDetails": [
	{
		"ORDER_NO": "1",
		"ORDER_D_NO": "1"
	}
	]
}
リクエスト文説明
クエリーパラメータ

data_type
リクエストデータの種別です。指定できる値：multi_update

ボディー文字列

リクエストパラメータ "data_type" = "multi_update"の場合:
複数行の受注明細データ更新します。データ形式として、受注番号、明細番号と更新対象プロパティをセットます。
一度に更新できる件数は1000件までです。
現在サポートしている対象プロパティは以下の通りです。サポート外のプロパティを設定することはできません。
  • FREE_ITEM1～100

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

リクエストパラメータ "data_type" = "multi_update"の場合:
次の項目を含むJSONオブジェクトを返します。
  • succeededOrderDetails: 成功したORDER_NO、ORDER_D_NOのリスト
  • ORDER_NO: 受注番号（受注番号が取得できない場合はnull）
  • ORDER_D_NO: 受注明細番号（受注明細番号が取得できない場合はnull）
  • errorOrderDetails: 失敗した受注情報のリスト、それぞれの要素には次のプロパティを含みます。
    • index: リクエストボディに渡したリストのindex値
    • ORDER_NO: 受注番号（受注番号が取得できない場合はnull）
    • ORDER_D_NO: 受注明細番号（受注明細番号が取得できない場合はnull）
    • messages: エラーメッセージを含んだリスト