受注伝票同梱候補グループ取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_receiveorder_base/bundle_candidate_groups

概要

同梱可能な受注伝票をグループ化して返す。各グループ内の受注伝票は互いに同梱可能。

target_receive_order_ids を省略すると、同梱可能なすべての受注伝票を対象とする。

同梱候補グループの判定条件

グループに含まれる受注伝票は以下の条件をすべて満たす必要がある：

同じ店舗
有効な伝票（キャンセルされていない）
受注状態が「起票済み」「納品書印刷待ち」「納品書印刷済」のいずれか
送り先名が同じ
送り先住所が同じ
送り先電話番号が同じ
送り先情報がマスク化されていない

必要なアクセス権限

受注情報取得

リファレンス内容

入力パラメータ

パラメータ	値	省略	備考
`access_token`	access_token取得により取得した値	必須(SDKの場合不要)
`refresh_token`	access_token取得により取得した値	可能(SDKの場合不要)
`wait_flag`	1:メイン機能過負荷でも可能な限りエラーにせず実行 1以外:メイン機能過負荷の場合、003002のエラーを返却	可能(省略時は1以外とする)	詳細はパラメータ共通事項「待機フラグについて」を参照して下さい
`target_receive_order_ids`	同梱候補を絞り込む受注伝票番号（カンマ区切り）	可能	省略時は全受注を対象。数値のみ有効。非数値が含まれるとエラー

出力フィールド

項目名	フィールド名	データ型	備考
処理結果	`result`	string	成功時は `"success"`
同梱候補グループ一覧	`groups`	配列の配列（integer）	各要素は1グループ内の受注伝票番号の配列。グループ内は受注伝票番号の降順、グループ自体も各グループ最大番号の降順で返る。空のグループは返らない
アクセストークン	`access_token`	string
アクセストークン有効期限	`access_token_end_date`	string
リフレッシュトークン	`refresh_token`	string
リフレッシュトークン有効期限	`refresh_token_end_date`	string

リクエスト例

curl -X POST 'https://api.next-engine.org/api_v1_receiveorder_base/bundle_candidate_groups' \
  -d 'access_token=XXXX' \
  -d 'target_receive_order_ids=72057,72056,72055'

target_receive_order_ids を省略すると同梱可能な全受注を対象にする。

レスポンス例（成功）

{
  "result": "success",
  "groups": [
    [72057, 72056],
    [72055, 72054, 72053]
  ],
  "access_token": "XXXX",
  "access_token_end_date": "2026-04-01 18:00:00",
  "refresh_token": "XXXX",
  "refresh_token_end_date": "2026-04-08 18:00:00"
}

同梱可能な受注伝票が存在しない場合:

{
  "result": "success",
  "groups": [],
  "access_token": "XXXX",
  "access_token_end_date": "2026-04-01 18:00:00",
  "refresh_token": "XXXX",
  "refresh_token_end_date": "2026-04-08 18:00:00"
}

レスポンス例（エラー：非数値の受注伝票番号指定）

{
  "result": "error",
  "code": "004002",
  "message": "target_receive_order_ids は数値の ID をカンマ区切りで指定してください。",
  "access_token": "XXXX",
  "access_token_end_date": "2026-04-01 18:00:00",
  "refresh_token": "XXXX",
  "refresh_token_end_date": "2026-04-08 18:00:00"
}

エラーコード

このエンドポイントで返却されるエラーコードを以下に示す。共通エラーコードについてはメッセージコード一覧を参照。

コード	メッセージ	リカバリ
`029001`	receive_order_ids は 10000 件以内で指定してください。	×
`029002`	receive_order_ids は半角数字のみをカンマ区切りで指定してください。	×
`029003`	同梱可能グループ検索エラー	×

受注伝票 同梱候補グループ取得