開発者向けサポート

/orders

必要権限

  • privacy

提供メソッド

GET

サンプル
リクエスト
GET orders.json?select=ORDER_NO,TEIKA_SUM,order_details(ITEM_ID,TEIKA,QUANTITY)
レスポンス
200 OK

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

select
取得する列名を指定します。指定しない場合は ORDER_NO,ORDER_DISP_NO,ORDER_DATE,KESSAI_ID,HAISO_ID,SEIKYU,TAX,PAYMENT_DATE,CANCEL_DATE,AUTHORIZATION_FIXED_DATE,AUTHORY_DATE,DEL_DATE,L_NAME,F_NAME,L_KANA,F_KANA,ZIP,ADDR1,ADDR2,ADDR3,TEL,PC_MAIL,MOBILE_MAIL,MEMBER_ID を指定した場合と同じ動作をします。
"count(*)"のみを指定した時は、受注ヘッダーのリストではなく、条件にマッチする件数を返します。このとき結果は次の形式になります。[{"count(*)": 件数数値}]
query
検索条件データをJSON形式で指定します。
result_count
検索結果の取得数を指定します。1～100で指定してください。未指定の場合、結果は20件分返します。
page
取得するページ番号 ((page-1)*resultCount)+1件目からpage*resultCount件目までのデータが取得対象となります。未指定の場合は1が指定されたものとして動作します。
get_calculated_order_data
trueを指定すると、bodyで指定した受注情報を元に金額計算を行った受注情報を返します。

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

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

POST

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

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

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

data_type
リクエストデータの種別です。
multi_update
複数更新を行います。（受注ヘッダ・受注配送先のみが対象）一度に更新できる件数は1000件までとなります。
multi_insert
複数登録を行います。一度に指定できる受注件数は100件までになります。
multi_update_full_order
複数更新を行います。（受注ヘッダ、受注明細を同時に更新）一度に指定できる受注件数は100件までになります。
update_by_query
条件を指定して受注データを更新します。受注決済ステータスのみ更新可能です。
use_stock_allocation
multi_update、multi_insert,multi_update_full_order共通です。true,falseを指定します。
multi_updateの場合、cancelを指定した際、trueであれば、在庫の引当、戻しを行います。
multi_insertの場合、trueであれば、登録した受注明細の商品在庫の引当を行います。
multi_update_full_orderの場合、trueであれば、登録した受注明細の商品在庫の引当を行います（明細のINDEXと商品コードが一致していれば差分引き当て）。削除された明細の在庫の戻しは行われません。
send_mail_flg
multi_insert,multi_update_full_order の場合にtrueを指定すると、店舗管理者に注文メールの送信を行います。
send_mail_target_type
multi_insert,multi_update_full_order の場合にsend_mail_flgがtrue指定の場合に使用です。注文者に送信する場合2、注文者、および、店舗管理者に送信する場合3を指定してください。それら以外の場合、店舗管理者に注文メールの送信を行います。
calculate_price_flg
multi_insert,multi_update_full_order の場合にtrueを指定すると、明細を元にSEIKYU、TEIKA_SUM、TAX、SHIRE_SUM、ADD_POINT_SUMの値を計算を行い設定します。
calculate_shipping_fee_flg
multi_insert,multi_update_full_order の場合にtrueを指定すると、送料の計算を行い設定します。
calculate_point_flg
multi_insert,multi_update_full_order の場合にtrueを指定すると、付与ポイントの計算を行い設定します。ADD_POINTが指定されている場合、指定されたものが優先となります。
use_member_point_flg
multi_insert,multi_update_full_order の場合にtrueを指定すると、会員情報から使用ポイントの減算を行います。
ignore_transaction_check
multi_insertの場合にtrueを指定すると、トランザクション使用時でもエラーになりません。なお、send_mail_flg=trueの場合は本値がtrueでもトランザクション使用時にエラーとなります。トランザクション使用時にエラーとなった場合、それまでそのトランザクションで更新したデータもロールバックされてしまいます。
multi_update_full_orderの場合、複数受注を指定してトランザクションの使用はできません。またトランザクションを使用しても更新元データはトランザクション中のデータではなく、コミット済みのデータとなります。
execute_authorization_flg
multi_insert,multi_update_full_order の場合にtrueを指定すると、オーソリを行う決済であればオーソリを行います（現在、use_saved_credit_flg=trueでGMOPGクレジット決済の場合に動作可能です）。
execute_order_api_flg
multi_insert,multi_update_full_order の場合にtrueを指定すると、受注登録外部API連携を行います。初期設定「受注データ連携OUT 接続先URL」に連携先URLが指定されている必要があります。multi_update_full_orderの場合、初期設定「受注更新時API連携フラグ」に「連携する」を指定する必要があります。
use_saved_credit_flg
multi_insertの場合にtrueを指定すると、指定された会員IDの会員が保存したクレジットカード情報で決済を行います。複数クレジットカード情報が登録されている場合、最後に登録されたものを使用します（現在、GMOPGクレジット決済以外の場合は動作保証できません）。
delete_registered_order_details
multi_update_full_orderの場合にtrueを指定すると、現在、存在する受注明細を削除して、送信された受注明細情報を登録します。falseの場合、受注明細の登録・更新はできません。
update_blank_order_header
multi_update_full_orderの場合にtrueを指定すると、受注ヘッダの必須項目以外の空文字更新が可能となります。
insert_only_teiki_header
multi_insertの場合にtrueを指定すると、定期親受注について親受注しか作成しません。未指定、falseの場合、定期子受注も同時に作成されます。trueの場合、use_stock_allocation, send_mail_flg, use_member_point_flg, execute_authorization_flgは指定しても無視されます。
send_cancel_mail
multi_updateの場合にtrueを指定すると、cancel:onを指定した際に注文キャンセルメールを送信します。
restrict_calculate_add_point
multi_updateの場合にtrueを指定すると、付与ポイントの減算処理(cancel:on)・加算処理(cancel:off)が行われなくなります。
管理画面やバッチ等の他UIからキャンセル処理を行う時はポイント計算が行われ、データアクセスAPIから行う時のみ処理が行われなくなります。
restrict_calculate_use_point
multi_updateの場合にtrueを指定すると、使用ポイントの加算処理(cancel:on)・減算処理(cancel:off)が行われなくなります。
管理画面やバッチ等の他UIからキャンセル処理を行う時はポイント計算が行われ、データアクセスAPIから行う時のみ処理が行われなくなります。
ship_slip_info_not_copy_flg
multi_updateの場合にtrueを指定すると、受注データの送付先情報にあわせて送付先テーブルも更新する際に、出荷関連情報が更新されなくなります。

ボディー文字列

リクエストパラメータ "data_type" = "multi_update"の場合:
複数行の受注データ更新します。データ形式として、受注番号と更新対象プロパティをセットます。
現在サポートしている対象プロパティは以下の通りです。サポート外のプロパティを設定することはできません。
  • ADMIN_UPDATE_USER_ID
  • FREE_ITEM1～100
  • cancel（on, offを指定します。onの場合、受注キャンセル処理を実行し、offの場合、キャンセル状態から有効受注への戻しを行います。）
リクエストパラメータ "data_type" = "multi_insert"の場合:
複数行の受注データ登録します。受注情報のリストを格納したJSON文字列、形式はGETと同一です。
ただし、metadataの指定はできません。また決済連携は行われません。
send_dataは複数配送先オプションが有効な場合のみ指定可能です。
定期受注、頒布会受注の登録については非対応となっております。
受注ヘッダのORDER_DISP_NOが未設定の場合、システムで自動採番します。指定した場合は指定した値が使用されます。
受注ヘッダのMEMBER_WARIBIKI_SUMは値を設定しても無視され、システムで計算された値が使用されます。
受注明細のTEIKA、ITEM_NAME、ITEMPROPERTY_LISTが未設定の場合、ITEM_ITEMPROPERTY_CDを元に取得した商品情報が使用されます。設定した場合はその値が優先されます。
なお、TEIKAに関する注意点として、ITEM_ITEMPROPERTY_CDでバリエーション付き商品コードを指定した場合、商品情報でバリエーションごとのTEIKAが設定されていないとチェックエラーとなります。
その為、必要に応じてTEIKAに適切な値を設定するようにしてください。
リクエストパラメータ "data_type" = "multi_update_full_order"の場合:
複数行の受注データ登録します。受注情報のリストを格納したJSON文字列、形式はGETと同一です。
ただし、send_data、metadataの指定はできません。また決済連携は行われません。
定期受注、頒布会受注の登録については非対応となっております。
受注ヘッダのMEMBER_WARIBIKI_SUMは値を設定しても無視され、システムで計算された値が使用されます。
受注明細のTEIKA、ITEM_NAME、ITEMPROPERTY_LISTが未設定の場合、ITEM_ITEMPROPERTY_CDを元に取得した商品情報が使用されます。設定した場合はその値が優先されます。
なお、TEIKAに関する注意点として、ITEM_ITEMPROPERTY_CDでバリエーション付き商品コードを指定した場合、商品情報でバリエーションごとのTEIKAが設定されていないとチェックエラーとなります。
その為、必要に応じてTEIKAに適切な値を設定するようにしてください。
re_authory_flg（trueを指定すると再オーソリを実行します。SBPSクレジット決済で購入した定期受注・クレジットカード（クロネコwebコレクト）に対応しています。更新対象が子受注の場合、親受注に登録されている取引ID・使用カード取引ID・・支払回数を元に再オーソリを実行します。execute_authorization_flgにはtrueを指定してください。）
リクエストパラメータ "data_type" = "update_by_query"の場合:
条件を指定して受注データを1件更新します。受注情報を格納したJSON文字列、形式はGETと同一です。
現在サポートしている対象プロパティは以下の通りです。サポート外のプロパティを設定することはできません。
  • ORDER_NO（必須）
  • PAYMENT_STATUS
  • YOYAKU_STATUS

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

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

DELETE

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

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

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

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

削除件数