API の基本ルール

2026-10-22 時点の公式のページと照合した内容です。

ネクストエンジン API を使う前に押さえておくルールのうち、公式のページに書かれていないものです。公式のページに書かれている仕様は、ここでは繰り返しません。先に次のページを読んでください。

検索について: 検索の入出力。fields は必須で、条件はすべて AND
パラメータ比較演算子: 演算子と、文字列型・数値型・日時型のどれに使えるか
パラメータ共通事項: result が error / redirect のときの扱い
メッセージコード: エラーコードと原因
受注伝票更新: 受注状態によって更新できない項目
受注状態区分情報取得・受注キャンセル区分情報取得: 区分コードの値

呼び出し方

通知の仕組み（webhook・イベント）はありません。

受注の取込や在庫の変化は、検索 API を定期的に呼んで見つけます。

検索の条件

OR は書けません。同じ項目と演算子の組は、1 回しか送れません。

条件は <項目名>-<演算子>=<値> の形の HTTP パラメータなので、同じキーを 2 回送れません。同じ項目で除外を重ねるなら、残す値を -in で並べます。演算子が違えば別のキーなので、-gte と -lte は併用できます。右辺は常に値として扱われます。項目同士を比べる条件（引当数 < 受注数など）は書けないので、2 つの項目を取得してから比べます。
区分コードは、数字に見えても文字列型です。範囲で絞るときは -in でコードを並べます。

receive_order_order_status_id などは文字列型なので、-lt / -lte / -gt / -gte を使うと 004002 で失敗します。
```
receive_order_order_status_id-in=0,1,2,20     … 正しい
receive_order_order_status_id-lte=20          … 004002
```
否定の演算子（-neq / -nin / -nlike）は、値が NULL のレコードを落とします。

「[処理済] タグが付いていない受注」を否定の演算子で取ると、タグが 1 つも無い受注まで消えます。文字列の項目で値が未設定のレコードも残すなら、-nlike の代わりに -nlikeornull を使います。-neq / -nin には NULL を残す演算子がないので、否定の条件を付けずに取得し、取得後に除きます。
```
receive_order_gruoping_tag-nlikeornull=%[処理済]%
```
存在しないコードで絞っても、エラーにならずに 0 件が返ります。

受注状態 receive_order_order_status_id に 10 はありません。商品区分 goods_type_id に 1 はありません。コードは区分情報の API で確かめてから使います。
キャンセルは、受注状態とは別の項目 receive_order_cancel_type_id で表します。有効な受注は 0 だけです。

キャンセルしても受注状態は変わりません。受注状態だけで「未出荷」を絞ると、キャンセル済みの受注が混ざります。「キャンセル以外」は -eq=0、「キャンセルだけ」は -neq=0 です（-eq=1 は、キャンセル区分が 1 の受注だけになります）。
```
receive_order_order_status_id-neq=50
receive_order_cancel_type_id-eq=0
```
モール（販売チャネル）を直接指定するパラメータはありません。

受注が持つのは店舗 receive_order_shop_id だけです。店舗マスタで対象モールの shop_id を集め、受注を receive_order_shop_id-in で絞ります。店舗がどのモールかは、店舗マスタの shop_mall_id で分かります。
```
POST /api_v1_master_shop/search          fields=shop_id,shop_name,shop_mall_id
POST /api_v1_receiveorder_base/search    receive_order_shop_id-in=3,7
```
受注ヘッダの検索で使った条件は、受注明細の検索には掛かりません。

受注ヘッダ（/api_v1_receiveorder_base）と受注明細（/api_v1_receiveorder_row）は別の検索 API です。ヘッダを先に検索して receive_order_id を集め、明細を receive_order_row_receive_order_id-in で絞ります。商品の情報（receive_order_row_goods_id など）は明細にしかありません。

返る値

数値の項目も、文字列で返ります（例: "10000.00"）。

値の無い項目は null で、日時の項目は "0000-00-00 00:00:00" で返ることがあります。"0000-00-00 00:00:00" は日時の比較（-lte など）にも当たります。