受注明細件数取得
リクエストURL
Section titled “リクエストURL”ホスト
https://api.next-engine.org
エンドポイント
/api_v1_receiveorder_row/count
リファレンス内容
Section titled “リファレンス内容”件数取得について
Section titled “件数取得について”入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります
検索条件を複数指定した場合、全ての条件がかつ(AND)となります
入力パラメータ
Section titled “入力パラメータ”| パラメータ | 値 | 省略 | 備考 |
|---|---|---|---|
access_token | access_token取得により取得した値 | 必須(SDKの場合不要) | |
refresh_token | access_token取得により取得した値 | 可能(SDKの場合不要) | 【指定してaccess_tokenの有効期限が切れた場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます 【省略してaccess_tokenの有効期限が切れた場合】 出力パラメータ「result」の値がredirectになります(成功時以外の出力パラメータ参照) |
wait_flag | 1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却 | 可能(省略時は1以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例:商品マスタ検索でパラメータ:goods_id-like、値:”%-red”と指定した場合、商品コードが*-redの商品マスタを検索します |
出力パラメータ
Section titled “出力パラメータ”| パラメータ名 | 値 | 備考 |
|---|---|---|
result | success | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
access_token | 入力パラメータで指定したaccess_token/新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります |
access_token_end_date | access_tokenの有効期限切れ日時 | |
refresh_token | 入力パラメータで指定したrefresh_token/新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります |
refresh_token_end_date | refresh_tokenの有効期限切れ日時 | |
count | 検索結果の件数 |
| 項目名 | フィールド名 | データ型 | 備考 |
|---|---|---|---|
| 伝票番号 | receive_order_row_receive_order_id | 数値型 | ネクストエンジン内で一意に付与される番号 |
| 受注番号 | receive_order_row_shop_cut_form_id | 文字列型 | 原則、店舗内で一意に付与される番号(重複する可能性あり。) |
| 明細行番号 | receive_order_row_no | 数値型 | ネクストエンジンで付与した明細行番号 |
| 受注明細行番号 | receive_order_row_shop_row_no | 文字列型 | 店舗で付与された明細行番号 |
| 商品コード | receive_order_row_goods_id | 文字列型 | |
| 商品名 | receive_order_row_goods_name | 文字列型 | |
| 受注数 | receive_order_row_quantity | 数値型 | |
| 単価 | receive_order_row_unit_price | 数値型 | |
| 受注時原価 | receive_order_row_received_time_first_cost | 数値型 | 受注時の商品マスタの原価。 |
| 消費税率(%) | receive_order_row_tax_rate | 数値型 | |
| 掛率 | receive_order_row_wholesale_retail_ratio | 数値型 | |
| 小計金額 | receive_order_row_sub_total_price | 数値型 | 単価*(掛率/10)*受注数 |
| 商品OP | receive_order_row_goods_option | 文字列型 | |
| キャンセルフラグ | receive_order_row_cancel_flag | 文字列型 | |
| 同梱元伝票番号 | receive_order_include_from_order_id | 数値型 | |
| 同梱元明細行番号 | receive_order_include_from_row_no | 数値型 | |
| 複数配送親伝票番号 | receive_order_row_multi_delivery_parent_order_id | 数値型 | |
| 分割元明細行番号 | receive_order_row_divide_from_row_no | 数値型 | |
| 複写元明細行番号 | receive_order_row_copy_from_row_no | 数値型 | |
| 引当数 | receive_order_row_stock_allocation_quantity | 数値型 | |
| 予約引当数 | receive_order_row_advance_order_stock_allocation_quantity | 数値型 | |
| 引当日 | receive_order_row_stock_allocation_date | 日時型 | |
| 受注時取扱区分 | receive_order_row_received_time_merchandise_id | 文字列型 | 受注時の商品マスタの値が設定されます。 |
| 受注時取扱名 | receive_order_row_received_time_merchandise_name | 文字列型 | |
| 受注時商品区分 | receive_order_row_received_time_goods_type_id | 文字列型 | 受注時の商品マスタの値が設定されます。 |
| 受注時商品名 | receive_order_row_received_time_goods_type_name | 文字列型 | |
| 良品返品数 | receive_order_row_returned_good_quantity | 数値型 | |
| 不良品返品数 | receive_order_row_returned_bad_quantity | 数値型 | |
| 返品事由区分 | receive_order_row_returned_reason_id | 文字列型 | |
| 返品事由名 | receive_order_row_returned_reason_name | 文字列型 | |
| 元受注明細行番号 | receive_order_row_org_row_no | 数値型 | |
| 削除フラグ | receive_order_row_deleted_flag | 文字列型 | 1:有効 1以外:無効 |
| 作成日 | receive_order_row_creation_date | 日時型 | |
| 最終更新日 | receive_order_row_last_modified_date | 日時型 | |
| 最終更新日 | receive_order_row_last_modified_null_safe_date | 日時型 | NULLの場合作成日 |
| 受注伝票・受注明細の最終更新日 | receive_order_row_last_modified_newest_date | 日時型 | 受注伝票と受注明細の内、より新しい方の最終更新日 |
| 作成担当者ID | receive_order_row_creator_id | 数値型 | |
| 作成担当者名 | receive_order_row_creator_name | 文字列型 | |
| 最終更新者ID | receive_order_row_last_modified_by_id | 数値型 | |
| 最終更新者ID | receive_order_row_last_modified_by_null_safe_id | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | receive_order_row_last_modified_by_name | 文字列型 | |
| 最終更新者名 | receive_order_row_last_modified_by_null_safe_name | 文字列型 | NULLの場合作成者名 |
| 項目名 | フィールド名 | データ型 | 備考 |
|---|---|---|---|
| 拠点ID | warehouse_id | 数値型 | ネクストエンジンで付与したユニークな拠点識別番号 |
| 拠点名 | warehouse_name | 文字列型 | |
| 作成日 | warehouse_creation_date | 日時型 | 拠点の作成日 |
| 最終更新日 | warehouse_last_modified_date | 日時型 | 拠点マスタの最終更新日 |
| 作成担当者ID | warehouse_creator_id | 数値型 | 拠点の作成担当者ID |
| 作成担当者名 | warehouse_creator_name | 文字列型 | 拠点の作成担当者名 |
| 最終更新者ID | warehouse_last_modified_by_id | 数値型 | 拠点マスタの最終更新者ID |
| 最終更新者名 | warehouse_last_modified_by_name | 文字列型 | 拠点マスタの最終更新者名 |
サンプル
リクエスト
curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_row_receive_order_id-eq=1' \ https://api.next-engine.org/api_v1_receiveorder_row/countレスポンス
{ "result": "success", "count": "3", "access_token": "xxx", "access_token_end_date": "2017-04-18 11:19:26", "refresh_token": "xxx", "refresh_token_end_date": "2017-04-20 11:19:26"}エラーコード
Section titled “エラーコード”エンドポイント固有のエラーコードはありません。 共通エラーコードは メッセージコード一覧 を参照してください。
- 構造化スキーマビュー:
/openapi/operations/api_v1_receiveorder_row_count/(OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧:
/guides/param/message/(result/code/messageの意味) - フィールド一覧:
/guides/fields/receiveorder_row/(このエンドポイントが扱うデータ項目)
同じカテゴリの他のエンドポイント (受注明細)
Section titled “同じカテゴリの他のエンドポイント (受注明細)”- 受注明細検索 —
POST /api_v1_receiveorder_row/search