# 受注伝票 — ネクストエンジン API

> 受注伝票 カテゴリの API endpoint (12 件) を集約したファイル。
> インデックス: https://developer.next-engine.com/llms.txt | 全文: https://developer.next-engine.com/llms-full.txt

---

# 受注伝票 同梱候補グループ取得
URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/bundle_candidate_groups/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/bundle_candidate_groups
Tag: 受注伝票
Required parameters: access_token
Optional parameters: refresh_token, wait_flag, fields, offset, limit

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_receiveorder_base/bundle_candidate_groups`

## 概要

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

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

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

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

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

## 必要なアクセス権限

受注情報取得

## リファレンス内容

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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 | |

#### リクエスト例

```bash
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` を省略すると同梱可能な全受注を対象にする。

#### レスポンス例（成功）

```json
{
  "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"
}
```

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

```json
{
  "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"
}
```

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

```json
{
  "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"
}
```

### エラーコード

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

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

---

# 受注伝票アップロード
URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/upload/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/upload
Tag: 受注伝票
Required parameters: access_token, receive_order_upload_pattern_id, data_type_1, data_type_2, data_1, data_2
Optional parameters: refresh_token, wait_flag, fields, offset, limit

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_receiveorder_base/upload`

## リファレンス内容


### 受注一括登録

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。

動作は受注一括登録と同じですが、必ず非同期でメイン機能に登録可能になった時に登録されます。

登録結果は、[アップロードキュー](/api/api_v1_system_que/search)を検索して確認します。

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| `receive_order_upload_pattern_id` | 登録対象の受注一括登録パターンID | 必須 | |
| `data_type_1` | data_1のファイル種類 | 必須 | csv:受注CSV,gz:受注CSVをGZIPで圧縮 |
| `data_type_2` | data_2のファイル種類 | 受注一括登録パターンがYahooの場合のみ必須(それ以外は無視) | csv:受注CSV,gz:受注CSVをGZIPで圧縮 |
| `data_1` | 受注CSVのファイル内容 | 必須 | メイン機能の受注一括登録で使用する受注CSVと同じ（注意：受注一括登録パターンによって内容が異なります）。 |
| `data_2` | 受注CSVのファイル内容 | 受注一括登録パターンがYahooの場合のみ必須(それ以外は無視) | メイン機能の受注一括登録で使用する受注CSVと同じ（注意：受注一括登録パターンによって内容が異なります）。 |

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
| `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります |
| `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります |
| `que_id` | 登録したアップロードキューのID | このIDを用いてアップロードキューを検索して処理状態(que_status_id)・処理メッセージ(que_message)を確認することが出来ます。 |


 サンプル
### サンプル

リクエスト

```bash
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d
'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_upload_pattern_id=2&data_type_1=csv&data_1=店舗伝票番号,受注日,受注郵便番号,受注住所１,受注住所２,受注名,受注名カナ,受注電話番号,受注メールアドレス,発送郵便番号,発送先住所１,発送先住所２,発送先名,発送先カナ,発送電話番号,支払方法,発送方法,商品計,税金,発送料,手数料,ポイント,その他費用,合計金額,ギフトフラグ,時間帯指定,日付指定,作業者欄,備考,商品名,商品コード,商品価格,受注数量,商品オプション,出荷済フラグ,顧客区分,顧客コード,消費税率（%）,のし,ラッピング,メッセージ
test1,2019/03/02 10:00:00,2500011,神奈川県小田原市栄町,xxx番地,山田太郎,ヤマダタロウ,09011112222,xxx@xxx.xxx,9900845,山形県山形市飯塚町,xxx番地,山田花子,ヤマダハナコ,09011112222,代金引換,宅急便,2400,240,350,200,0,0,3190,0,時間帯指定[午前中],2019/03/15,,よろしくお願いします！,メンズTシャツ：(Lサイズ)ブラック,test-xxx,2400,1,,,,,,,,
test2,2019/03/10 10:00:00,2500003,神奈川県小田原市東町,xxx番地,山田太郎,ヤマダタロウ,09011112222,xxx@xxx.xxx,2500003,神奈川県小田原市東町,xxx番地,山田太郎,ヤマダタロウ,09011112222,コンビニ,メール便,3000,300,350,0,0,0,3650,0,時間帯指定[13時-14時],,,ポスト投函でお願いします。,レディースTシャツ：（Mサイズ）レッド,test-099,1000,1,,,,,,,,
test2,2019/03/10 10:00:00,2500003,神奈川県小田原市東町,xxx番地,山田太郎,ヤマダタロウ,09011112222,xxx@xxx.xxx,2500003,神奈川県小田原市東町,xxx番地,山田太郎,ヤマダタロウ,09011112222,コンビニ,メール便,3000,300,350,0,0,0,3650,0,時間帯指定[13時-14時],,,ポスト投函でお願いします。,レディースTシャツ：（Mサイズ）ピンク,test-101,500,2,,,,,,,,' https://api.next-engine.org/api_v1_receiveorder_base/upload
```

レスポンス

```json
{
  "result": "success",
  "que_id": "45",
  "access_token": "xxxxx",
  "access_token_end_date": "2022-09-27 18:45:17",
  "refresh_token": "xxxxx",
  "refresh_token_end_date": "2022-09-29 18:45:17"
}
```


## エラー

### エラーコード

エンドポイント固有のエラーコードを以下に示します。
共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。

| エラーコード | メッセージ | 対処方法 |
|---|---|---|
| `006001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります |
| `006002` | POSTパラメータに_xxxxx_が指定されていません。 | データ種類の指定をしてください |
| `006003` | _xxxxx_のデータ種類[_xxx_]が不正です。 | データ種類を正しい値に修正してください |
| `006004` | POSTパラメータに_xxxxx_が指定されていません。 | データの指定をしてください |
| `006005` | _xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_ | データの内容を正しい形式に修正してください |
| `006006` | POSTパラメータにreceive_order_upload_pattern_idが指定されていません。 | receive_order_upload_pattern_idを指定してください |
| `006007` | 存在しない受注一括登録パターン[_xxxxxxxxxxxxxxxxx_]です。 | receive_order_upload_pattern_idを正しい値に修正してください |
| `006008` | POSTパラメータにdata_type_2を指定する場合は、data_2も指定して下さい。 | data_2を指定してください |
| `006009` | POSTパラメータにdata_2を指定する場合は、data_type_2も指定して下さい。 | data_type_2を指定してください |
| `006010` | 指定されたファイルは存在していません | アップロードしたファイルを確認してください。保存期間は3日です |

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_base_upload/`](/openapi/operations/api_v1_receiveorder_base_upload/) (OpenAPI 3.1 のインタラクティブ仕様)
- エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味)
- フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目)

### 同じカテゴリの他のエンドポイント (受注伝票)

- [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate`
- [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted`
- [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count`
- [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide`
- [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted`
- [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted`
- [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search`
- [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped`
- [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update`

---

# 受注伝票一括更新
URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdate/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/bulkupdate
Tag: 受注伝票
Required parameters: access_token, data_type, data
Optional parameters: refresh_token, wait_flag, fields, offset, limit, receive_order_shipped_update_flag, receive_order_row_cancel_update_flag, receive_order_recalculate_flag

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_receiveorder_base/bulkupdate`

## リファレンス内容


### 受注伝票一括更新について

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。

受注伝票の項目をパラメータで指定した値で一括更新します。

処理結果はレスポンスのステータスコードで確認します。

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| `data_type` | dataのファイル種類 | 必須 | xml:更新データXML, gz:更新データをgzipで圧縮 |
| `data` | 更新するデータ | 必須 | XML形式もしくはXMLファイルをgzipで圧縮したgz形式で指定します [形式はこちら](#xml形式)を参照 |
| `receive_order_shipped_update_flag` | 1:受注状態が「出荷確定済（完了）」でも更新可 1以外:受注状態が「出荷確定済（完了）」は更新不可 | 可能(省略時は1以外とする) | |
| `receive_order_row_cancel_update_flag` | 1:受注伝票の受注キャンセル区分を0（有効）に変更したときに明細行のキャンセルフラグを有効にする 1以外:受注キャンセル区分を0（有効）に変更しても明細行のキャンセルフラグに影響なし | 可能(省略時は1以外とする) | このフラグが有効になるのは受注伝票がキャンセルから有効に変更されるときのみとなります。 |
| `receive_order_recalculate_flag` | 1:受注伝票の金額系項目の再計算を有効にする 1以外:再計算を行わない | 可能(省略時は1以外とする) | 受注明細項目である小計金額は再計算の対象にならないためご注意ください 金額系項目とは、受注伝票項目である商品計、税金、総合計の3項目（インボイス対応店舗の受注の場合は、手数料、他費用、ポイント数、請求金額（0%）、請求金額（8%）、請求金額（10%）、請求額に対する税額（8%）、請求額に対する税額（10%）を加えた11項目）を指します |

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
| `message` | 一括更新処理の状態を表すメッセージ | 更新が成功している場合は空になります 更新が失敗した場合は失敗した各伝票ごとにreceive_order_id, code, messageが返ります。 詳細はサンプルをご覧ください。 |
| `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の有効期限切れ日時 | |

### XML形式

入力パラメータのdataで指定する値です 

 完成サンプルはこちらを参照

| 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 |
| --- | --- | --- | --- | --- | --- |
| 1 | <root> | ○ | | | |
| 2 | <receiveorder> | ○ | ○ | receive_order_id receive_order_last_modified_date | 受注伝票番号と最終更新日を指定します。 更新する受注伝票が複数ある場合はその分、要素を繰り返します |
| 3 | <receiveorder_base> | | | | 受注伝票の項目を指定する要素 更新する受注伝票のフィールド名と値を指定します |
| 4 | <receive_order_date> | | | | |
| 4 | <receive_order_shop_cut_form_id> | | | | |
| 3 | </receiveorder_base> | | | | |
| 3 | <receiveorder_option> | | | | 受注伝票オプションの項目を指定する要素 更新する受注伝票オプションのフィールド名と値を指定します |
| 4 | <receive_order_option_single_word_memo> | | | | |
| 4 | <receive_order_option_5> | | | | |
| 3 | </receiveorder_option> | | | | |
| 3 | <receiveorder_row> | | | | 受注明細の項目を指定する要素 |
| 4 | <receive_order_row_no> | | ○ | `value` | 属性に更新対象の明細行を指定します 更新する明細行が複数ある場合はその分、要素を繰り返します |
| 5 | <receive_order_row_goods_name> | | | | 更新する受注明細のフィールド名と値を指定します |
| 5 | <receive_order_row_cancel_flag> | | | | |
| 4 | <\receive_order_row_no> | | ○ | | |
| 3 | <\receiveorder_row> | | | | |
| 2 | </receiveorder> | ○ | ○ | | |
| 1 | </root> | ○ | | | |

XML完成サンプル1（受注伝票の更新）

```xml
<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder receive_order_id="1" receive_order_last_modified_date="2018-04-13 10:38:28">
 <receiveorder_base>
 <receive_order_shop_cut_form_id>12345-6789</receive_order_shop_cut_form_id>
 <receive_order_date>2014-05-01 00:00:00</receive_order_date>
 </receiveorder_base>
 </receiveorder>
</root>
```

XML完成サンプル2（複数の受注伝票の更新）

```xml
<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder receive_order_id="1" receive_order_last_modified_date="2018-04-13 10:38:28">
 <receiveorder_base>
 <receive_order_shop_cut_form_id>12345-6789</receive_order_shop_cut_form_id>
 <receive_order_date>2014-05-01 00:00:00</receive_order_date>
 </receiveorder_base>
 </receiveorder>
 <receiveorder receive_order_id="2" receive_order_last_modified_date="2018-04-13 10:38:28">
 <receiveorder_base>
 <receive_order_shop_cut_form_id>12346-8879</receive_order_shop_cut_form_id>
 <receive_order_date>2014-06-02 00:00:00</receive_order_date>
 </receiveorder_base>
 </receiveorder>
</root>
```

XML完成サンプル3（受注伝票の更新、オプション項目を含む）

```xml
<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder receive_order_id="1" receive_order_last_modified_date="2018-04-13 10:38:28">
 <receiveorder_base>
 <receive_order_shop_cut_form_id>12345-6789</receive_order_shop_cut_form_id>
 <receive_order_date>2014-05-01 00:00:00</receive_order_date>
 </receiveorder_base>
 <receiveorder_option>
 <receive_order_option_single_word_memo>xxx</receive_order_option_single_word_memo>
 </receiveorder_option>
 </receiveorder>
</root>
```

XML完成サンプル4（複数の受注伝票と明細の更新）

```xml
<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder receive_order_id="1" receive_order_last_modified_date="2018-04-13 10:38:28">
 <receiveorder_base>
 <receive_order_shop_cut_form_id>12345-6789</receive_order_shop_cut_form_id>
 <receive_order_date>2014-05-01 00:00:00</receive_order_date>
 </receiveorder_base>
 <receiveorder_row>
 <receive_order_row_no value="1">
 <receive_order_row_goods_name>テスト商品1</receive_order_row_goods_name>
 <receive_order_row_cancel_flag>1</receive_order_row_cancel_flag>
 </receive_order_row_no>
 <receive_order_row_no value="2">
 <receive_order_row_goods_name>テスト商品2</receive_order_row_goods_name>
 </receive_order_row_no>
 <receive_order_row_no value="3">
 <receive_order_row_quantity>3</receive_order_row_quantity>
 </receive_order_row_no>
 </receiveorder_row>
 </receiveorder>
 <receiveorder receive_order_id="2" receive_order_last_modified_date="2018-04-13 10:38:28">
 <receiveorder_base>
 <receive_order_shop_cut_form_id>12346-8879</receive_order_shop_cut_form_id>
 <receive_order_date>2014-06-02 00:00:00</receive_order_date>
 </receiveorder_base>
 </receiveorder>
</root>
```

### 更新仕様

 更新内容の詳細は[受注伝票受注伝票更新ページ](/api/api_v1_receiveorder_base/update)を参照してください 


### サンプル

リクエスト

```bash
curl -X POST -d 'access_token=xxx&refresh_token=xxx&data_type=xxx&data=xxx&receive_order_shipped_update_flag=1' "https://api.next-engine.org/api_v1_receiveorder_base/bulkupdate"
```

更新成功レスポンス

```json
{
 "result": "success",
 "message": "",
 "access_token":"xxxxxxxx",
 "refresh_token":"xxxxxxxx",
 "access_token_end_date":"2017-04-15 18:24:53"
 "refresh_token_end_date":"2017-04-15 18:24:53"
}
```

更新失敗レスポンス

```json
{
 "result": "error",
 "message": [
 {
 "receive_order_id": "7",
 "code": "020006",
 "message": "receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。",
 },
 {
 "receive_order_id": "8",
 "code": "020015",
 "message": "[receive_order_date]日付の形式ではありません。"
 }
 ],
 "access_token":"xxxxxxxx",
 "refresh_token":"xxxxxxxx",
 "access_token_end_date":"2017-04-15 18:24:53"
 "refresh_token_end_date":"2017-04-15 18:24:53"
}
```


## エラー

### エラーコード

エンドポイント固有のエラーコードを以下に示します。
共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。

| エラーコード | メッセージ | 対処方法 |
|---|---|---|
| `020001` | アクセス情報[xxxxxx]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります |
| `020002` | receiveorderタグにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください |
| `020003` | POSTパラメータにdataが指定されていない、または値が空です。 | dataを指定してください |
| `020004` | dataの値を解析できませんでした。正しい形式で指定して下さい。 | dataの形式を修正してください |
| `020005` | receiveorderタグにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください |
| `020006` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください |
| `020007` | 受注取込中のため、更新出来ません。 | 受注伝票を再検索してAPIを実行してください |
| `020008` | 受注伝票[xxxxxx]は存在しません。 | receive_order_idを確認してください |
| `020009` | [xxxxxx]は受注状態が受注メール取込済の伝票は更新できません。 | 該当項目は受注メール取込済伝票では更新不可です |
| `020010` | 受注状態が出荷確定済の伝票は更新できません。 | 出荷確定済伝票は更新できません |
| `020011` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください |
| `020014` | 更新フィールドが1つも設定されておりません。 | 更新するフィールドを設定してください |
| `020015` | [xxxx]xxxxxxxxxx | フィールド名xxxx についてエラー内容を確認してください |
| `020016` | 明細行xx[xxxx]xxxxxxxxxx | 明細行xx のフィールド名xxxx についてエラーを確認してください |
| `020017` | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | 受注明細追加の条件を確認してください |
| `020018` | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | 受注伝票と明細の更新条件を確認してください |
| `020019` | xxxx[xx]は、メイン機能に登録されていない値です。 | フィールド名xxxx の値xx を確認してください |
| `020021` | 一度に1000件より多くの受注伝票を更新出来ません。1000件以内にして再度実行して下さい。 | 1000件以内に分割してください |
| `020022` | 更新対象が１つも指定されていません。 | 更新対象を指定してください |
| `020023` | POSTパラメータにdata_typeが指定されていない、または値が空です。 | data_typeを指定してください |
| `020024` | data_typeの値を正しい形式で指定して下さい。 | data_typeを正しい形式で指定してください |
| `020025` | data_type[xxx]とdataの形式が一致しません。正しい形式で指定してください。 | data_typeとdataの形式を合わせてください |
| `020030` | 所属拠点が異なる店舗に変更することはできません。 | 異なる拠点の店舗への変更はできません。複写後キャンセル処理を実施してください |
| `020500` | xxxxxxx | 更新に失敗した伝票を確認してください |
| `020999` | 更新処理中に例外が発生したため、処理を行いませんでした。 | 処理エラーを確認して対応してください |

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_base_bulkupdate/`](/openapi/operations/api_v1_receiveorder_base_bulkupdate/) (OpenAPI 3.1 のインタラクティブ仕様)
- エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味)
- フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目)

### 同じカテゴリの他のエンドポイント (受注伝票)

- [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted`
- [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count`
- [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide`
- [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted`
- [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted`
- [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search`
- [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped`
- [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update`
- [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload`

---

# 受注伝票一括同梱
URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/bundle/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/bundle
Tag: 受注伝票
Required parameters: access_token
Optional parameters: refresh_token, wait_flag, fields, offset, limit

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_receiveorder_base/bundle`

## 概要

受注伝票の同梱（複数伝票を1配送にまとめる）を実行する。複数の同梱ジョブを1リクエストで一括処理できる。

同梱先ごとに「どの受注伝票をまとめるか」を指定する。楽観ロック（最終更新日一致）により、他操作との競合を防ぐ。

事前に `bundle_candidate_groups` で同梱可能グループを確認してから実行することを推奨する。

## 必要なアクセス権限

受注情報更新

## リファレンス内容

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `access_token` | access_token取得により取得した値 | 必須(SDKの場合不要) | |
| `refresh_token` | access_token取得により取得した値 | 可能(SDKの場合不要) | |
| `wait_flag` | 1:メイン機能過負荷でも可能な限りエラーにせず実行 1以外:メイン機能過負荷の場合、003002のエラーを返却 | 可能(省略時は1以外とする) | 詳細は パラメータ共通事項「待機フラグについて」を参照して下さい |
| `data` | 同梱ジョブの配列（JSON文字列） | 必須 | 下記「`data` の構造」参照 |
| `receive_order_recalculate_flag` | 再計算フラグ | 可能 | `"1"`（再計算する）または `"0"`。省略時は `"1"` |

#### `data` の構造

`data` は JSON 文字列にエンコードされた配列。各要素が1同梱ジョブ（同梱先1件 + 同梱元N件）を表す。

```json
[
  {
    "receive_order_id": "同梱先の受注伝票番号（文字列）",
    "receive_order_last_modified_date": "同梱先の最終更新日時 (YYYY-MM-DD HH:MM:SS)",
    "bundles": [
      {
        "receive_order_id": "同梱元の受注伝票番号（文字列）",
        "receive_order_last_modified_date": "同梱元の最終更新日時 (YYYY-MM-DD HH:MM:SS)"
      }
    ]
  }
]
```

`receive_order_last_modified_date` は楽観ロック用。DB の最終更新日と一致しない受注伝票はスキップされる。

`data` 配列の要素数は **1〜100 件**。

### 出力フィールド

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 処理結果 | `result` | string | 成功時は `"success"` |
| メッセージ | `message` | string | |
| ジョブ結果一覧 | `results` | 配列 | 各ジョブの処理結果。下記参照 |
| アクセストークン | `access_token` | string | |
| アクセストークン有効期限 | `access_token_end_date` | string | |
| リフレッシュトークン | `refresh_token` | string | |
| リフレッシュトークン有効期限 | `refresh_token_end_date` | string | |

#### `results` の各要素

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 同梱先の受注伝票番号 | `receive_order_id` | integer | |
| 同梱成功した受注伝票番号 | `bundled_receive_order_ids` | integer[] | 同梱元として処理された受注伝票番号の配列 |
| スキップされた受注伝票番号 | `skipped_receive_order_ids` | integer[] | 楽観ロック不一致などでスキップされた番号の配列 |
| スキップ理由 | `skipped_receive_order_reasons` | 配列 | スキップされた受注ごとの理由。下記参照 |

#### `skipped_receive_order_reasons` の各要素

| フィールド名 | データ型 | 備考 |
| --- | --- | --- |
| `receive_order_id` | integer | スキップされた受注伝票番号 |
| `reason_message` | string | スキップ理由のメッセージ |

#### リクエスト例

```bash
curl -X POST 'https://api.next-engine.org/api_v1_receiveorder_base/bundle' \
  -d 'access_token=XXXX' \
  -d 'wait_flag=1' \
  -d 'receive_order_recalculate_flag=1' \
  --data-urlencode 'data=[{"receive_order_id":"72057","receive_order_last_modified_date":"2026-04-01 17:46:04","bundles":[{"receive_order_id":"72056","receive_order_last_modified_date":"2026-04-01 17:46:04"}]}]'
```

`data` パラメータは JSON 文字列なので `--data-urlencode` でエンコードする。

#### レスポンス例（全件成功）

```json
{
  "result": "success",
  "results": [
    {
      "receive_order_id": 72057,
      "bundled_receive_order_ids": [72056],
      "skipped_receive_order_ids": [],
      "skipped_receive_order_reasons": []
    }
  ],
  "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"
}
```

#### レスポンス例（エラー：全同梱元の楽観ロック不一致）

同梱元がすべてスキップ対象になった場合はレスポンスではなくエラーになる（コード `028013`）。

```json
{
  "result": "error",
  "code": "028013",
  "message": "同梱元のreceive_order_last_modified_dateがDBの最終更新日と一致する伝票が1件もありません。",
  "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"
}
```

#### レスポンス例（一部スキップ）

```json
{
  "result": "success",
  "results": [
    {
      "receive_order_id": 72057,
      "bundled_receive_order_ids": [72056],
      "skipped_receive_order_ids": [72055],
      "skipped_receive_order_reasons": [
        {
          "receive_order_id": 72055,
          "reason_message": "同梱元のreceive_order_last_modified_dateがDBの最終更新日と一致しません。"
        }
      ]
    }
  ],
  "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"
}
```

### エラーコード

このエンドポイント固有のエラーコードを以下に示す。共通エラーコードについては[メッセージコード一覧](/api/param/message/)を参照。

| コード | メッセージ | リカバリ |
| --- | --- | --- |
| `028001` | 同梱先の受注伝票が存在しません。receive_order_id=を確認してください。 | × |
| `028002` | 同梱元のreceive_order_idが指定されていません。 | × |
| `028003` | 指定した同梱元の受注伝票がすべて存在しません。 | × |
| `028004` | POSTパラメータにdataが指定されていない、または値が空です。 | × |
| `028005` | ジョブまたはbundles要素に必須フィールドが指定されていません。 | × |
| `028006` | receive_order_idは数字のみで指定してください。 | × |
| `028007` | dataのreceive_order_last_modified_dateはYYYY-MM-DD HH:MM:SS形式で指定してください。 | × |
| `028008` | 同梱元のreceive_order_idに同梱先と同じ値が指定されています。 | × |
| `028009` | 同一ジョブ内で同梱元のreceive_order_idが重複しています。 | × |
| `028010` | 発注計算バッチ実行中のため、処理を実行できません。 | ○ |
| `028011` | 棚卸中のため、処理を実行できません。 | ○ |
| `028012` | 同梱先の受注伝票が同梱条件を満たしていません。 | × |
| `028013` | 同梱元のreceive_order_last_modified_dateがDBの最終更新日と一致する伝票が1件もありません。 | × |
| `028014` | 同梱先のreceive_order_last_modified_dateがDBの最終更新日と一致しません。 | × |
| `028015` | 同梱先・同梱元の組み合わせが同梱条件を満たしていません。 | × |
| `028016` | 引当バッチ実行中のため、処理を実行できません。 | ○ |
| `028017` | dataの値をJSONとして解析できませんでした。 | × |
| `028018` | dataにはJSON配列を指定してください。 | × |
| `028019` | 同梱先ジョブ数が上限（100件）を超えています。 | × |
| `028020` | 一括同梱の一部または全ジョブが失敗した場合に表示されます。 | × |
| `028021` | 同梱処理中に例外が発生したため、処理を行いませんでした。 | × |

---

# 受注伝票件数取得
URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/count/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/count
Tag: 受注伝票
Required parameters: access_token
Optional parameters: refresh_token, wait_flag, fields, offset, limit, extension_execution_id

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_receiveorder_base/count`

## リファレンス内容


### 件数取得について

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります

検索条件を複数指定した場合、全ての条件がかつ(AND)となります

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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の商品マスタを検索します |
| `extension_execution_id` | 拡張機能実行ID | 可能 | 検索結果画面で実行対象として選択したデータをひとかたまりとして取得することができます。 フィールド名-比較演算子(WHERE句のカラムと比較演算子相当)と同時に指定した場合はAND検索となります。 |

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `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_shop_id` | 数値型 | 店舗マスタの店舗コード |
| 伝票番号 | `receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 |
| 受注番号 | `receive_order_shop_cut_form_id` | 文字列型 | 原則、店舗内で一意に付与される番号（重複する可能性あり。） |
| 受注日 | `receive_order_date` | 日時型 | 店舗側で受注した日 |
| 取込日 | `receive_order_import_date` | 日時型 | ネクストエンジンに取り込まれた日 |
| 重要チェック区分 | `receive_order_important_check_id` | 文字列型 | 1:重要 |
| 重要チェック名 | `receive_order_important_check_name` | 文字列型 | 重要チェックを付けた担当者名 |
| 確認チェック区分 | `receive_order_confirm_check_id` | 文字列型 | 0:確認不要1:確認必要2:確認済み |
| 確認チェック名 | `receive_order_confirm_check_name` | 文字列型 | 確認チェックを付けた担当者名 |
| 受注確認内容ID | `receive_order_confirm_ids` | 文字列型 | 受注確認内容IDが":"区切りで設定されます。明細行に対する確認は"#"の後に明細行番号が設定されます。Ex: "AO:AA#1:AA#2"の場合送り先の郵便番号と住所があってません。商品コードが商品マスタに存在しません。：1行目商品コードが商品マスタに存在しません。：2行目 |
| メール送信状態値 | `receive_order_mail_status` | 文字列型 | 次の値によりどの種類のメール送信が終了したかを表します。区切り文字はありません。例えばJHとあれば受注メールと発送完了メールが送信済みです。 J:受注確認メール B:印刷日待ち連絡メール C:印刷待ち以降連絡メール H:発送メール N:入金確認メール F:フォローメール |
| 受注分類タグ | `receive_order_gruoping_tag` | 文字列型 | []区切りでタグの名称が設定されている。受注分類タグ自体の検索には未対応。例:[連絡待ち][ゴールド会員] |
| 取込種類区分 | `receive_order_import_type_id` | 文字列型 | 0:メール1:CSV2:手入力 |
| 取込種類名 | `receive_order_import_type_name` | 文字列型 | |
| 受注キャンセル区分 | `receive_order_cancel_type_id` | 文字列型 | 受注キャンセル区分 |
| 受注キャンセル名 | `receive_order_cancel_type_name` | 文字列型 | |
| 受注キャンセル日 | `receive_order_cancel_date` | 日時型 | |
| 受注状態区分 | `receive_order_order_status_id` | 文字列型 | 受注状態区分 |
| 受注状態名 | `receive_order_order_status_name` | 文字列型 | |
| 発送方法区分 | `receive_order_delivery_id` | 文字列型 | 発送方法区分 |
| 発送方法名 | `receive_order_delivery_name` | 文字列型 | |
| 支払区分 | `receive_order_payment_method_id` | 文字列型 | 支払区分受注伝票の支払方法の値 |
| 支払名 | `receive_order_payment_method_name` | 文字列型 | |
| 総合計 | `receive_order_total_amount` | 数値型 | 商品計+税金+手数料+発送代+他費用-ポイント数 |
| 税金 | `receive_order_tax_amount` | 数値型 | |
| 手数料 | `receive_order_charge_amount` | 数値型 | |
| 発送代 | `receive_order_delivery_fee_amount` | 数値型 | |
| 他費用 | `receive_order_other_amount` | 数値型 | |
| ポイント数 | `receive_order_point_amount` | 数値型 | |
| 商品計 | `receive_order_goods_amount` | 数値型 | |
| 入金額 | `receive_order_deposit_amount` | 文字列型 | |
| 入金状況区分 | `receive_order_deposit_type_id` | 文字列型 | 入金区分 |
| 入金状況名 | `receive_order_deposit_type_name` | 文字列型 | |
| 入金日 | `receive_order_deposit_date` | 日時型 | |
| 備考 | `receive_order_note` | 文字列型 | |
| 同梱候補伝票番号 | `receive_order_include_possible_order_id` | 数値型 | ネクストエンジンが自動判定した同梱候補の伝票番号 |
| 同梱先伝票番号 | `receive_order_include_to_order_id` | 数値型 | 同梱した場合の同梱先の伝票番号 |
| 複数配送親伝票番号 | `receive_order_multi_delivery_parent_order_id` | 数値型 | 複数配送の親の伝票番号 |
| 分割元伝票番号 | `receive_order_divide_from_order_id` | 数値型 | 分割元の伝票番号 |
| 複写元伝票番号 | `receive_order_copy_from_order_id` | 数値型 | 複写元の伝票番号 |
| 複数配送親フラグ | `receive_order_multi_delivery_parent_flag` | 文字列型 | 複数配送の親か否か |
| 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 日時型 | |
| 納品書発行日 | `receive_order_statement_delivery_printing_date` | 日時型 | 納品書をダウンロードした日 |
| 納品書特記事項 | `receive_order_statement_delivery_text` | 文字列型 | |
| 出荷確定日 | `receive_order_send_date` | 日時型 | 受注状態が出荷確定済みになった日 |
| 出荷予定日 | `receive_order_send_plan_date` | 日時型 | |
| 出荷順序 | `receive_order_send_sequence` | 文字列型 | ラベル発行フラグがたった順序 |
| 作業用欄 | `receive_order_worker_text` | 文字列型 | |
| ピッキング指示内容 | `receive_order_picking_instruct` | 文字列型 | |
| ラベル発行日 | `receive_order_label_print_date` | 日時型 | |
| ラベル発行フラグ | `receive_order_label_print_flag` | 文字列型 | 配送伝票の印刷対象か否か0:対象外1:対象2:発行済み |
| 配達希望日 | `receive_order_hope_delivery_date` | 日時型 | |
| 配達希望時間帯区分 | `receive_order_hope_delivery_time_slot_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 配達希望時間帯名 | `receive_order_hope_delivery_time_slot_name` | 文字列型 | |
| 便種区分 | `receive_order_delivery_method_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 便種名 | `receive_order_delivery_method_name` | 文字列型 | |
| シール1区分 | `receive_order_seal1_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール1名 | `receive_order_seal1_name` | 文字列型 | |
| シール2区分 | `receive_order_seal2_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール2名 | `receive_order_seal2_name` | 文字列型 | |
| シール3区分 | `receive_order_seal3_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール3名 | `receive_order_seal3_name` | 文字列型 | |
| シール4区分 | `receive_order_seal4_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール4名 | `receive_order_seal4_name` | 文字列型 | |
| 営業止め区分 | `receive_order_business_office_stop_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 営業止め名 | `receive_order_business_office_stop_name` | 文字列型 | |
| 送り状区分 | `receive_order_invoice_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 送り状名 | `receive_order_invoice_name` | 文字列型 | |
| 温度区分 | `receive_order_temperature_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 温度名 | `receive_order_temperature_name` | 文字列型 | |
| 営業所名 | `receive_order_business_office_name` | 文字列型 | |
| ギフトフラグ | `receive_order_gift_flag` | 文字列型 | 0:ギフトではない1:ギフト |
| 発送伝票番号 | `receive_order_delivery_cut_form_id` | 文字列型 | 各発送方法の問い合わせ番号が設定されます。 |
| 発送伝票備考欄 | `receive_order_delivery_cut_form_note` | 文字列型 | |
| クレジット区分 | `receive_order_credit_type_id` | 文字列型 | クレジット種類区分 |
| クレジット名 | `receive_order_credit_type_name` | 文字列型 | |
| クレジット承認番号 | `receive_order_credit_approval_no` | 文字列型 | |
| クレジット承認額 | `receive_order_credit_approval_amount` | 文字列型 | |
| クレジット承認区分 | `receive_order_credit_approval_type_id` | 文字列型 | クレジット承認区分 |
| クレジット承認名 | `receive_order_credit_approval_type_name` | 文字列型 | |
| クレジット承認日 | `receive_order_credit_approval_date` | 日時型 | |
| クレジット承認時レート | `receive_order_credit_approval_rate` | 数値型 | |
| クレジット支払い回数 | `receive_order_credit_number_payments` | 文字列型 | 受注伝票の支払区分の値 |
| クレジット承認センター区分 | `receive_order_credit_authorization_center_id` | 文字列型 | |
| クレジット承認センター名 | `receive_order_credit_authorization_center_name` | 文字列型 | |
| クレジット承認FAX印刷日 | `receive_order_credit_approval_fax_printing_date` | 日時型 | |
| 顧客区分 | `receive_order_customer_type_id` | 文字列型 | 顧客区分 |
| 顧客名 | `receive_order_customer_type_name` | 文字列型 | |
| 顧客コード | `receive_order_customer_id` | 文字列型 | 顧客区分が9:卸 だった場合に卸先コードが設定されます。 |
| 購入者名 | `receive_order_purchaser_name` | 文字列型 | |
| 購入者カナ | `receive_order_purchaser_kana` | 文字列型 | |
| 購入者郵便番号 | `receive_order_purchaser_zip_code` | 文字列型 | |
| 購入者住所1 | `receive_order_purchaser_address1` | 文字列型 | |
| 購入者住所2 | `receive_order_purchaser_address2` | 文字列型 | |
| 購入者電話番号 | `receive_order_purchaser_tel` | 文字列型 | |
| 購入者FAX | `receive_order_purchaser_fax` | 文字列型 | |
| 購入者メールアドレス | `receive_order_purchaser_mail_address` | 文字列型 | |
| 送り先名 | `receive_order_consignee_name` | 文字列型 | |
| 送り先カナ | `receive_order_consignee_kana` | 文字列型 | |
| 送り先郵便番号 | `receive_order_consignee_zip_code` | 文字列型 | |
| 送り先住所1 | `receive_order_consignee_address1` | 文字列型 | |
| 送り先住所2 | `receive_order_consignee_address2` | 文字列型 | |
| 送り先電話番号 | `receive_order_consignee_tel` | 文字列型 | |
| 送り先FAX | `receive_order_consignee_fax` | 文字列型 | |
| 重要チェック担当者ID | `receive_order_important_check_pic_id` | 数値型 | |
| 重要チェック担当者名 | `receive_order_important_check_pic_name` | 文字列型 | |
| 受注担当者ID | `receive_order_pic_id` | 数値型 | |
| 受注担当者名 | `receive_order_pic_name` | 文字列型 | |
| 出荷担当者ID | `receive_order_send_pic_id` | 数値型 | |
| 出荷担当者名 | `receive_order_send_pic_name` | 文字列型 | |
| 作成日 | `receive_order_creation_date` | 日時型 | |
| 最終更新日 | `receive_order_last_modified_date` | 日時型 | |
| 最終更新日 | `receive_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 |
| 作成担当者ID | `receive_order_creator_id` | 数値型 | |
| 作成担当者名 | `receive_order_creator_name` | 文字列型 | |
| 最終更新者ID | `receive_order_last_modified_by_id` | 数値型 | |
| 最終更新者ID | `receive_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | `receive_order_last_modified_by_name` | 文字列型 | |
| 最終更新者名 | `receive_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 |


 サンプル
### サンプル

リクエスト

```bash
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_shop_id-eq=xxx' https://api.next-engine.org/api_v1_receiveorder_base/count
```

レスポンス

```json
{
  "result": "success",
  "count": "xxx",
  "access_token": "xxxxxxxxxx",
  "access_token_end_date": "2017-04-13 18:24:53",
  "refresh_token": "xxxxxxxxxx",
  "refresh_token_end_date": "2017-04-15 18:24:53"
}
```


## エラー

### エラーコード

エンドポイント固有のエラーコードはありません。
共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_base_count/`](/openapi/operations/api_v1_receiveorder_base_count/) (OpenAPI 3.1 のインタラクティブ仕様)
- エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味)
- フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目)

### 同じカテゴリの他のエンドポイント (受注伝票)

- [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate`
- [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted`
- [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide`
- [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted`
- [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted`
- [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search`
- [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped`
- [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update`
- [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload`

---

# 受注伝票検索
URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/search/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/search
Tag: 受注伝票
Required parameters: access_token
Optional parameters: refresh_token, wait_flag, fields, offset, limit, extension_execution_id

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_receiveorder_base/search`

## リファレンス内容


### 検索について

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります

検索条件を複数指定した場合、全ての条件がかつ(AND)となります

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細は パラメータ共通事項「待機フラグについて」を参照して下さい |
| `fields` | 検索結果で取得するフィールドをカンマ区切りで指定(SELECT句相当) | 必須 | 例：商品マスタ検索で「goods_id, goods_name, stock_quantity, supplier_name」を指定した場合、「商品コード、商品名、在庫数、仕入先名」を検索結果として取得します |
| フィールド名-比較演算子(WHERE句のカラムと比較演算子相当) | 検索条件の値(WHERE句の値相当) | 可能 | 例：商品マスタ検索でパラメータ：goods_id-like、値："%-red"と指定した場合、商品コードが*-redの商品マスタを検索します |
| `extension_execution_id` | 拡張機能実行ID | 可能 | 検索結果画面で実行対象として選択したデータをひとかたまりとして取得することができます。 フィールド名-比較演算子(WHERE句のカラムと比較演算子相当)と同時に指定した場合はAND検索となります。 |
| `offset` | オフセットの数値(OFFSET句相当) | 可能(省略時0) | 0：一番最初の検索結果から取得、1:２番めの検索結果から取得・・・ |
| `limit` | 取得数の数値(LIMIT句相当) | 可能(省略時10000) | |

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `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` | 検索結果の件数 | |
| `data` | 検索結果の連想配列(JSONのオブジェクト型) | |

### 検索速度について

入力パラメータのfieldsの指定を増やすほど処理に時間が掛かります。必要な情報のみ検索した方がより高速になります

検索結果のデータ量が増える程、指数関数的に検索結果の取得に時間がかかります(アプリのWebサーバーの性能が低い程顕著です)。Webサーバーの見直し又は、limit又はfieldsを調整して下さい

大量の検索結果を取得する場合、アクセスが集中する07:00～22:00の時間帯を避けてバックグラウンドで情報を取得することを推奨します


### 受注伝票

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 店舗コード | `receive_order_shop_id` | 数値型 | 店舗マスタの店舗コード |
| 伝票番号 | `receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 |
| 受注番号 | `receive_order_shop_cut_form_id` | 文字列型 | 原則、店舗内で一意に付与される番号（重複する可能性あり。） |
| 受注日 | `receive_order_date` | 日時型 | 店舗側で受注した日 |
| 取込日 | `receive_order_import_date` | 日時型 | ネクストエンジンに取り込まれた日 |
| 重要チェック区分 | `receive_order_important_check_id` | 文字列型 | 1:重要 |
| 重要チェック名 | `receive_order_important_check_name` | 文字列型 | 重要チェックを付けた担当者名 |
| 確認チェック区分 | `receive_order_confirm_check_id` | 文字列型 | 0:確認不要1:確認必要2:確認済み |
| 確認チェック名 | `receive_order_confirm_check_name` | 文字列型 | 確認チェックを付けた担当者名 |
| 受注確認内容ID | `receive_order_confirm_ids` | 文字列型 | 受注確認内容IDが":"区切りで設定されます。明細行に対する確認は"#"の後に明細行番号が設定されます。Ex: "AO:AA#1:AA#2"の場合送り先の郵便番号と住所があってません。商品コードが商品マスタに存在しません。：1行目商品コードが商品マスタに存在しません。：2行目 |
| メール送信状態値 | `receive_order_mail_status` | 文字列型 | 次の値によりどの種類のメール送信が終了したかを表します。区切り文字はありません。例えばJHとあれば受注メールと発送完了メールが送信済みです。 J:受注確認メール B:印刷日待ち連絡メール C:印刷待ち以降連絡メール H:発送メール N:入金確認メール F:フォローメール |
| 受注分類タグ | `receive_order_gruoping_tag` | 文字列型 | []区切りでタグの名称が設定されている。例:[連絡待ち][ゴールド会員] |
| 取込種類区分 | `receive_order_import_type_id` | 文字列型 | 0:メール1:CSV2:手入力 |
| 取込種類名 | `receive_order_import_type_name` | 文字列型 | |
| 受注キャンセル区分 | `receive_order_cancel_type_id` | 文字列型 | 受注キャンセル区分 |
| 受注キャンセル名 | `receive_order_cancel_type_name` | 文字列型 | |
| 受注キャンセル日 | `receive_order_cancel_date` | 日時型 | |
| 受注状態区分 | `receive_order_order_status_id` | 文字列型 | 受注状態区分 |
| 受注状態名 | `receive_order_order_status_name` | 文字列型 | |
| 発送方法区分 | `receive_order_delivery_id` | 文字列型 | 発送方法区分 |
| 発送方法名 | `receive_order_delivery_name` | 文字列型 | |
| 支払区分 | `receive_order_payment_method_id` | 文字列型 | 支払区分受注伝票の支払方法の値 |
| 支払名 | `receive_order_payment_method_name` | 文字列型 | |
| 総合計 | `receive_order_total_amount` | 数値型 | 商品計+税金+手数料+発送代+他費用-ポイント数 |
| 税金 | `receive_order_tax_amount` | 数値型 | |
| 手数料 | `receive_order_charge_amount` | 数値型 | |
| 発送代 | `receive_order_delivery_fee_amount` | 数値型 | |
| 他費用 | `receive_order_other_amount` | 数値型 | |
| ポイント数 | `receive_order_point_amount` | 数値型 | |
| 商品計 | `receive_order_goods_amount` | 数値型 | |
| 入金額 | `receive_order_deposit_amount` | 文字列型 | |
| 入金状況区分 | `receive_order_deposit_type_id` | 文字列型 | 入金区分 |
| 入金状況名 | `receive_order_deposit_type_name` | 文字列型 | |
| 入金日 | `receive_order_deposit_date` | 日時型 | |
| 備考 | `receive_order_note` | 文字列型 | |
| 同梱候補伝票番号 | `receive_order_include_possible_order_id` | 数値型 | ネクストエンジンが自動判定した同梱候補の伝票番号 |
| 同梱先伝票番号 | `receive_order_include_to_order_id` | 数値型 | 同梱した場合の同梱先の伝票番号 |
| 複数配送親伝票番号 | `receive_order_multi_delivery_parent_order_id` | 数値型 | 複数配送の親の伝票番号 |
| 分割元伝票番号 | `receive_order_divide_from_order_id` | 数値型 | 分割元の伝票番号 |
| 複写元伝票番号 | `receive_order_copy_from_order_id` | 数値型 | 複写元の伝票番号 |
| 複数配送親フラグ | `receive_order_multi_delivery_parent_flag` | 文字列型 | 複数配送の親か否か |
| 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 日時型 | |
| 納品書発行日 | `receive_order_statement_delivery_printing_date` | 日時型 | 納品書をダウンロードした日 |
| 納品書特記事項 | `receive_order_statement_delivery_text` | 文字列型 | |
| 出荷確定日 | `receive_order_send_date` | 日時型 | 受注状態が出荷確定済みになった日 |
| 出荷予定日 | `receive_order_send_plan_date` | 日時型 | |
| 出荷順序 | `receive_order_send_sequence` | 文字列型 | ラベル発行フラグがたった順序 |
| 作業用欄 | `receive_order_worker_text` | 文字列型 | |
| ピッキング指示内容 | `receive_order_picking_instruct` | 文字列型 | |
| ラベル発行日 | `receive_order_label_print_date` | 日時型 | |
| ラベル発行フラグ | `receive_order_label_print_flag` | 文字列型 | 配送伝票の印刷対象か否か0:対象外1:対象2:発行済み |
| 配達希望日 | `receive_order_hope_delivery_date` | 日時型 | |
| 配達希望時間帯区分 | `receive_order_hope_delivery_time_slot_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 配達希望時間帯名 | `receive_order_hope_delivery_time_slot_name` | 文字列型 | |
| 便種区分 | `receive_order_delivery_method_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 便種名 | `receive_order_delivery_method_name` | 文字列型 | |
| シール1区分 | `receive_order_seal1_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール1名 | `receive_order_seal1_name` | 文字列型 | |
| シール2区分 | `receive_order_seal2_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール2名 | `receive_order_seal2_name` | 文字列型 | |
| シール3区分 | `receive_order_seal3_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール3名 | `receive_order_seal3_name` | 文字列型 | |
| シール4区分 | `receive_order_seal4_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール4名 | `receive_order_seal4_name` | 文字列型 | |
| 営業止め区分 | `receive_order_business_office_stop_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 営業止め名 | `receive_order_business_office_stop_name` | 文字列型 | |
| 送り状区分 | `receive_order_invoice_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 送り状名 | `receive_order_invoice_name` | 文字列型 | |
| 温度区分 | `receive_order_temperature_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 温度名 | `receive_order_temperature_name` | 文字列型 | |
| 営業所名 | `receive_order_business_office_name` | 文字列型 | |
| ギフトフラグ | `receive_order_gift_flag` | 文字列型 | 0:ギフトではない1:ギフト |
| 置き配フラグ | `receive_order_unattended_delivery_flg` | 文字列型 | 0:置き配指定なし 1:置き配指定あり |
| 置き配場所名称 | `receive_order_unattended_delivery_location_name` | 文字列型 | 例：宅配ボックス、玄関前、メータボックス |
| 発送伝票番号 | `receive_order_delivery_cut_form_id` | 文字列型 | 各発送方法の問い合わせ番号が設定されます。 |
| 発送伝票備考欄 | `receive_order_delivery_cut_form_note` | 文字列型 | |
| クレジット区分 | `receive_order_credit_type_id` | 文字列型 | クレジット種類区分 |
| クレジット名 | `receive_order_credit_type_name` | 文字列型 | |
| クレジット承認番号 | `receive_order_credit_approval_no` | 文字列型 | |
| クレジット承認額 | `receive_order_credit_approval_amount` | 文字列型 | |
| クレジット承認区分 | `receive_order_credit_approval_type_id` | 文字列型 | クレジット承認区分 |
| クレジット承認名 | `receive_order_credit_approval_type_name` | 文字列型 | |
| クレジット承認日 | `receive_order_credit_approval_date` | 日時型 | |
| クレジット承認時レート | `receive_order_credit_approval_rate` | 数値型 | |
| クレジット支払い回数 | `receive_order_credit_number_payments` | 文字列型 | 受注伝票の支払区分の値 |
| クレジット承認センター区分 | `receive_order_credit_authorization_center_id` | 文字列型 | |
| クレジット承認センター名 | `receive_order_credit_authorization_center_name` | 文字列型 | |
| クレジット承認FAX印刷日 | `receive_order_credit_approval_fax_printing_date` | 日時型 | |
| 顧客区分 | `receive_order_customer_type_id` | 文字列型 | 顧客区分 |
| 顧客名 | `receive_order_customer_type_name` | 文字列型 | |
| 顧客コード | `receive_order_customer_id` | 文字列型 | 顧客区分が9:卸 だった場合に卸先コードが設定されます。 |
| 購入者名 | `receive_order_purchaser_name` | 文字列型 | |
| 購入者カナ | `receive_order_purchaser_kana` | 文字列型 | |
| 購入者郵便番号 | `receive_order_purchaser_zip_code` | 文字列型 | |
| 購入者住所1 | `receive_order_purchaser_address1` | 文字列型 | |
| 購入者住所2 | `receive_order_purchaser_address2` | 文字列型 | |
| 購入者電話番号 | `receive_order_purchaser_tel` | 文字列型 | |
| 購入者FAX | `receive_order_purchaser_fax` | 文字列型 | |
| 購入者メールアドレス | `receive_order_purchaser_mail_address` | 文字列型 | |
| 送り先名 | `receive_order_consignee_name` | 文字列型 | |
| 送り先カナ | `receive_order_consignee_kana` | 文字列型 | |
| 送り先郵便番号 | `receive_order_consignee_zip_code` | 文字列型 | |
| 送り先住所1 | `receive_order_consignee_address1` | 文字列型 | |
| 送り先住所2 | `receive_order_consignee_address2` | 文字列型 | |
| 送り先電話番号 | `receive_order_consignee_tel` | 文字列型 | |
| 送り先FAX | `receive_order_consignee_fax` | 文字列型 | |
| 重要チェック担当者ID | `receive_order_important_check_pic_id` | 数値型 | |
| 重要チェック担当者名 | `receive_order_important_check_pic_name` | 文字列型 | |
| 受注担当者ID | `receive_order_pic_id` | 数値型 | |
| 受注担当者名 | `receive_order_pic_name` | 文字列型 | |
| 出荷担当者ID | `receive_order_send_pic_id` | 数値型 | |
| 出荷担当者名 | `receive_order_send_pic_name` | 文字列型 | |
| 作成日 | `receive_order_creation_date` | 日時型 | |
| 最終更新日 | `receive_order_last_modified_date` | 日時型 | |
| 最終更新日 | `receive_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 |
| 作成担当者ID | `receive_order_creator_id` | 数値型 | |
| 作成担当者名 | `receive_order_creator_name` | 文字列型 | |
| 最終更新者ID | `receive_order_last_modified_by_id` | 数値型 | |
| 最終更新者ID | `receive_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | `receive_order_last_modified_by_name` | 文字列型 | |
| 最終更新者名 | `receive_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 |


### 受注伝票オプション

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 伝票番号 | `receive_order_option_receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 |
| 一言メモ | `receive_order_option_single_word_memo` | 文字列型 | |
| メッセージ | `receive_order_option_message` | 文字列型 | |
| のし | `receive_order_option_noshi` | 文字列型 | |
| ラッピング | `receive_order_option_rapping` | 文字列型 | |
| オプション1 | `receive_order_option_1` | 文字列型 | |
| オプション2 | `receive_order_option_2` | 文字列型 | |
| オプション3 | `receive_order_option_3` | 文字列型 | |
| オプション4 | `receive_order_option_4` | 文字列型 | |
| オプション5 | `receive_order_option_5` | 文字列型 | |
| オプション6 | `receive_order_option_6` | 文字列型 | |
| オプション7 | `receive_order_option_7` | 文字列型 | |
| オプション8 | `receive_order_option_8` | 文字列型 | |
| オプション9 | `receive_order_option_9` | 文字列型 | |
| オプション10 | `receive_order_option_10` | 文字列型 | |
| 受注時店舗原資クーポン | `receive_order_option_received_time_shop_coupon` | 数値型 | 楽天とYahoo!に対応しています。 |
| 受注時モール原資クーポン | `receive_order_option_received_time_mall_coupon` | 数値型 | 楽天とYahoo!に対応しています。 |
| 作成日 | `receive_order_option_creation_date` | 日時型 | |
| 最終更新日 | `receive_order_option_last_modified_date` | 日時型 | |
| 最終更新日 | `receive_order_option_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 |
| 作成担当者ID | `receive_order_option_creator_id` | 数値型 | |
| 作成担当者名 | `receive_order_option_creator_name` | 文字列型 | |
| 最終更新者ID | `receive_order_option_last_modified_by_id` | 数値型 | |
| 最終更新者ID | `receive_order_option_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | `receive_order_option_last_modified_by_name` | 文字列型 | |
| 最終更新者名 | `receive_order_option_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 |


 サンプル
### サンプル

:::tip[はじめての受注検索：推奨フィールドセット]
`fields` は必須パラメータですが、130以上あるフィールドから何を選べばいいか迷う場合は、以下の7フィールドが「受注の基本情報」を網羅した最小セットです。

```
receive_order_id,receive_order_shop_id,receive_order_date,receive_order_import_date,receive_order_status_id,receive_order_status_name,receive_order_buyer_name
```
:::


リクエスト

```bash
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&fields=receive_order_shop_id, receive_order_id, receive_order_cancel_date&receive_order_shop_id-eq=xxx' https://api.next-engine.org/api_v1_receiveorder_base/search
```

レスポンス

```json
{
  "result": "success",
  "count": "14",
  "data": [
    {
      "receive_order_shop_id": "1",
      "receive_order_id": "1",
      "receive_order_shop_cut_form_id": "12345-6789",
      "receive_order_date": "2014-05-01 00:00:00",
      "receive_order_import_date": "2017-01-19 12:55:37",
      "receive_order_important_check_id": "0",
      "receive_order_important_check_name": "",
      "receive_order_confirm_check_id": "1",
      "receive_order_confirm_check_name": "確認必要（表示）",
      "receive_order_confirm_ids": "AA:AA#232:AA",
      "receive_order_gruoping_tag": null,
      "receive_order_import_type_id": "1",
      "receive_order_import_type_name": "ＣＳＶ",
      "receive_order_cancel_type_id": "1",
      "receive_order_cancel_type_name": "顧客依頼によりキャンセル",
      "receive_order_cancel_date": "0000-00-00 00:00:00",
      "receive_order_order_status_id": "2",
      "receive_order_order_status_name": "起票済(CSV/手入力)",
      "receive_order_delivery_id": "10",
      "receive_order_delivery_name": "佐川急便(e飛伝PRO)",
      "receive_order_payment_method_id": "15",
      "receive_order_payment_method_name": "銀行振込前払い",
      "receive_order_total_amount": "2300.00",
      "receive_order_tax_amount": "0.00",
      "receive_order_charge_amount": "0.00",
      "receive_order_delivery_fee_amount": "300.00",
      "receive_order_other_amount": "0.00",
      "receive_order_point_amount": "0.00",
      "receive_order_goods_amount": "2000.00",
      "receive_order_deposit_amount": "0.00",
      "receive_order_deposit_type_id": "0",
      "receive_order_deposit_type_name": "未入金",
      "receive_order_deposit_date": null,
      "receive_order_note": "ok\n▼伝票2より▼\n先に頼んだものと一緒に発送お願いします。",
      "receive_order_include_possible_order_id": "0",
      "receive_order_include_to_order_id": "3",
      "receive_order_multi_delivery_parent_order_id": null,
      "receive_order_divide_from_order_id": null,
      "receive_order_copy_from_order_id": null,
      "receive_order_multi_delivery_parent_flag": "0",
      "receive_order_statement_delivery_instruct_printing_date": "0000-00-00 00:00:00",
      "receive_order_statement_delivery_printing_date": null,
      "receive_order_statement_delivery_text": null,
      "receive_order_send_date": null,
      "receive_order_send_plan_date": null,
      "receive_order_send_sequence": null,
      "receive_order_worker_text": null,
      "receive_order_picking_instruct": null,
      "receive_order_label_print_date": null,
      "receive_order_label_print_flag": "0",
      "receive_order_hope_delivery_date": null,
      "receive_order_hope_delivery_time_slot_id": null,
      "receive_order_hope_delivery_time_slot_name": null,
      "receive_order_delivery_method_id": "000",
      "receive_order_delivery_method_name": null,
      "receive_order_seal1_id": null,
      "receive_order_seal1_name": null,
      "receive_order_seal2_id": null,
      "receive_order_seal2_name": null,
      "receive_order_seal3_id": null,
      "receive_order_seal3_name": null,
      "receive_order_seal4_id": null,
      "receive_order_seal4_name": null,
      "receive_order_business_office_stop_id": null,
      "receive_order_business_office_stop_name": null,
      "receive_order_invoice_id": null,
      "receive_order_invoice_name": null,
      "receive_order_temperature_id": null,
      "receive_order_temperature_name": null,
      "receive_order_business_office_name": null,
      "receive_order_gift_flag": "0",
      "receive_order_delivery_cut_form_id": null,
      "receive_order_delivery_cut_form_note": null,
      "receive_order_credit_type_id": "0",
      "receive_order_credit_type_name": "なし",
      "receive_order_credit_approval_no": null,
      "receive_order_credit_approval_amount": "0.00",
      "receive_order_credit_approval_type_id": "0",
      "receive_order_credit_approval_type_name": "必要なし",
      "receive_order_credit_approval_date": null,
      "receive_order_credit_approval_rate": "0.00",
      "receive_order_credit_number_payments": null,
      "receive_order_credit_authorization_center_id": null,
      "receive_order_credit_authorization_center_name": null,
      "receive_order_credit_approval_fax_printing_date": null,
      "receive_order_customer_type_id": "0",
      "receive_order_customer_type_name": "一般顧客",
      "receive_order_customer_id": null,
      "receive_order_purchaser_name": "テスト 太郎",
      "receive_order_purchaser_kana": "テスト タロウ",
      "receive_order_purchaser_zip_code": "2500111",
      "receive_order_purchaser_address1": "神奈川県 小田原市",
      "receive_order_purchaser_address2": "栄町2-9-39 小田原EPO",
      "receive_order_purchaser_tel": "0311112222",
      "receive_order_purchaser_fax": null,
      "receive_order_purchaser_mail_address": "test@example.com",
      "receive_order_consignee_name": "テスト 太郎",
      "receive_order_consignee_kana": "テスト タロウ",
      "receive_order_consignee_zip_code": "0111111",
      "receive_order_consignee_address1": "神奈川県 小田原市",
      "receive_order_consignee_address2": "栄町2-9-39 小田原EPO",
      "receive_order_consignee_tel": "0311112222",
      "receive_order_consignee_fax": null,
      "receive_order_reminder_start_date": null,
      "receive_order_reminder_last_date": null,
      "receive_order_reminder_count": "0",
      "receive_order_important_check_pic_id": null,
      "receive_order_important_check_pic_name": null,
      "receive_order_pic_id": "10002",
      "receive_order_pic_name": "xxxxxxxx",
      "receive_order_send_pic_id": null,
      "receive_order_send_pic_name": null,
      "receive_order_deleted_flag": "0",
      "receive_order_creation_date": "2017-01-19 12:55:37",
      "receive_order_last_modified_date": "2017-03-22 16:19:16",
      "receive_order_last_modified_null_safe_date": "2017-03-22 16:19:16",
      "receive_order_creator_id": "10002",
      "receive_order_creator_name": "xxxxxxx",
      "receive_order_last_modified_by_id": "9999",
      "receive_order_last_modified_by_null_safe_id": "9999",
      "receive_order_last_modified_by_name": "管理者",
      "receive_order_last_modified_by_null_safe_name": "管理者"
    },
    {
      "receive_order_shop_id": "1",
      "receive_order_id": "2",
      "receive_order_shop_cut_form_id": "RAKUTEN-123TEST",
      "receive_order_date": "2014-02-06 03:09:00",
      "receive_order_import_date": "2017-01-19 12:55:38",
      "receive_order_important_check_id": "0",
      "receive_order_important_check_name": "",
      "receive_order_confirm_check_id": "1",
      "receive_order_confirm_check_name": "確認必要（表示）",
      "receive_order_confirm_ids": "AG:AO:CT:AA#1:AA#2",
      "receive_order_gruoping_tag": null,
      "receive_order_import_type_id": "1",
      "receive_order_import_type_name": "ＣＳＶ",
      "receive_order_cancel_type_id": "3",
      "receive_order_cancel_type_name": "他の伝票への統合の為キャンセル",
      "receive_order_cancel_date": "2017-02-09 18:26:03",
      "receive_order_order_status_id": "2",
      "receive_order_order_status_name": "起票済(CSV/手入力)",
      "receive_order_delivery_id": "10",
      "receive_order_delivery_name": "佐川急便(e飛伝PRO)",
      "receive_order_payment_method_id": "15",
      "receive_order_payment_method_name": "銀行振込前払い",
      "receive_order_total_amount": "3180.00",
      "receive_order_tax_amount": "0.00",
      "receive_order_charge_amount": "0.00",
      "receive_order_delivery_fee_amount": "0.00",
      "receive_order_other_amount": "0.00",
      "receive_order_point_amount": "0.00",
      "receive_order_goods_amount": "3180.00",
      "receive_order_deposit_amount": "0.00",
      "receive_order_deposit_type_id": "0",
      "receive_order_deposit_type_name": "未入金",
      "receive_order_deposit_date": null,
      "receive_order_note": "先に頼んだものと一緒に発送お願いします。",
      "receive_order_include_possible_order_id": "1",
      "receive_order_include_to_order_id": "1",
      "receive_order_multi_delivery_parent_order_id": null,
      "receive_order_divide_from_order_id": null,
      "receive_order_copy_from_order_id": null,
      "receive_order_multi_delivery_parent_flag": "0",
      "receive_order_statement_delivery_instruct_printing_date": "0000-00-00 00:00:00",
      "receive_order_statement_delivery_printing_date": null,
      "receive_order_statement_delivery_text": null,
      "receive_order_send_date": null,
      "receive_order_send_plan_date": null,
      "receive_order_send_sequence": null,
      "receive_order_worker_text": null,
      "receive_order_picking_instruct": null,
      "receive_order_label_print_date": null,
      "receive_order_label_print_flag": "0",
      "receive_order_hope_delivery_date": null,
      "receive_order_hope_delivery_time_slot_id": null,
      "receive_order_hope_delivery_time_slot_name": null,
      "receive_order_delivery_method_id": "000",
      "receive_order_delivery_method_name": null,
      "receive_order_seal1_id": null,
      "receive_order_seal1_name": null,
      "receive_order_seal2_id": null,
      "receive_order_seal2_name": null,
      "receive_order_seal3_id": null,
      "receive_order_seal3_name": null,
      "receive_order_seal4_id": null,
      "receive_order_seal4_name": null,
      "receive_order_business_office_stop_id": null,
      "receive_order_business_office_stop_name": null,
      "receive_order_invoice_id": null,
      "receive_order_invoice_name": null,
      "receive_order_temperature_id": " ",
      "receive_order_temperature_name": null,
      "receive_order_business_office_name": null,
      "receive_order_gift_flag": "0",
      "receive_order_delivery_cut_form_id": null,
      "receive_order_delivery_cut_form_note": null,
      "receive_order_credit_type_id": "0",
      "receive_order_credit_type_name": "なし",
      "receive_order_credit_approval_no": null,
      "receive_order_credit_approval_amount": "0.00",
      "receive_order_credit_approval_type_id": "0",
      "receive_order_credit_approval_type_name": "必要なし",
      "receive_order_credit_approval_date": null,
      "receive_order_credit_approval_rate": "0.00",
      "receive_order_credit_number_payments": null,
      "receive_order_credit_authorization_center_id": null,
      "receive_order_credit_authorization_center_name": null,
      "receive_order_credit_approval_fax_printing_date": null,
      "receive_order_customer_type_id": "0",
      "receive_order_customer_type_name": "一般顧客",
      "receive_order_customer_id": null,
      "receive_order_purchaser_name": "テスト 太郎",
      "receive_order_purchaser_kana": "テスト タロウ",
      "receive_order_purchaser_zip_code": "2500111",
      "receive_order_purchaser_address1": "神奈川県 小田原市",
      "receive_order_purchaser_address2": "栄町2-9-39 小田原EPO",
      "receive_order_purchaser_tel": "0311112222",
      "receive_order_purchaser_fax": null,
      "receive_order_purchaser_mail_address": "test@example.com",
      "receive_order_consignee_name": "テスト 太郎",
      "receive_order_consignee_kana": "テスト タロウ",
      "receive_order_consignee_zip_code": "0111111",
      "receive_order_consignee_address1": "神奈川県 小田原市",
      "receive_order_consignee_address2": "栄町2-9-39 小田原EPO",
      "receive_order_consignee_tel": "0311112222",
      "receive_order_consignee_fax": null,
      "receive_order_reminder_start_date": null,
      "receive_order_reminder_last_date": null,
      "receive_order_reminder_count": "0",
      "receive_order_important_check_pic_id": null,
      "receive_order_important_check_pic_name": null,
      "receive_order_pic_id": "10002",
      "receive_order_pic_name": "xxxxxxx",
      "receive_order_send_pic_id": null,
      "receive_order_send_pic_name": null,
      "receive_order_deleted_flag": "0",
      "receive_order_creation_date": "2017-01-19 12:55:38",
      "receive_order_last_modified_date": "2017-02-09 18:26:03",
      "receive_order_last_modified_null_safe_date": "2017-02-09 18:26:03",
      "receive_order_creator_id": "10002",
      "receive_order_creator_name": "xxxxxxx",
      "receive_order_last_modified_by_id": "10003",
      "receive_order_last_modified_by_null_safe_id": "10003",
      "receive_order_last_modified_by_name": "xxxxxxxx",
      "receive_order_last_modified_by_null_safe_name": "xxxxxxx"
    }
  ],
  "access_token": "xxxxxxxxxx",
  "access_token_end_date": "2017-04-13 18:24:53",
  "refresh_token": "xxxxxxxxxx",
  "refresh_token_end_date": "2017-04-15 18:24:53"
}
```


## エラー

### エラーコード

エンドポイント固有のエラーコードはありません。
共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_base_search/`](/openapi/operations/api_v1_receiveorder_base_search/) (OpenAPI 3.1 のインタラクティブ仕様)
- エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味)
- フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目)

### 同じカテゴリの他のエンドポイント (受注伝票)

- [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate`
- [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted`
- [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count`
- [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide`
- [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted`
- [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted`
- [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped`
- [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update`
- [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload`

---

# 受注伝票更新
URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/update/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/update
Tag: 受注伝票
Required parameters: access_token, receive_order_id, receive_order_last_modified_date, data
Optional parameters: refresh_token, wait_flag, fields, offset, limit, receive_order_shipped_update_flag, receive_order_row_cancel_update_flag, receive_order_recalculate_flag

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_receiveorder_base/update`

## リファレンス内容


### 索引

- 受注伝票更新
- 入力パラメータ
- 出力パラメータ
- XML形式
- 更新仕様

### 受注伝票更新

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。

受注伝票の項目をパラメータで指定した値で更新します。

処理結果はレスポンスのステータスコードで確認します。

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細は パラメータ共通事項「待機フラグについて」を参照して下さい |
| `receive_order_id` | 伝票番号 | 必須 | 更新する受注の伝票番号 |
| `receive_order_last_modified_date` | 最終更新日 | 必須 | 更新する受注の最終更新日 API実行時にメイン機能またはアプリで、受注伝票が更新されていないかを確認するために利用します メイン機能またはアプリで受注伝票が更新されている場合はエラーになります エラーになったら再度、受注伝票を検索してAPIを実行して下さい |
| `data` | 更新するデータ | 必須 | XML形式で指定します [形式はこちら](#xml形式)を参照 |
| `receive_order_shipped_update_flag` | 1:受注状態が「出荷確定済（完了）」でも更新可 1以外:受注状態が「出荷確定済（完了）」は更新不可 | 可能(省略時は1以外とする) | |
| `receive_order_row_cancel_update_flag` | 1:受注伝票の受注キャンセル区分を0（有効）に変更したときに明細行のキャンセルフラグを有効にする 1以外:受注キャンセル区分を0（有効）に変更しても明細行のキャンセルフラグに影響なし | 可能(省略時は1以外とする) | このフラグが有効になるのは受注伝票がキャンセルから有効に変更されるときのみとなります。 |
| `receive_order_recalculate_flag` | 1:受注伝票の金額系項目の再計算を有効にする 1以外:再計算を行わない | 可能(省略時は1以外とする) | 受注明細項目である小計金額は再計算の対象にならないためご注意ください 金額系項目とは、受注伝票項目である商品計、税金、総合計の3項目（インボイス対応店舗の受注の場合は、手数料、他費用、ポイント数、請求金額（0%）、請求金額（8%）、請求金額（10%）、請求額に対する税額（8%）、請求額に対する税額（10%）を加えた11項目）を指します |

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `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の有効期限切れ日時 | |

### XML形式

入力パラメータのdataで指定する値です 

完成サンプルは 

 こちらを参照

| 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 |
| --- | --- | --- | --- | --- | --- |
| 1 | <root> | ○ | | | |
| 2 | <receiveorder_base> | | | | 受注伝票の項目を指定する要素 更新する 受注伝票のフィールド名と値を指定します |
| 3 | <receive_order_date> | | | | |
| 3 | <receive_order_shop_cut_form_id> | | | | |
| 2 | </receiveorder_base> | | | | |
| 2 | <receiveorder_option> | | | | 受注伝票オプションの項目を指定する要素 更新する 受注伝票オプションのフィールド名と値を指定します |
| 3 | <receive_order_option_single_word_memo> | | | | |
| 3 | <receive_order_option_5> | | | | |
| 2 | </receiveorder_option> | | | | |
| 2 | <receiveorder_row> | | | | 受注明細の項目を指定する要素 |
| 3 | <receive_order_row_no> | | ○ | `value` | 属性に更新対象の明細行を指定します 更新する明細行が複数ある場合はその分、要素を繰り返します |
| 4 | <receive_order_row_goods_name> | | | | 更新する 受注明細のフィールド名と値を指定します |
| 4 | <receive_order_row_cancel_flag> | | | | |
| 3 | </receive_order_row_no> | | | | |
| 2 | </receiveorder_row> | | | | |
| 1 | </root> | ○ | | | |

XML完成サンプル1（受注伝票と受注明細を更新）

```xml
<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder_base>
 <receive_order_shop_cut_form_id>12345-6789</receive_order_shop_cut_form_id>
 <receive_order_date>2014-05-01 00:00:00</receive_order_date>
 </receiveorder_base>
 <receiveorder_row>
 <receive_order_row_no value="1">
 <receive_order_row_goods_name>テスト商品</receive_order_row_goods_name>
 <receive_order_row_cancel_flag>1</receive_order_row_cancel_flag>
 </receive_order_row_no>
 <receive_order_row_no value="2">
 <receive_order_row_goods_name>テスト商品2</receive_order_row_goods_name>
 </receive_order_row_no>
 <receive_order_row_no value="3">
 <receive_order_row_quantity>3</receive_order_row_quantity>
 </receive_order_row_no>
 </receiveorder_row>
</root>
```

XML完成サンプル2（受注伝票の更新と、受注明細の更新と追加）

```xml
<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder_base>
 <receive_order_shop_cut_form_id>12345-6789</receive_order_shop_cut_form_id>
 <receive_order_date>2014-05-01 00:00:00</receive_order_date>
 </receiveorder_base>
 <receiveorder_row>
 <receive_order_row_no value="1">
 <receive_order_row_goods_name>テスト商品</receive_order_row_goods_name>
 <receive_order_row_cancel_flag>1</receive_order_row_cancel_flag>
 </receive_order_row_no>
 <receive_order_row_no value="2">
 <receive_order_row_goods_name>テスト商品2</receive_order_row_goods_name>
 </receive_order_row_no>
 <receive_order_row_no value="3">
 <receive_order_row_quantity>3</receive_order_row_quantity>
 </receive_order_row_no>
 </receiveorder_row>
</root>
```

XML完成サンプル3（受注伝票のみ更新）

```xml
<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder_base>
 <receive_order_shop_cut_form_id>12345-6789</receive_order_shop_cut_form_id>
 <receive_order_date>2014-05-01 00:00:00</receive_order_date>
 </receiveorder_base>
</root>
```

### 更新仕様

APIで指定出来るフィールドの一覧です。

ここに記載されていないフィールドは指定できません。

以下のフィールドはAPIで更新成功した場合、自動的に登録・更新されます。

- 最終更新日
- 最終更新者ID
- 重要チェックをつけた場合、重要チェック担当者ID
- 更新した受注伝票の操作履歴

受注メール取込済の伝票は、以下のフィールドのみAPIで更新できます。

- 受注キャンセル区分
- 作業用欄
- 受注分類タグ

#### 受注伝票

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 店舗コード | `receive_order_shop_id` | 数値型 | |
| 受注番号 | `receive_order_shop_cut_form_id` | 文字列型 | メイン機能内でユニークかのチェックはしない |
| 受注日 | `receive_order_date` | 日時型 | YYYY-MM-DD hh:mm:ss |
| 受注確認内容 | `receive_order_confirm_ids` | 文字列型 | 受注確認内容IDを":"区切りで設定します。明細行に対する確認は"#"の後に明細行番号が設定されます。 Ex: "AO:AA#1:AA#2"の場合 送り先の郵便番号と住所があってません。 商品コードが商品マスタに存在しません。：1行目 商品コードが商品マスタに存在しません。：2行目 |
| 確認チェック区分 | `receive_order_confirm_check_id` | 文字列型 | 0：チェックを外す 1：チェックをつける チェックを外した時、受注状態が納品書印刷待ちの場合は起票済みに戻る 納品書印刷済み以降はエラーが返る |
| 受注分類タグ | `receive_order_gruoping_tag` | 文字列型 | タグを[ ]で括る 例：[テストタグ][倉庫A] メイン機能に存在しないタグが指定された場合は、そのタグは自動で受注分類タグに登録される |
| 受注キャンセル区分 | `receive_order_cancel_type_id` | 文字列型 | 0：有効 1：顧客依頼によりキャンセル 受注キャンセルコードを指定 |
| 発送方法区分 | `receive_order_delivery_id` | 文字列型 | 配達希望時間帯、便種、営業止め、送り状、温度、シールとの整合性チェックはしない 整合性が必要な場合は、 発送方法別項目タイプの値を指定 |
| 支払区分 | `receive_order_payment_method_id` | 文字列型 | 出荷可能設定の整合性チェックはしない 整合性が必要な場合は、アプリ側で考慮して設定して下さい。 |
| 商品計 | `receive_order_goods_amount` | 数値型 | |
| 税金 | `receive_order_tax_amount` | 数値型 | |
| 手数料 | `receive_order_charge_amount` | 数値型 | |
| 発送代 | `receive_order_delivery_fee_amount` | 数値型 | |
| 他費用 | `receive_order_other_amount` | 数値型 | |
| ポイント数 | `receive_order_point_amount` | 数値型 | |
| 総合計 | `receive_order_total_amount` | 数値型 | |
| 入金額 | `receive_order_deposit_amount` | 文字列型 | |
| 入金状況区分 | `receive_order_deposit_type_id` | 文字列型 | |
| 入金日 | `receive_order_deposit_date` | 日時型 | YYYY-MM-DD hh:mm:ss |
| 備考 | `receive_order_note` | 文字列型 | |
| 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 日時型 | YYYY-MM-DD hh:mm:ss |
| 納品書特記事項 | `receive_order_statement_delivery_text` | 文字列型 | |
| 作業用欄 | `receive_order_worker_text` | 文字列型 | |
| ピッキング指示内容 | `receive_order_picking_instruct` | 文字列型 | |
| 配達希望日 | `receive_order_hope_delivery_date` | 日時型 | YYYY-MM-DD hh:mm:ss |
| 配達希望時間帯区分 | `receive_order_hope_delivery_time_slot_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 |
| 便種区分 | `receive_order_delivery_method_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 |
| 営業止め区分 | `receive_order_business_office_stop_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 |
| 送り状区分 | `receive_order_invoice_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 |
| 温度区分 | `receive_order_temperature_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 |
| シール1区分 | `receive_order_seal1_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 |
| シール2区分 | `receive_order_seal2_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 |
| シール3区分 | `receive_order_seal3_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 |
| シール4区分 | `receive_order_seal4_id` | 文字列型 | 更新する 発送方法別項目タイプの値を指定 |
| ギフトフラグ | `receive_order_gift_flag` | 文字列型 | 0：無し 1：有り |
| 発送伝票番号 | `receive_order_delivery_cut_form_id` | 文字列型 | |
| 発送伝票備考欄 | `receive_order_delivery_cut_form_note` | 文字列型 | |
| クレジット区分 | `receive_order_credit_type_id` | 文字列型 | |
| クレジット承認番号 | `receive_order_credit_approval_no` | 文字列型 | |
| クレジット承認額 | `receive_order_credit_approval_amount` | 文字列型 | |
| クレジット承認区分 | `receive_order_credit_approval_type_id` | 文字列型 | |
| クレジット承認名 | `receive_order_credit_approval_type_name` | 文字列型 | |
| クレジット承認日 | `receive_order_credit_approval_date` | 日時型 | YYYY-MM-DD hh:mm:ss |
| 顧客区分 | `receive_order_customer_type_id` | 文字列型 | |
| 顧客コード | `receive_order_customer_id` | 文字列型 | |
| 購入者名 | `receive_order_purchaser_name` | 文字列型 | |
| 購入者カナ | `receive_order_purchaser_kana` | 文字列型 | |
| 購入者郵便番号 | `receive_order_purchaser_zip_code` | 文字列型 | ハイフンは不要 |
| 購入者住所1 | `receive_order_purchaser_address1` | 文字列型 | |
| 購入者住所2 | `receive_order_purchaser_address2` | 文字列型 | |
| 購入者電話番号 | `receive_order_purchaser_tel` | 文字列型 | ハイフンは不要 |
| 購入者メールアドレス | `receive_order_purchaser_mail_address` | 文字列型 | メールアドレス形式で指定 |
| 送り先名 | `receive_order_consignee_name` | 文字列型 | |
| 送り先カナ | `receive_order_consignee_kana` | 文字列型 | |
| 送り先郵便番号 | `receive_order_consignee_zip_code` | 文字列型 | ハイフンは不要 |
| 送り先住所1 | `receive_order_consignee_address1` | 文字列型 | |
| 送り先住所2 | `receive_order_consignee_address2` | 文字列型 | |
| 送り先電話番号 | `receive_order_consignee_tel` | 文字列型 | ハイフンは不要 |
| 重要チェック区分 | `receive_order_important_check_id` | 文字列型 | 0：チェックしない 1：チェックする |
| 納品書発行日 | `receive_order_statement_delivery_printing_date` | 日時型 | YYYY-MM-DD hh:mm:ss |
| クレジット支払い回数 | `receive_order_credit_number_payments` | 数値型 | |
| 出荷予定日 | `receive_order_send_plan_date` | 日時型 | YYYY-MM-DD hh:mm:ss |
| 請求金額（0%） | `receive_order_request_amount_tax0` | 数値型 | 税率毎の（商品計+送料+手数料) - (クーポン+ポイント) |
| 請求金額（8%） | `receive_order_request_amount_tax8` | 数値型 | 税率毎の（商品計+送料+手数料) - (クーポン+ポイント) |
| 請求金額（10%） | `receive_order_request_amount_tax10` | 数値型 | 税率毎の（商品計+送料+手数料) - (クーポン+ポイント) |
| 請求額に対する税額（8%） | `receive_order_request_amount_tax_tax8` | 数値型 | 税率ごとの請求金額から割り戻した消費税額 |
| 請求額に対する税額（10%） | `receive_order_request_amount_tax_tax10` | 数値型 | 税率ごとの請求金額から割り戻した消費税額 |
| 手数料（0%） | `receive_order_charge_amount_tax0` | 数値型 | |
| 手数料（8%） | `receive_order_charge_amount_tax8` | 数値型 | |
| 手数料（10%） | `receive_order_charge_amount_tax10` | 数値型 | |
| 他費用（0%） | `receive_order_other_amount_tax0` | 数値型 | 受注伝票の「他費用」のうち、加算する金額（税率毎） |
| 他費用（8%） | `receive_order_other_amount_tax8` | 数値型 | 受注伝票の「他費用」のうち、加算する金額（税率毎） |
| 他費用（10%） | `receive_order_other_amount_tax10` | 数値型 | 受注伝票の「他費用」のうち、加算する金額（税率毎） |
| クーポン割引額（0%） | `receive_order_coupon_amount_tax0` | 数値型 | |
| クーポン割引額（8%） | `receive_order_coupon_amount_tax8` | 数値型 | |
| クーポン割引額（10%） | `receive_order_coupon_amount_tax10` | 数値型 | |
| クーポン割引額（按分） | `receive_order_coupon_amount_distribute` | 数値型 | |
| ポイント（0%） | `receive_order_point_amount_tax0` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） |
| ポイント（8%） | `receive_order_point_amount_tax8` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） |
| ポイント（10%） | `receive_order_point_amount_tax10` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（税率毎） |
| ポイント（按分） | `receive_order_point_amount_distribute` | 数値型 | ポイントのうち、値引（=請求金額の算出に含めるもの）となるもの（按分されるポイント） |
| ポイント（支払い） | `receive_order_point_amount_payment` | 数値型 | |

#### 受注伝票オプション

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 一言メモ | `receive_order_option_single_word_memo` | 文字列型 | |
| メッセージ | `receive_order_option_message` | 文字列型 | |
| のし | `receive_order_option_noshi` | 文字列型 | |
| ラッピング | `receive_order_option_rapping` | 文字列型 | |
| オプション1 | `receive_order_option_1` | 文字列型 | |
| オプション2 | `receive_order_option_2` | 文字列型 | |
| オプション3 | `receive_order_option_3` | 文字列型 | |
| オプション4 | `receive_order_option_4` | 文字列型 | |
| オプション5 | `receive_order_option_5` | 文字列型 | |
| オプション6 | `receive_order_option_6` | 文字列型 | |
| オプション7 | `receive_order_option_7` | 文字列型 | |
| オプション8 | `receive_order_option_8` | 文字列型 | |
| オプション9 | `receive_order_option_9` | 文字列型 | |
| オプション10 | `receive_order_option_10` | 文字列型 | |

#### 受注明細

| 項目名 | フィールド名 | データ型 | 登録 | 更新 | 備考 |
| --- | --- | --- | --- | --- | --- |
| 明細行番号 | `receive_order_row_no` | 数値型 | | 必須 | 更新のキーとして利用 空の場合、商品コード＋受注数＋αで明細行を最後尾に登録する |
| 商品コード | `receive_order_row_goods_id` | 文字列型 | 必須 | | 更新不可 登録時のみ必須 メイン機能の商品マスタにない商品は登録できない |
| 商品名 | `receive_order_row_goods_name` | 文字列型 | | | |
| 受注数 | `receive_order_row_quantity` | 数値型 | 必須 | | |
| 単価 | `receive_order_row_unit_price` | 数値型 | | | |
| 消費税率（%） | `receive_order_row_tax_rate` | 数値型 | | | |
| 掛率 | `receive_order_row_wholesale_retail_ratio` | 数値型 | | | |
| 小計金額 | `receive_order_row_sub_total_price` | 数値型 | | | 金額の再計算および整合性チェックはしない 整合性が必要な場合は、アプリ側で計算して設定する |
| 商品OP | `receive_order_row_goods_option` | 文字列型 | | | |
| キャンセルフラグ | `receive_order_row_cancel_flag` | 文字列型 | | | 0：有効 1：キャンセル 明細は削除できない キャンセルフラグを指定してキャンセルにする |


### サンプル

リクエスト

```bash
curl -X POST \ https://api.next-engine.org/api_v1_receiveorder_base/update \ -d 'access_token=xxx&refresh_token=xxx&receive_order_id=1&receive_order_last_modified_date=xxx&data=xxx&receive_order_shipped_update_flag=1'
```

レスポンス

```json
{
  "message": "変更された項目はありませんでした。",
  "result": "success",
  "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"
}
```


## エラー

### エラーコード

エンドポイント固有のエラーコードを以下に示します。
共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。

| エラーコード | メッセージ | 対処方法 |
|---|---|---|
| `011001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります |
| `011002` | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください |
| `011003` | POSTパラメータにdataが指定されていない、または値が空です。 | dataを指定してください |
| `011004` | dataの値を解析できませんでした。正しい形式で指定して下さい。 | dataの形式を修正してください |
| `011005` | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください |
| `011006` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください |
| `011007` | 受注取込中のため、更新出来ません。 | 受注伝票を再検索してAPIを実行してください |
| `011008` | 受注伝票[xxxxxx]は存在しません。 | receive_order_idを確認してください |
| `011009` | [xxxxxx]は受注状態が受注メール取込済の伝票は更新できません。 | 該当項目は受注メール取込済伝票では更新不可です |
| `011010` | 受注状態が出荷確定済の伝票は更新できません。 | 出荷確定済伝票は更新できません |
| `011011` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください |
| `011014` | 更新フィールドが1つも設定されておりません。 | 更新するフィールドを設定してください |
| `011015` | [xxxx]xxxxxxxxxx | フィールド名xxxx についてエラー内容xxを確認してください |
| `011016` | 明細行xx[xxxx]xxxxxxxxxx | 明細行xx のフィールド名xxxx についてエラー内容を確認してください |
| `011017` | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | 受注明細追加の条件を確認してください |
| `011018` | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | 受注伝票と明細の更新条件を確認してください |
| `011019` | xxxx[xx]は、メイン機能に登録されていない値です。 | フィールド名xxxx の値xx を確認してください |
| `011030` | 所属拠点が異なる店舗に変更することはできません。 | 異なる拠点の店舗への変更はできません。複写後キャンセル処理を実施してください |
| `011999` | 更新処理中に例外が発生したため、処理を行いませんでした。 | 処理エラーを確認して対応してください |

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_base_update/`](/openapi/operations/api_v1_receiveorder_base_update/) (OpenAPI 3.1 のインタラクティブ仕様)
- エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味)
- フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目)

### 同じカテゴリの他のエンドポイント (受注伝票)

- [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate`
- [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted`
- [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count`
- [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide`
- [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted`
- [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted`
- [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search`
- [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped`
- [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload`

---

# 受注伝票出荷確定処理
URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/shipped
Tag: 受注伝票
Required parameters: access_token, receive_order_id, receive_order_last_modified_date
Optional parameters: refresh_token, wait_flag, fields, offset, limit

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_receiveorder_base/shipped`

## リファレンス内容


### 出荷確定処理

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。

動作は出荷確定処理と同じで、有効な納品書印刷済みの受注伝票を出荷確定済みにします。

処理結果はレスポンスのステータスコードで確認します。

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| `receive_order_id` | 伝票番号 | 必須 | 出荷確定処理をする受注の伝票番号 |
| `receive_order_last_modified_date` | 最終更新日 | 必須 | 出荷確定処理をする受注の最終更新日。 API実行時にメイン機能またはアプリで、受注伝票が更新されていないかを確認するために利用します。 メイン機能またはアプリで受注伝票が更新されている場合はエラーになります。 エラーになったら再度、受注伝票を検索してAPIを実行して下さい。 |

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
| `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります |
| `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります |

### 出荷確定処理できる条件

以下は[受注伝票](/api/fields/receiveorder_base)の項目になります。

| 項目名 | フィールド名 | 条件 |
| --- | --- | --- |
| 伝票番号 | `receive_order_id` | メイン機能に存在する受注伝票 |
| 受注キャンセル区分 | `receive_order_cancel_type_id` | 0：キャンセルされていない有効な受注伝票 |
| 受注状態区分 | `receive_order_order_status_id` | 20または40：納品書印刷待ちまたは納品書印刷済みの受注伝票 |
| 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 指定されていない、またはAPI実行日以前であること |


### 受注伝票

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 店舗コード | `receive_order_shop_id` | 数値型 | 店舗マスタの店舗コード |
| 伝票番号 | `receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 |
| 受注番号 | `receive_order_shop_cut_form_id` | 文字列型 | 原則、店舗内で一意に付与される番号（重複する可能性あり。） |
| 受注日 | `receive_order_date` | 日時型 | 店舗側で受注した日 |
| 取込日 | `receive_order_import_date` | 日時型 | ネクストエンジンに取り込まれた日 |
| 重要チェック区分 | `receive_order_important_check_id` | 文字列型 | 1:重要 |
| 重要チェック名 | `receive_order_important_check_name` | 文字列型 | 重要チェックを付けた担当者名 |
| 確認チェック区分 | `receive_order_confirm_check_id` | 文字列型 | 0:確認不要1:確認必要2:確認済み |
| 確認チェック名 | `receive_order_confirm_check_name` | 文字列型 | 確認チェックを付けた担当者名 |
| 受注確認内容ID | `receive_order_confirm_ids` | 文字列型 | 受注確認内容IDが":"区切りで設定されます。明細行に対する確認は"#"の後に明細行番号が設定されます。Ex: "AO:AA#1:AA#2"の場合送り先の郵便番号と住所があってません。商品コードが商品マスタに存在しません。：1行目商品コードが商品マスタに存在しません。：2行目 |
| メール送信状態値 | `receive_order_mail_status` | 文字列型 | 次の値によりどの種類のメール送信が終了したかを表します。区切り文字はありません。例えばJHとあれば受注メールと発送完了メールが送信済みです。 J:受注確認メール B:印刷日待ち連絡メール C:印刷待ち以降連絡メール H:発送メール N:入金確認メール F:フォローメール |
| 受注分類タグ | `receive_order_gruoping_tag` | 文字列型 | []区切りでタグの名称が設定されている。受注分類タグ自体の検索には未対応。例:[連絡待ち][ゴールド会員] |
| 取込種類区分 | `receive_order_import_type_id` | 文字列型 | 0:メール1:CSV2:手入力 |
| 取込種類名 | `receive_order_import_type_name` | 文字列型 | |
| 受注キャンセル区分 | `receive_order_cancel_type_id` | 文字列型 | 受注キャンセル区分 |
| 受注キャンセル名 | `receive_order_cancel_type_name` | 文字列型 | |
| 受注キャンセル日 | `receive_order_cancel_date` | 日時型 | |
| 受注状態区分 | `receive_order_order_status_id` | 文字列型 | 受注状態区分 |
| 受注状態名 | `receive_order_order_status_name` | 文字列型 | |
| 発送方法区分 | `receive_order_delivery_id` | 文字列型 | 発送方法区分 |
| 発送方法名 | `receive_order_delivery_name` | 文字列型 | |
| 支払区分 | `receive_order_payment_method_id` | 文字列型 | 支払区分受注伝票の支払方法の値 |
| 支払名 | `receive_order_payment_method_name` | 文字列型 | |
| 総合計 | `receive_order_total_amount` | 数値型 | 商品計+税金+手数料+発送代+他費用-ポイント数 |
| 税金 | `receive_order_tax_amount` | 数値型 | |
| 手数料 | `receive_order_charge_amount` | 数値型 | |
| 発送代 | `receive_order_delivery_fee_amount` | 数値型 | |
| 他費用 | `receive_order_other_amount` | 数値型 | |
| ポイント数 | `receive_order_point_amount` | 数値型 | |
| 商品計 | `receive_order_goods_amount` | 数値型 | |
| 入金額 | `receive_order_deposit_amount` | 文字列型 | |
| 入金状況区分 | `receive_order_deposit_type_id` | 文字列型 | 入金区分 |
| 入金状況名 | `receive_order_deposit_type_name` | 文字列型 | |
| 入金日 | `receive_order_deposit_date` | 日時型 | |
| 備考 | `receive_order_note` | 文字列型 | |
| 同梱候補伝票番号 | `receive_order_include_possible_order_id` | 数値型 | ネクストエンジンが自動判定した同梱候補の伝票番号 |
| 同梱先伝票番号 | `receive_order_include_to_order_id` | 数値型 | 同梱した場合の同梱先の伝票番号 |
| 複数配送親伝票番号 | `receive_order_multi_delivery_parent_order_id` | 数値型 | 複数配送の親の伝票番号 |
| 分割元伝票番号 | `receive_order_divide_from_order_id` | 数値型 | 分割元の伝票番号 |
| 複写元伝票番号 | `receive_order_copy_from_order_id` | 数値型 | 複写元の伝票番号 |
| 複数配送親フラグ | `receive_order_multi_delivery_parent_flag` | 文字列型 | 複数配送の親か否か |
| 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 日時型 | |
| 納品書発行日 | `receive_order_statement_delivery_printing_date` | 日時型 | 納品書をダウンロードした日 |
| 納品書特記事項 | `receive_order_statement_delivery_text` | 文字列型 | |
| 出荷確定日 | `receive_order_send_date` | 日時型 | 受注状態が出荷確定済みになった日 |
| 出荷予定日 | `receive_order_send_plan_date` | 日時型 | |
| 出荷順序 | `receive_order_send_sequence` | 文字列型 | ラベル発行フラグがたった順序 |
| 作業用欄 | `receive_order_worker_text` | 文字列型 | |
| ピッキング指示内容 | `receive_order_picking_instruct` | 文字列型 | |
| ラベル発行日 | `receive_order_label_print_date` | 日時型 | |
| ラベル発行フラグ | `receive_order_label_print_flag` | 文字列型 | 配送伝票の印刷対象か否か0:対象外1:対象2:発行済み |
| 配達希望日 | `receive_order_hope_delivery_date` | 日時型 | |
| 配達希望時間帯区分 | `receive_order_hope_delivery_time_slot_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 配達希望時間帯名 | `receive_order_hope_delivery_time_slot_name` | 文字列型 | |
| 便種区分 | `receive_order_delivery_method_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 便種名 | `receive_order_delivery_method_name` | 文字列型 | |
| シール1区分 | `receive_order_seal1_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール1名 | `receive_order_seal1_name` | 文字列型 | |
| シール2区分 | `receive_order_seal2_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール2名 | `receive_order_seal2_name` | 文字列型 | |
| シール3区分 | `receive_order_seal3_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール3名 | `receive_order_seal3_name` | 文字列型 | |
| シール4区分 | `receive_order_seal4_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール4名 | `receive_order_seal4_name` | 文字列型 | |
| 営業止め区分 | `receive_order_business_office_stop_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 営業止め名 | `receive_order_business_office_stop_name` | 文字列型 | |
| 送り状区分 | `receive_order_invoice_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 送り状名 | `receive_order_invoice_name` | 文字列型 | |
| 温度区分 | `receive_order_temperature_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 温度名 | `receive_order_temperature_name` | 文字列型 | |
| 営業所名 | `receive_order_business_office_name` | 文字列型 | |
| ギフトフラグ | `receive_order_gift_flag` | 文字列型 | 0:ギフトではない1:ギフト |
| 発送伝票番号 | `receive_order_delivery_cut_form_id` | 文字列型 | 各発送方法の問い合わせ番号が設定されます。 |
| 発送伝票備考欄 | `receive_order_delivery_cut_form_note` | 文字列型 | |
| クレジット区分 | `receive_order_credit_type_id` | 文字列型 | クレジット種類区分 |
| クレジット名 | `receive_order_credit_type_name` | 文字列型 | |
| クレジット承認番号 | `receive_order_credit_approval_no` | 文字列型 | |
| クレジット承認額 | `receive_order_credit_approval_amount` | 文字列型 | |
| クレジット承認区分 | `receive_order_credit_approval_type_id` | 文字列型 | クレジット承認区分 |
| クレジット承認名 | `receive_order_credit_approval_type_name` | 文字列型 | |
| クレジット承認日 | `receive_order_credit_approval_date` | 日時型 | |
| クレジット承認時レート | `receive_order_credit_approval_rate` | 数値型 | |
| クレジット支払い回数 | `receive_order_credit_number_payments` | 文字列型 | 受注伝票の支払区分の値 |
| クレジット承認センター区分 | `receive_order_credit_authorization_center_id` | 文字列型 | |
| クレジット承認センター名 | `receive_order_credit_authorization_center_name` | 文字列型 | |
| クレジット承認FAX印刷日 | `receive_order_credit_approval_fax_printing_date` | 日時型 | |
| 顧客区分 | `receive_order_customer_type_id` | 文字列型 | 顧客区分 |
| 顧客名 | `receive_order_customer_type_name` | 文字列型 | |
| 顧客コード | `receive_order_customer_id` | 文字列型 | 顧客区分が9:卸 だった場合に卸先コードが設定されます。 |
| 購入者名 | `receive_order_purchaser_name` | 文字列型 | |
| 購入者カナ | `receive_order_purchaser_kana` | 文字列型 | |
| 購入者郵便番号 | `receive_order_purchaser_zip_code` | 文字列型 | |
| 購入者住所1 | `receive_order_purchaser_address1` | 文字列型 | |
| 購入者住所2 | `receive_order_purchaser_address2` | 文字列型 | |
| 購入者電話番号 | `receive_order_purchaser_tel` | 文字列型 | |
| 購入者FAX | `receive_order_purchaser_fax` | 文字列型 | |
| 購入者メールアドレス | `receive_order_purchaser_mail_address` | 文字列型 | |
| 送り先名 | `receive_order_consignee_name` | 文字列型 | |
| 送り先カナ | `receive_order_consignee_kana` | 文字列型 | |
| 送り先郵便番号 | `receive_order_consignee_zip_code` | 文字列型 | |
| 送り先住所1 | `receive_order_consignee_address1` | 文字列型 | |
| 送り先住所2 | `receive_order_consignee_address2` | 文字列型 | |
| 送り先電話番号 | `receive_order_consignee_tel` | 文字列型 | |
| 送り先FAX | `receive_order_consignee_fax` | 文字列型 | |
| 重要チェック担当者ID | `receive_order_important_check_pic_id` | 数値型 | |
| 重要チェック担当者名 | `receive_order_important_check_pic_name` | 文字列型 | |
| 受注担当者ID | `receive_order_pic_id` | 数値型 | |
| 受注担当者名 | `receive_order_pic_name` | 文字列型 | |
| 出荷担当者ID | `receive_order_send_pic_id` | 数値型 | |
| 出荷担当者名 | `receive_order_send_pic_name` | 文字列型 | |
| 作成日 | `receive_order_creation_date` | 日時型 | |
| 最終更新日 | `receive_order_last_modified_date` | 日時型 | |
| 最終更新日 | `receive_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 |
| 作成担当者ID | `receive_order_creator_id` | 数値型 | |
| 作成担当者名 | `receive_order_creator_name` | 文字列型 | |
| 最終更新者ID | `receive_order_last_modified_by_id` | 数値型 | |
| 最終更新者ID | `receive_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | `receive_order_last_modified_by_name` | 文字列型 | |
| 最終更新者名 | `receive_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 |


 サンプル
### サンプル

リクエスト

```bash
curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_id=7&receive_order_last_modified_date=xxx' \ https://api.next-engine.org/api_v1_receiveorder_base/shipped 
```

レスポンス

```json
{
  "result": "success",
  "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"
}
```


## エラー

### エラーコード

エンドポイント固有のエラーコードを以下に示します。
共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。

| エラーコード | メッセージ | 対処方法 |
|---|---|---|
| `009001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります |
| `009002` | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください |
| `009003` | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください |
| `009004` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください |
| `009005` | 受注取込中のため、更新出来ません。 | しばらく時間を空けて再度APIを実行してください |
| `009006` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください |
| `009007` | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | データの内容を確認して正しい形式に修正してください |

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_base_shipped/`](/openapi/operations/api_v1_receiveorder_base_shipped/) (OpenAPI 3.1 のインタラクティブ仕様)
- エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味)
- フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目)

### 同じカテゴリの他のエンドポイント (受注伝票)

- [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate`
- [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted`
- [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count`
- [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide`
- [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted`
- [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted`
- [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search`
- [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update`
- [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload`

---

# 受注伝票納品書印刷済み
URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/receipted/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/receipted
Tag: 受注伝票
Required parameters: access_token, receive_order_id, receive_order_last_modified_date
Optional parameters: refresh_token, wait_flag, fields, offset, limit, receive_order_label_print_flag

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_receiveorder_base/receipted`

## リファレンス内容


### 納品書印刷済み

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。

有効な納品書印刷待ちの受注伝票を納品書印刷済みにします。

処理結果はレスポンスのステータスコードで確認します。

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| `receive_order_id` | 伝票番号 | 必須 | 納品書印刷済みにする受注の伝票番号 |
| `receive_order_last_modified_date` | 最終更新日 | 必須 | 納品書印刷済みにする受注の最終更新日。 API実行時にメイン機能またはアプリで、受注伝票が更新されていないかを確認するために利用します。 メイン機能またはアプリで受注伝票が更新されている場合はエラーになります。 エラーになったら再度、受注伝票を検索してAPIを実行して下さい。 |
| `receive_order_label_print_flag` | ラベル発行フラグ | 可能 | 1：配送情報出力対象にする上記以外の値は何も処理しません。 |

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
| `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります |
| `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります |

### 納品書印刷済みにできる条件

以下は[受注伝票](/api/fields/receiveorder_base)の項目になります。

| 項目名 | フィールド名 | 条件 |
| --- | --- | --- |
| 伝票番号 | `receive_order_id` | メイン機能に存在する受注伝票 |
| 受注キャンセル区分 | `receive_order_cancel_type_id` | 0：キャンセルされていない有効な受注伝票 |
| 受注状態区分 | `receive_order_order_status_id` | 20：納品書印刷待ちの受注伝票 |
| 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 指定されていない、またはAPI実行日以前であること |
| ラベル発行フラグ | `receive_order_label_print_flag` | ラベル発行フラグが「0」または「1」ただしこの条件は、上記の入力パラメータreceive_order_label_print_flagで「1」を指定した場合のみ有効。 |


### 受注伝票

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 店舗コード | `receive_order_shop_id` | 数値型 | 店舗マスタの店舗コード |
| 伝票番号 | `receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 |
| 受注番号 | `receive_order_shop_cut_form_id` | 文字列型 | 原則、店舗内で一意に付与される番号（重複する可能性あり。） |
| 受注日 | `receive_order_date` | 日時型 | 店舗側で受注した日 |
| 取込日 | `receive_order_import_date` | 日時型 | ネクストエンジンに取り込まれた日 |
| 重要チェック区分 | `receive_order_important_check_id` | 文字列型 | 1:重要 |
| 重要チェック名 | `receive_order_important_check_name` | 文字列型 | 重要チェックを付けた担当者名 |
| 確認チェック区分 | `receive_order_confirm_check_id` | 文字列型 | 0:確認不要1:確認必要2:確認済み |
| 確認チェック名 | `receive_order_confirm_check_name` | 文字列型 | 確認チェックを付けた担当者名 |
| 受注確認内容ID | `receive_order_confirm_ids` | 文字列型 | 受注確認内容IDが":"区切りで設定されます。明細行に対する確認は"#"の後に明細行番号が設定されます。Ex: "AO:AA#1:AA#2"の場合送り先の郵便番号と住所があってません。商品コードが商品マスタに存在しません。：1行目商品コードが商品マスタに存在しません。：2行目 |
| メール送信状態値 | `receive_order_mail_status` | 文字列型 | 次の値によりどの種類のメール送信が終了したかを表します。区切り文字はありません。例えばJHとあれば受注メールと発送完了メールが送信済みです。 J:受注確認メール B:印刷日待ち連絡メール C:印刷待ち以降連絡メール H:発送メール N:入金確認メール F:フォローメール |
| 受注分類タグ | `receive_order_gruoping_tag` | 文字列型 | []区切りでタグの名称が設定されている。受注分類タグ自体の検索には未対応。例:[連絡待ち][ゴールド会員] |
| 取込種類区分 | `receive_order_import_type_id` | 文字列型 | 0:メール1:CSV2:手入力 |
| 取込種類名 | `receive_order_import_type_name` | 文字列型 | |
| 受注キャンセル区分 | `receive_order_cancel_type_id` | 文字列型 | 受注キャンセル区分 |
| 受注キャンセル名 | `receive_order_cancel_type_name` | 文字列型 | |
| 受注キャンセル日 | `receive_order_cancel_date` | 日時型 | |
| 受注状態区分 | `receive_order_order_status_id` | 文字列型 | 受注状態区分 |
| 受注状態名 | `receive_order_order_status_name` | 文字列型 | |
| 発送方法区分 | `receive_order_delivery_id` | 文字列型 | 発送方法区分 |
| 発送方法名 | `receive_order_delivery_name` | 文字列型 | |
| 支払区分 | `receive_order_payment_method_id` | 文字列型 | 支払区分受注伝票の支払方法の値 |
| 支払名 | `receive_order_payment_method_name` | 文字列型 | |
| 総合計 | `receive_order_total_amount` | 数値型 | 商品計+税金+手数料+発送代+他費用-ポイント数 |
| 税金 | `receive_order_tax_amount` | 数値型 | |
| 手数料 | `receive_order_charge_amount` | 数値型 | |
| 発送代 | `receive_order_delivery_fee_amount` | 数値型 | |
| 他費用 | `receive_order_other_amount` | 数値型 | |
| ポイント数 | `receive_order_point_amount` | 数値型 | |
| 商品計 | `receive_order_goods_amount` | 数値型 | |
| 入金額 | `receive_order_deposit_amount` | 文字列型 | |
| 入金状況区分 | `receive_order_deposit_type_id` | 文字列型 | 入金区分 |
| 入金状況名 | `receive_order_deposit_type_name` | 文字列型 | |
| 入金日 | `receive_order_deposit_date` | 日時型 | |
| 備考 | `receive_order_note` | 文字列型 | |
| 同梱候補伝票番号 | `receive_order_include_possible_order_id` | 数値型 | ネクストエンジンが自動判定した同梱候補の伝票番号 |
| 同梱先伝票番号 | `receive_order_include_to_order_id` | 数値型 | 同梱した場合の同梱先の伝票番号 |
| 複数配送親伝票番号 | `receive_order_multi_delivery_parent_order_id` | 数値型 | 複数配送の親の伝票番号 |
| 分割元伝票番号 | `receive_order_divide_from_order_id` | 数値型 | 分割元の伝票番号 |
| 複写元伝票番号 | `receive_order_copy_from_order_id` | 数値型 | 複写元の伝票番号 |
| 複数配送親フラグ | `receive_order_multi_delivery_parent_flag` | 文字列型 | 複数配送の親か否か |
| 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 日時型 | |
| 納品書発行日 | `receive_order_statement_delivery_printing_date` | 日時型 | 納品書をダウンロードした日 |
| 納品書特記事項 | `receive_order_statement_delivery_text` | 文字列型 | |
| 出荷確定日 | `receive_order_send_date` | 日時型 | 受注状態が出荷確定済みになった日 |
| 出荷予定日 | `receive_order_send_plan_date` | 日時型 | |
| 出荷順序 | `receive_order_send_sequence` | 文字列型 | ラベル発行フラグがたった順序 |
| 作業用欄 | `receive_order_worker_text` | 文字列型 | |
| ピッキング指示内容 | `receive_order_picking_instruct` | 文字列型 | |
| ラベル発行日 | `receive_order_label_print_date` | 日時型 | |
| ラベル発行フラグ | `receive_order_label_print_flag` | 文字列型 | 配送伝票の印刷対象か否か0:対象外1:対象2:発行済み |
| 配達希望日 | `receive_order_hope_delivery_date` | 日時型 | |
| 配達希望時間帯区分 | `receive_order_hope_delivery_time_slot_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 配達希望時間帯名 | `receive_order_hope_delivery_time_slot_name` | 文字列型 | |
| 便種区分 | `receive_order_delivery_method_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 便種名 | `receive_order_delivery_method_name` | 文字列型 | |
| シール1区分 | `receive_order_seal1_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール1名 | `receive_order_seal1_name` | 文字列型 | |
| シール2区分 | `receive_order_seal2_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール2名 | `receive_order_seal2_name` | 文字列型 | |
| シール3区分 | `receive_order_seal3_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール3名 | `receive_order_seal3_name` | 文字列型 | |
| シール4区分 | `receive_order_seal4_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール4名 | `receive_order_seal4_name` | 文字列型 | |
| 営業止め区分 | `receive_order_business_office_stop_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 営業止め名 | `receive_order_business_office_stop_name` | 文字列型 | |
| 送り状区分 | `receive_order_invoice_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 送り状名 | `receive_order_invoice_name` | 文字列型 | |
| 温度区分 | `receive_order_temperature_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 温度名 | `receive_order_temperature_name` | 文字列型 | |
| 営業所名 | `receive_order_business_office_name` | 文字列型 | |
| ギフトフラグ | `receive_order_gift_flag` | 文字列型 | 0:ギフトではない1:ギフト |
| 発送伝票番号 | `receive_order_delivery_cut_form_id` | 文字列型 | 各発送方法の問い合わせ番号が設定されます。 |
| 発送伝票備考欄 | `receive_order_delivery_cut_form_note` | 文字列型 | |
| クレジット区分 | `receive_order_credit_type_id` | 文字列型 | クレジット種類区分 |
| クレジット名 | `receive_order_credit_type_name` | 文字列型 | |
| クレジット承認番号 | `receive_order_credit_approval_no` | 文字列型 | |
| クレジット承認額 | `receive_order_credit_approval_amount` | 文字列型 | |
| クレジット承認区分 | `receive_order_credit_approval_type_id` | 文字列型 | クレジット承認区分 |
| クレジット承認名 | `receive_order_credit_approval_type_name` | 文字列型 | |
| クレジット承認日 | `receive_order_credit_approval_date` | 日時型 | |
| クレジット承認時レート | `receive_order_credit_approval_rate` | 数値型 | |
| クレジット支払い回数 | `receive_order_credit_number_payments` | 文字列型 | 受注伝票の支払区分の値 |
| クレジット承認センター区分 | `receive_order_credit_authorization_center_id` | 文字列型 | |
| クレジット承認センター名 | `receive_order_credit_authorization_center_name` | 文字列型 | |
| クレジット承認FAX印刷日 | `receive_order_credit_approval_fax_printing_date` | 日時型 | |
| 顧客区分 | `receive_order_customer_type_id` | 文字列型 | 顧客区分 |
| 顧客名 | `receive_order_customer_type_name` | 文字列型 | |
| 顧客コード | `receive_order_customer_id` | 文字列型 | 顧客区分が9:卸 だった場合に卸先コードが設定されます。 |
| 購入者名 | `receive_order_purchaser_name` | 文字列型 | |
| 購入者カナ | `receive_order_purchaser_kana` | 文字列型 | |
| 購入者郵便番号 | `receive_order_purchaser_zip_code` | 文字列型 | |
| 購入者住所1 | `receive_order_purchaser_address1` | 文字列型 | |
| 購入者住所2 | `receive_order_purchaser_address2` | 文字列型 | |
| 購入者電話番号 | `receive_order_purchaser_tel` | 文字列型 | |
| 購入者FAX | `receive_order_purchaser_fax` | 文字列型 | |
| 購入者メールアドレス | `receive_order_purchaser_mail_address` | 文字列型 | |
| 送り先名 | `receive_order_consignee_name` | 文字列型 | |
| 送り先カナ | `receive_order_consignee_kana` | 文字列型 | |
| 送り先郵便番号 | `receive_order_consignee_zip_code` | 文字列型 | |
| 送り先住所1 | `receive_order_consignee_address1` | 文字列型 | |
| 送り先住所2 | `receive_order_consignee_address2` | 文字列型 | |
| 送り先電話番号 | `receive_order_consignee_tel` | 文字列型 | |
| 送り先FAX | `receive_order_consignee_fax` | 文字列型 | |
| 重要チェック担当者ID | `receive_order_important_check_pic_id` | 数値型 | |
| 重要チェック担当者名 | `receive_order_important_check_pic_name` | 文字列型 | |
| 受注担当者ID | `receive_order_pic_id` | 数値型 | |
| 受注担当者名 | `receive_order_pic_name` | 文字列型 | |
| 出荷担当者ID | `receive_order_send_pic_id` | 数値型 | |
| 出荷担当者名 | `receive_order_send_pic_name` | 文字列型 | |
| 作成日 | `receive_order_creation_date` | 日時型 | |
| 最終更新日 | `receive_order_last_modified_date` | 日時型 | |
| 最終更新日 | `receive_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 |
| 作成担当者ID | `receive_order_creator_id` | 数値型 | |
| 作成担当者名 | `receive_order_creator_name` | 文字列型 | |
| 最終更新者ID | `receive_order_last_modified_by_id` | 数値型 | |
| 最終更新者ID | `receive_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | `receive_order_last_modified_by_name` | 文字列型 | |
| 最終更新者名 | `receive_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 |


 サンプル
### サンプル

リクエスト

```bash
curl -X POST \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_id=xxx&receive_order_last_modified_date=xxx&receive_order_label_print_flag=1' \ https://api.next-engine.org/api_v1_receiveorder_base/receipted
```

レスポンス

```json
{
  "result": "success",
  "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"
}
```


## エラー

### エラーコード

エンドポイント固有のエラーコードを以下に示します。
共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。

| エラーコード | メッセージ | 対処方法 |
|---|---|---|
| `008001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります |
| `008002` | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください |
| `008003` | 受注取込中のため、更新出来ません。 | しばらく時間を空けて再度APIを実行してください |
| `008004` | 受注伝票[xxxxxx]は存在しません。 | receive_order_idを確認してください |
| `008005` | 受注伝票[xxxxxx]は納品書印刷待ちではありません。 | 伝票の状態を確認してください |
| `008006` | 受注伝票[xxxxxx]は有効ではありません。キャンセルされてます。 | キャンセルされた伝票は処理できません |
| `008007` | 納品書印刷中の伝票があります。時間を空けて再度APIを実行して下さい。 | 納品書印刷処理終了後に実行してください |
| `008008` | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください |
| `008009` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください |
| `008010` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください |
| `008011` | 納品書印刷指示日[YYYY/MM/DD]が指定されてます。納品書印刷指示日がAPI実行日以前でない場合は更新できません。 | 納品書印刷指示日をAPI実行日以前に設定するか、設定を解除してください |
| `008013` | 受注伝票[xxxxxx]は配送情報出力済みです。 | 配送情報出力済みの伝票は処理できません |
| `008999` | 更新処理中に例外が発生したため、処理を行いませんでした。xxxxxx | 例外内容を確認して対応してください |

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_base_receipted/`](/openapi/operations/api_v1_receiveorder_base_receipted/) (OpenAPI 3.1 のインタラクティブ仕様)
- エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味)
- フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目)

### 同じカテゴリの他のエンドポイント (受注伝票)

- [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate`
- [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted`
- [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count`
- [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide`
- [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted`
- [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search`
- [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped`
- [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update`
- [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload`

---

# 受注伝票配送情報出力済み
URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/labelprinted/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/labelprinted
Tag: 受注伝票
Required parameters: access_token, receive_order_id, receive_order_last_modified_date
Optional parameters: refresh_token, wait_flag, fields, offset, limit, receive_order_label_print_flag

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_receiveorder_base/labelprinted`

## リファレンス内容


### 配送情報出力済み

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。

有効な受注伝票の配送情報ステータスを出力済みにします。

処理結果はレスポンスのステータスコードで確認します。

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| `receive_order_id` | 伝票番号 | 必須 | 配送情報出力済みにする受注の伝票番号 |
| `receive_order_last_modified_date` | 最終更新日 | 必須 | 配送情報出力済みにする受注の最終更新日。 API実行時にメイン機能またはアプリで、受注伝票が更新されていないかを確認するために利用します。 メイン機能またはアプリで受注伝票が更新されている場合はエラーになります。 エラーになったら再度、受注伝票を検索してAPIを実行して下さい。 |
| `receive_order_label_print_flag` | ラベル発行フラグ | | 1：配送情報出力対象にする2：配送情報出力済みにするパラメータが無い場合は「2：配送情報出力済みにする」として処理します。 |

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
| `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります |
| `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります |

### 出力済みにできる条件

以下は[受注伝票](/api/fields/receiveorder_base)の項目になります。

| 項目名 | フィールド名 | 条件 |
| --- | --- | --- |
| 伝票番号 | `receive_order_id` | メイン機能に存在する受注伝票 |
| 受注キャンセル区分 | `receive_order_cancel_type_id` | 0：キャンセルされていない有効な受注伝票 |
| ラベル発行フラグ | `receive_order_label_print_flag` | 0：配送情報出力対象にする1：配送情報出力済みにする |


### 受注伝票

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 店舗コード | `receive_order_shop_id` | 数値型 | 店舗マスタの店舗コード |
| 伝票番号 | `receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 |
| 受注番号 | `receive_order_shop_cut_form_id` | 文字列型 | 原則、店舗内で一意に付与される番号（重複する可能性あり。） |
| 受注日 | `receive_order_date` | 日時型 | 店舗側で受注した日 |
| 取込日 | `receive_order_import_date` | 日時型 | ネクストエンジンに取り込まれた日 |
| 重要チェック区分 | `receive_order_important_check_id` | 文字列型 | 1:重要 |
| 重要チェック名 | `receive_order_important_check_name` | 文字列型 | 重要チェックを付けた担当者名 |
| 確認チェック区分 | `receive_order_confirm_check_id` | 文字列型 | 0:確認不要1:確認必要2:確認済み |
| 確認チェック名 | `receive_order_confirm_check_name` | 文字列型 | 確認チェックを付けた担当者名 |
| 受注確認内容ID | `receive_order_confirm_ids` | 文字列型 | 受注確認内容IDが":"区切りで設定されます。明細行に対する確認は"#"の後に明細行番号が設定されます。Ex: "AO:AA#1:AA#2"の場合送り先の郵便番号と住所があってません。商品コードが商品マスタに存在しません。：1行目商品コードが商品マスタに存在しません。：2行目 |
| メール送信状態値 | `receive_order_mail_status` | 文字列型 | 次の値によりどの種類のメール送信が終了したかを表します。区切り文字はありません。例えばJHとあれば受注メールと発送完了メールが送信済みです。 J:受注確認メール B:印刷日待ち連絡メール C:印刷待ち以降連絡メール H:発送メール N:入金確認メール F:フォローメール |
| 受注分類タグ | `receive_order_gruoping_tag` | 文字列型 | []区切りでタグの名称が設定されている。受注分類タグ自体の検索には未対応。例:[連絡待ち][ゴールド会員] |
| 取込種類区分 | `receive_order_import_type_id` | 文字列型 | 0:メール1:CSV2:手入力 |
| 取込種類名 | `receive_order_import_type_name` | 文字列型 | |
| 受注キャンセル区分 | `receive_order_cancel_type_id` | 文字列型 | 受注キャンセル区分 |
| 受注キャンセル名 | `receive_order_cancel_type_name` | 文字列型 | |
| 受注キャンセル日 | `receive_order_cancel_date` | 日時型 | |
| 受注状態区分 | `receive_order_order_status_id` | 文字列型 | 受注状態区分 |
| 受注状態名 | `receive_order_order_status_name` | 文字列型 | |
| 発送方法区分 | `receive_order_delivery_id` | 文字列型 | 発送方法区分 |
| 発送方法名 | `receive_order_delivery_name` | 文字列型 | |
| 支払区分 | `receive_order_payment_method_id` | 文字列型 | 支払区分受注伝票の支払方法の値 |
| 支払名 | `receive_order_payment_method_name` | 文字列型 | |
| 総合計 | `receive_order_total_amount` | 数値型 | 商品計+税金+手数料+発送代+他費用-ポイント数 |
| 税金 | `receive_order_tax_amount` | 数値型 | |
| 手数料 | `receive_order_charge_amount` | 数値型 | |
| 発送代 | `receive_order_delivery_fee_amount` | 数値型 | |
| 他費用 | `receive_order_other_amount` | 数値型 | |
| ポイント数 | `receive_order_point_amount` | 数値型 | |
| 商品計 | `receive_order_goods_amount` | 数値型 | |
| 入金額 | `receive_order_deposit_amount` | 文字列型 | |
| 入金状況区分 | `receive_order_deposit_type_id` | 文字列型 | 入金区分 |
| 入金状況名 | `receive_order_deposit_type_name` | 文字列型 | |
| 入金日 | `receive_order_deposit_date` | 日時型 | |
| 備考 | `receive_order_note` | 文字列型 | |
| 同梱候補伝票番号 | `receive_order_include_possible_order_id` | 数値型 | ネクストエンジンが自動判定した同梱候補の伝票番号 |
| 同梱先伝票番号 | `receive_order_include_to_order_id` | 数値型 | 同梱した場合の同梱先の伝票番号 |
| 複数配送親伝票番号 | `receive_order_multi_delivery_parent_order_id` | 数値型 | 複数配送の親の伝票番号 |
| 分割元伝票番号 | `receive_order_divide_from_order_id` | 数値型 | 分割元の伝票番号 |
| 複写元伝票番号 | `receive_order_copy_from_order_id` | 数値型 | 複写元の伝票番号 |
| 複数配送親フラグ | `receive_order_multi_delivery_parent_flag` | 文字列型 | 複数配送の親か否か |
| 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 日時型 | |
| 納品書発行日 | `receive_order_statement_delivery_printing_date` | 日時型 | 納品書をダウンロードした日 |
| 納品書特記事項 | `receive_order_statement_delivery_text` | 文字列型 | |
| 出荷確定日 | `receive_order_send_date` | 日時型 | 受注状態が出荷確定済みになった日 |
| 出荷予定日 | `receive_order_send_plan_date` | 日時型 | |
| 出荷順序 | `receive_order_send_sequence` | 文字列型 | ラベル発行フラグがたった順序 |
| 作業用欄 | `receive_order_worker_text` | 文字列型 | |
| ピッキング指示内容 | `receive_order_picking_instruct` | 文字列型 | |
| ラベル発行日 | `receive_order_label_print_date` | 日時型 | |
| ラベル発行フラグ | `receive_order_label_print_flag` | 文字列型 | 配送伝票の印刷対象か否か0:対象外1:対象2:発行済み |
| 配達希望日 | `receive_order_hope_delivery_date` | 日時型 | |
| 配達希望時間帯区分 | `receive_order_hope_delivery_time_slot_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 配達希望時間帯名 | `receive_order_hope_delivery_time_slot_name` | 文字列型 | |
| 便種区分 | `receive_order_delivery_method_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 便種名 | `receive_order_delivery_method_name` | 文字列型 | |
| シール1区分 | `receive_order_seal1_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール1名 | `receive_order_seal1_name` | 文字列型 | |
| シール2区分 | `receive_order_seal2_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール2名 | `receive_order_seal2_name` | 文字列型 | |
| シール3区分 | `receive_order_seal3_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール3名 | `receive_order_seal3_name` | 文字列型 | |
| シール4区分 | `receive_order_seal4_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール4名 | `receive_order_seal4_name` | 文字列型 | |
| 営業止め区分 | `receive_order_business_office_stop_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 営業止め名 | `receive_order_business_office_stop_name` | 文字列型 | |
| 送り状区分 | `receive_order_invoice_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 送り状名 | `receive_order_invoice_name` | 文字列型 | |
| 温度区分 | `receive_order_temperature_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 温度名 | `receive_order_temperature_name` | 文字列型 | |
| 営業所名 | `receive_order_business_office_name` | 文字列型 | |
| ギフトフラグ | `receive_order_gift_flag` | 文字列型 | 0:ギフトではない1:ギフト |
| 発送伝票番号 | `receive_order_delivery_cut_form_id` | 文字列型 | 各発送方法の問い合わせ番号が設定されます。 |
| 発送伝票備考欄 | `receive_order_delivery_cut_form_note` | 文字列型 | |
| クレジット区分 | `receive_order_credit_type_id` | 文字列型 | クレジット種類区分 |
| クレジット名 | `receive_order_credit_type_name` | 文字列型 | |
| クレジット承認番号 | `receive_order_credit_approval_no` | 文字列型 | |
| クレジット承認額 | `receive_order_credit_approval_amount` | 文字列型 | |
| クレジット承認区分 | `receive_order_credit_approval_type_id` | 文字列型 | クレジット承認区分 |
| クレジット承認名 | `receive_order_credit_approval_type_name` | 文字列型 | |
| クレジット承認日 | `receive_order_credit_approval_date` | 日時型 | |
| クレジット承認時レート | `receive_order_credit_approval_rate` | 数値型 | |
| クレジット支払い回数 | `receive_order_credit_number_payments` | 文字列型 | 受注伝票の支払区分の値 |
| クレジット承認センター区分 | `receive_order_credit_authorization_center_id` | 文字列型 | |
| クレジット承認センター名 | `receive_order_credit_authorization_center_name` | 文字列型 | |
| クレジット承認FAX印刷日 | `receive_order_credit_approval_fax_printing_date` | 日時型 | |
| 顧客区分 | `receive_order_customer_type_id` | 文字列型 | 顧客区分 |
| 顧客名 | `receive_order_customer_type_name` | 文字列型 | |
| 顧客コード | `receive_order_customer_id` | 文字列型 | 顧客区分が9:卸 だった場合に卸先コードが設定されます。 |
| 購入者名 | `receive_order_purchaser_name` | 文字列型 | |
| 購入者カナ | `receive_order_purchaser_kana` | 文字列型 | |
| 購入者郵便番号 | `receive_order_purchaser_zip_code` | 文字列型 | |
| 購入者住所1 | `receive_order_purchaser_address1` | 文字列型 | |
| 購入者住所2 | `receive_order_purchaser_address2` | 文字列型 | |
| 購入者電話番号 | `receive_order_purchaser_tel` | 文字列型 | |
| 購入者FAX | `receive_order_purchaser_fax` | 文字列型 | |
| 購入者メールアドレス | `receive_order_purchaser_mail_address` | 文字列型 | |
| 送り先名 | `receive_order_consignee_name` | 文字列型 | |
| 送り先カナ | `receive_order_consignee_kana` | 文字列型 | |
| 送り先郵便番号 | `receive_order_consignee_zip_code` | 文字列型 | |
| 送り先住所1 | `receive_order_consignee_address1` | 文字列型 | |
| 送り先住所2 | `receive_order_consignee_address2` | 文字列型 | |
| 送り先電話番号 | `receive_order_consignee_tel` | 文字列型 | |
| 送り先FAX | `receive_order_consignee_fax` | 文字列型 | |
| 重要チェック担当者ID | `receive_order_important_check_pic_id` | 数値型 | |
| 重要チェック担当者名 | `receive_order_important_check_pic_name` | 文字列型 | |
| 受注担当者ID | `receive_order_pic_id` | 数値型 | |
| 受注担当者名 | `receive_order_pic_name` | 文字列型 | |
| 出荷担当者ID | `receive_order_send_pic_id` | 数値型 | |
| 出荷担当者名 | `receive_order_send_pic_name` | 文字列型 | |
| 作成日 | `receive_order_creation_date` | 日時型 | |
| 最終更新日 | `receive_order_last_modified_date` | 日時型 | |
| 最終更新日 | `receive_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 |
| 作成担当者ID | `receive_order_creator_id` | 数値型 | |
| 作成担当者名 | `receive_order_creator_name` | 文字列型 | |
| 最終更新者ID | `receive_order_last_modified_by_id` | 数値型 | |
| 最終更新者ID | `receive_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | `receive_order_last_modified_by_name` | 文字列型 | |
| 最終更新者名 | `receive_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 |


 サンプル
### サンプル

リクエスト

```bash
curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xx&wait_flag=1&receive_order_id=xxx&receive_order_last_modified_date=xxx&receive_order_label_print_flag=1' \ https://api.next-engine.org/api_v1_receiveorder_base/labelprinted 
```

レスポンス

```json
{
  "result": "success",
  "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"
}
```


## エラー

### エラーコード

エンドポイント固有のエラーコードを以下に示します。
共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。

| エラーコード | メッセージ | 対処方法 |
|---|---|---|
| `010001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります |
| `010002` | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください |
| `010003` | 受注取込中のため、更新出来ません。 | しばらく時間を空けて再度APIを実行してください |
| `010004` | 受注伝票[xxxxxx]は存在しません。 | receive_order_idを確認してください |
| `010005` | 受注伝票[xxxxxx]は有効ではありません。キャンセルされてます。 | キャンセルされた伝票は処理できません |
| `010006` | 受注伝票[xxxxxx]は配送情報出力済みです。 | 既に出力済みの伝票は処理できません |
| `010007` | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください |
| `010008` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください |
| `010009` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください |
| `010010` | receive_order_label_print_flag[xxxxxx]は不正な値です。 | 1または2の値を指定してください |
| `010012` | 受注伝票[xxxxxx]は配送情報出力済みに出来る状態ではありません。 | 配送情報出力対象の伝票のみ変更可能です |
| `010999` | 更新処理中に例外が発生したため、処理を行いませんでした。xxxxxx | 例外内容を確認して対応してください |

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_base_labelprinted/`](/openapi/operations/api_v1_receiveorder_base_labelprinted/) (OpenAPI 3.1 のインタラクティブ仕様)
- エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味)
- フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目)

### 同じカテゴリの他のエンドポイント (受注伝票)

- [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate`
- [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted`
- [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count`
- [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide`
- [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted`
- [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search`
- [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped`
- [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update`
- [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload`

---

# 受注伝票分割
URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/divide/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/divide
Tag: 受注伝票
Required parameters: access_token, receive_order_id, receive_order_last_modified_date, data
Optional parameters: refresh_token, wait_flag, fields, offset, limit, credit_unauthorized_flag

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_receiveorder_base/divide`

## リファレンス内容


### 索引

- 受注伝票分割
- 入力パラメータ
- 出力パラメータ
- XML形式

### 受注伝票分割

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。

動作は分割処理と同じで、受注伝票をパラメータで指定した値で分割処理します。

処理結果はレスポンスのステータスコードで確認します。

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| `receive_order_id` | 伝票番号 | 必須 | 分割する受注の伝票番号 |
| `receive_order_last_modified_date` | 最終更新日 | 必須 | 分割する受注の最終更新日 API実行時にメイン機能またはアプリで、受注伝票が更新されていないかを確認するために利用します メイン機能またはアプリで受注伝票が更新されている場合はエラーになります エラーになったら再度、受注伝票を検索してAPIを実行して下さい |
| `data` | 更新するデータ | 必須 | XML形式で指定します [形式はこちら](#xml形式)を参照 |
| `credit_unauthorized_flag` | 1:条件を満たす場合（備考欄参照）、分割先・分割元ともに、受注伝票の請求情報を「未承認の状態(※1)」にする。1以外:分割元伝票の請求情報はそのまま、分割先伝票も分割元から請求情報を引き継ぐ。 | 可能(省略時は1以外とする) | 1で、次の条件を全て満たす場合、「未承認の状態(※1)」にする。 オーソリ区分ID(shop_authorization_type_id)=0 支払区分(receive_order_payment_method_id)=[0:クレジット] クレジット承認区分(receive_order_credit_approval_type_id) が [20:承認中]以上。 |

**※1 未承認の状態**

- 入金日(receive_order_deposit_date)=空
- 入金状況区分(receive_order_deposit_type_id)=[0:未入金]
- 入金額(receive_order_deposit_amount)=0
- クレジット承認区分(receive_order_credit_approval_type_id)=[10:未承認]
- クレジット承認額(receive_order_credit_approval_amount)=0
- クレジット承認日(receive_order_credit_approval_date)=空
- クレジット承認センター区分(receive_order_credit_authorization_center_id)=空
- クレジット承認FAX印刷日(receive_order_credit_approval_fax_printing_date)=空

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `result` | `success` | 成功時以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
| `receive_order_id` | 分割先の伝票番号 | |
| `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります |
| `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります |

### XML形式

入力パラメータのdataで指定する値です。 

 分割先の明細行、受注数を指定します。 

 引当数・予約引当数の指定は出来ません。分割元から引当数・予約引当数が割り当てられ、余った値が分割先の引当数・予約引当数となります。 

 有効な明細行のみを全て、明細行順に指定してください。 

 完成サンプルは[こちら](/api/fields/create_shop_sample)を参照。

| 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 |
| --- | --- | --- | --- | --- | --- |
| 1 | <root> | ○ | | | |
| 2 | <receiveorder_row> | ○ | | | 受注明細の項目を指定する要素 |
| 3 | <receive_order_row_no> | | ○ | `value` | 属性に更新対象の明細行を指定します更新する明細行が複数ある場合はその分、要素を繰り返します |
| 4 | <receive_order_row_quantity> | ○ | | | 分割先の受注数を正の整数で指定します |
| 3 | </receive_order_row_no> | | | | |
| 2 | </receiveorder_row> | | | | |
| 1 | </root> | ○ | | | |

XML完成サンプル（有効な受注明細行のみを、受注明細行順に全て指定する）

```xml
<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder_row>
 <receive_order_row_no value="2">
 <receive_order_row_quantity>1</receive_order_row_quantity>
 </receive_order_row_no>
 <receive_order_row_no value="4">
 <receive_order_row_quantity>0</receive_order_row_quantity>
 </receive_order_row_no>
 <receive_order_row_no value="5">
 <receive_order_row_quantity>0</receive_order_row_quantity>
 </receive_order_row_no>
 </receiveorder_row>
</root>
```


### 受注伝票

| 項目名 | フィールド名 | データ型 | 備考 |
| --- | --- | --- | --- |
| 店舗コード | `receive_order_shop_id` | 数値型 | 店舗マスタの店舗コード |
| 伝票番号 | `receive_order_id` | 数値型 | ネクストエンジン内で一意に付与される番号 |
| 受注番号 | `receive_order_shop_cut_form_id` | 文字列型 | 原則、店舗内で一意に付与される番号（重複する可能性あり。） |
| 受注日 | `receive_order_date` | 日時型 | 店舗側で受注した日 |
| 取込日 | `receive_order_import_date` | 日時型 | ネクストエンジンに取り込まれた日 |
| 重要チェック区分 | `receive_order_important_check_id` | 文字列型 | 1:重要 |
| 重要チェック名 | `receive_order_important_check_name` | 文字列型 | 重要チェックを付けた担当者名 |
| 確認チェック区分 | `receive_order_confirm_check_id` | 文字列型 | 0:確認不要1:確認必要2:確認済み |
| 確認チェック名 | `receive_order_confirm_check_name` | 文字列型 | 確認チェックを付けた担当者名 |
| 受注確認内容ID | `receive_order_confirm_ids` | 文字列型 | 受注確認内容IDが":"区切りで設定されます。明細行に対する確認は"#"の後に明細行番号が設定されます。Ex: "AO:AA#1:AA#2"の場合送り先の郵便番号と住所があってません。商品コードが商品マスタに存在しません。：1行目商品コードが商品マスタに存在しません。：2行目 |
| メール送信状態値 | `receive_order_mail_status` | 文字列型 | 次の値によりどの種類のメール送信が終了したかを表します。区切り文字はありません。例えばJHとあれば受注メールと発送完了メールが送信済みです。 J:受注確認メール B:印刷日待ち連絡メール C:印刷待ち以降連絡メール H:発送メール N:入金確認メール F:フォローメール |
| 受注分類タグ | `receive_order_gruoping_tag` | 文字列型 | []区切りでタグの名称が設定されている。受注分類タグ自体の検索には未対応。例:[連絡待ち][ゴールド会員] |
| 取込種類区分 | `receive_order_import_type_id` | 文字列型 | 0:メール1:CSV2:手入力 |
| 取込種類名 | `receive_order_import_type_name` | 文字列型 | |
| 受注キャンセル区分 | `receive_order_cancel_type_id` | 文字列型 | 受注キャンセル区分 |
| 受注キャンセル名 | `receive_order_cancel_type_name` | 文字列型 | |
| 受注キャンセル日 | `receive_order_cancel_date` | 日時型 | |
| 受注状態区分 | `receive_order_order_status_id` | 文字列型 | 受注状態区分 |
| 受注状態名 | `receive_order_order_status_name` | 文字列型 | |
| 発送方法区分 | `receive_order_delivery_id` | 文字列型 | 発送方法区分 |
| 発送方法名 | `receive_order_delivery_name` | 文字列型 | |
| 支払区分 | `receive_order_payment_method_id` | 文字列型 | 支払区分受注伝票の支払方法の値 |
| 支払名 | `receive_order_payment_method_name` | 文字列型 | |
| 総合計 | `receive_order_total_amount` | 数値型 | 商品計+税金+手数料+発送代+他費用-ポイント数 |
| 税金 | `receive_order_tax_amount` | 数値型 | |
| 手数料 | `receive_order_charge_amount` | 数値型 | |
| 発送代 | `receive_order_delivery_fee_amount` | 数値型 | |
| 他費用 | `receive_order_other_amount` | 数値型 | |
| ポイント数 | `receive_order_point_amount` | 数値型 | |
| 商品計 | `receive_order_goods_amount` | 数値型 | |
| 入金額 | `receive_order_deposit_amount` | 文字列型 | |
| 入金状況区分 | `receive_order_deposit_type_id` | 文字列型 | 入金区分 |
| 入金状況名 | `receive_order_deposit_type_name` | 文字列型 | |
| 入金日 | `receive_order_deposit_date` | 日時型 | |
| 備考 | `receive_order_note` | 文字列型 | |
| 同梱候補伝票番号 | `receive_order_include_possible_order_id` | 数値型 | ネクストエンジンが自動判定した同梱候補の伝票番号 |
| 同梱先伝票番号 | `receive_order_include_to_order_id` | 数値型 | 同梱した場合の同梱先の伝票番号 |
| 複数配送親伝票番号 | `receive_order_multi_delivery_parent_order_id` | 数値型 | 複数配送の親の伝票番号 |
| 分割元伝票番号 | `receive_order_divide_from_order_id` | 数値型 | 分割元の伝票番号 |
| 複写元伝票番号 | `receive_order_copy_from_order_id` | 数値型 | 複写元の伝票番号 |
| 複数配送親フラグ | `receive_order_multi_delivery_parent_flag` | 文字列型 | 複数配送の親か否か |
| 納品書印刷指示日 | `receive_order_statement_delivery_instruct_printing_date` | 日時型 | |
| 納品書発行日 | `receive_order_statement_delivery_printing_date` | 日時型 | 納品書をダウンロードした日 |
| 納品書特記事項 | `receive_order_statement_delivery_text` | 文字列型 | |
| 出荷確定日 | `receive_order_send_date` | 日時型 | 受注状態が出荷確定済みになった日 |
| 出荷予定日 | `receive_order_send_plan_date` | 日時型 | |
| 出荷順序 | `receive_order_send_sequence` | 文字列型 | ラベル発行フラグがたった順序 |
| 作業用欄 | `receive_order_worker_text` | 文字列型 | |
| ピッキング指示内容 | `receive_order_picking_instruct` | 文字列型 | |
| ラベル発行日 | `receive_order_label_print_date` | 日時型 | |
| ラベル発行フラグ | `receive_order_label_print_flag` | 文字列型 | 配送伝票の印刷対象か否か0:対象外1:対象2:発行済み |
| 配達希望日 | `receive_order_hope_delivery_date` | 日時型 | |
| 配達希望時間帯区分 | `receive_order_hope_delivery_time_slot_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 配達希望時間帯名 | `receive_order_hope_delivery_time_slot_name` | 文字列型 | |
| 便種区分 | `receive_order_delivery_method_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 便種名 | `receive_order_delivery_method_name` | 文字列型 | |
| シール1区分 | `receive_order_seal1_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール1名 | `receive_order_seal1_name` | 文字列型 | |
| シール2区分 | `receive_order_seal2_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール2名 | `receive_order_seal2_name` | 文字列型 | |
| シール3区分 | `receive_order_seal3_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール3名 | `receive_order_seal3_name` | 文字列型 | |
| シール4区分 | `receive_order_seal4_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| シール4名 | `receive_order_seal4_name` | 文字列型 | |
| 営業止め区分 | `receive_order_business_office_stop_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 営業止め名 | `receive_order_business_office_stop_name` | 文字列型 | |
| 送り状区分 | `receive_order_invoice_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 送り状名 | `receive_order_invoice_name` | 文字列型 | |
| 温度区分 | `receive_order_temperature_id` | 文字列型 | 指定の発送方法の伝票印字ソフト用の値が設定されます。 |
| 温度名 | `receive_order_temperature_name` | 文字列型 | |
| 営業所名 | `receive_order_business_office_name` | 文字列型 | |
| ギフトフラグ | `receive_order_gift_flag` | 文字列型 | 0:ギフトではない1:ギフト |
| 発送伝票番号 | `receive_order_delivery_cut_form_id` | 文字列型 | 各発送方法の問い合わせ番号が設定されます。 |
| 発送伝票備考欄 | `receive_order_delivery_cut_form_note` | 文字列型 | |
| クレジット区分 | `receive_order_credit_type_id` | 文字列型 | クレジット種類区分 |
| クレジット名 | `receive_order_credit_type_name` | 文字列型 | |
| クレジット承認番号 | `receive_order_credit_approval_no` | 文字列型 | |
| クレジット承認額 | `receive_order_credit_approval_amount` | 文字列型 | |
| クレジット承認区分 | `receive_order_credit_approval_type_id` | 文字列型 | クレジット承認区分 |
| クレジット承認名 | `receive_order_credit_approval_type_name` | 文字列型 | |
| クレジット承認日 | `receive_order_credit_approval_date` | 日時型 | |
| クレジット承認時レート | `receive_order_credit_approval_rate` | 数値型 | |
| クレジット支払い回数 | `receive_order_credit_number_payments` | 文字列型 | 受注伝票の支払区分の値 |
| クレジット承認センター区分 | `receive_order_credit_authorization_center_id` | 文字列型 | |
| クレジット承認センター名 | `receive_order_credit_authorization_center_name` | 文字列型 | |
| クレジット承認FAX印刷日 | `receive_order_credit_approval_fax_printing_date` | 日時型 | |
| 顧客区分 | `receive_order_customer_type_id` | 文字列型 | 顧客区分 |
| 顧客名 | `receive_order_customer_type_name` | 文字列型 | |
| 顧客コード | `receive_order_customer_id` | 文字列型 | 顧客区分が9:卸 だった場合に卸先コードが設定されます。 |
| 購入者名 | `receive_order_purchaser_name` | 文字列型 | |
| 購入者カナ | `receive_order_purchaser_kana` | 文字列型 | |
| 購入者郵便番号 | `receive_order_purchaser_zip_code` | 文字列型 | |
| 購入者住所1 | `receive_order_purchaser_address1` | 文字列型 | |
| 購入者住所2 | `receive_order_purchaser_address2` | 文字列型 | |
| 購入者電話番号 | `receive_order_purchaser_tel` | 文字列型 | |
| 購入者FAX | `receive_order_purchaser_fax` | 文字列型 | |
| 購入者メールアドレス | `receive_order_purchaser_mail_address` | 文字列型 | |
| 送り先名 | `receive_order_consignee_name` | 文字列型 | |
| 送り先カナ | `receive_order_consignee_kana` | 文字列型 | |
| 送り先郵便番号 | `receive_order_consignee_zip_code` | 文字列型 | |
| 送り先住所1 | `receive_order_consignee_address1` | 文字列型 | |
| 送り先住所2 | `receive_order_consignee_address2` | 文字列型 | |
| 送り先電話番号 | `receive_order_consignee_tel` | 文字列型 | |
| 送り先FAX | `receive_order_consignee_fax` | 文字列型 | |
| 重要チェック担当者ID | `receive_order_important_check_pic_id` | 数値型 | |
| 重要チェック担当者名 | `receive_order_important_check_pic_name` | 文字列型 | |
| 受注担当者ID | `receive_order_pic_id` | 数値型 | |
| 受注担当者名 | `receive_order_pic_name` | 文字列型 | |
| 出荷担当者ID | `receive_order_send_pic_id` | 数値型 | |
| 出荷担当者名 | `receive_order_send_pic_name` | 文字列型 | |
| 作成日 | `receive_order_creation_date` | 日時型 | |
| 最終更新日 | `receive_order_last_modified_date` | 日時型 | |
| 最終更新日 | `receive_order_last_modified_null_safe_date` | 日時型 | NULLの場合作成日 |
| 作成担当者ID | `receive_order_creator_id` | 数値型 | |
| 作成担当者名 | `receive_order_creator_name` | 文字列型 | |
| 最終更新者ID | `receive_order_last_modified_by_id` | 数値型 | |
| 最終更新者ID | `receive_order_last_modified_by_null_safe_id` | 数値型 | NULLの場合作成者ID |
| 最終更新者名 | `receive_order_last_modified_by_name` | 文字列型 | |
| 最終更新者名 | `receive_order_last_modified_by_null_safe_name` | 文字列型 | NULLの場合作成者名 |


 サンプル
### サンプル

リクエスト

```bash
curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&receive_order_id=xxx&receive_order_last_modified_date=xxx&data=xxx&credit_unauthorized_flag=1' \ https://api.next-engine.org/api_v1_receiveorder_base/divide 
```

レスポンス

```json
{
  "receive_order_id": "xxx",
  "result": "success",
  "access_token": "xxx",
  "access_token_end_date": "2017-04-19 11:21:13",
  "refresh_token": "xxx",
  "refresh_token_end_date": "2017-04-21 11:21:13"
}
```


## エラー

### エラーコード

エンドポイント固有のエラーコードを以下に示します。
共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。

| エラーコード | メッセージ | 対処方法 |
|---|---|---|
| `016001` | アクセス情報[_xxxxxx_]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります |
| `016002` | POSTパラメータにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください |
| `016003` | POSTパラメータにdataが指定されていない、または値が空です。 | dataを指定してください |
| `016004` | dataの値を解析できませんでした。正しい形式で指定して下さい。 | dataの形式を修正してください |
| `016005` | POSTパラメータにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください |
| `016006` | 受注伝票[xxxxxx]は存在しません。 | receive_order_idを確認してください |
| `016007` | 受注状態が受注メール取込済の伝票は更新できません。 | 受注メール取込済伝票は分割できません |
| `016008` | 受注状態が取込情報不足の伝票は更新できません。 | 取込情報不足の伝票は分割できません |
| `016009` | 受注状態が出荷確定済の伝票は更新できません。 | 出荷確定済伝票は分割できません |
| `016010` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください |
| `016011` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください |
| `016012` | dataにreceiveorder_rowタグが設定されておりません。 | receiveorder_rowタグを設定してください |
| `016013` | receiveorder_rowに更新フィールドが設定されておりません。 | receiveorder_rowタグに更新フィールドを設定してください |
| `016014` | receive_order_row_noタグのvalue属性の値[xxxxxx]は0より大きい整数を指定してください。 | 0より大きい整数値を指定してください |
| `016015` | dataにreceive_order_row_quantityタグが設定されておりません。receive_order_row_no[xxxxxx] | receive_order_row_quantityタグを設定してください |
| `016016` | receive_order_row_noタグ内のreceive_order_row_quantityタグの値[xxxxxx]は0以上の整数を指定してください。 | 0以上の整数値を指定してください |
| `016017` | 分割先の受注数に全て0が指定されているため、分割できません。 | 0以外の分割数を指定してください |
| `016018` | 有効な受注明細行とdataで指定した受注明細行が一致しません。有効な受注明細行のみを全て指定してください。 | 有効な全ての明細行を指定してください |
| `016019` | 有効でない受注明細行の指定があるか、受注明細行の並び順が昇順ではありません。 | 有効な明細行を昇順で指定してください |
| `016020` | 指定した分割先受注数が、受注伝票の受注数より大きいです。受注伝票の受注数以下の数値を指定してください。receive_order_row_no[xxxxxx] | 受注数以下の値を指定してください |
| `016021` | 分割元の受注数に全て0が指定されるため、分割できません。分割可能な伝票か確認してください。 | 分割可能な伝票か確認してください |
| `016022` | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | 分割条件を確認してください |
| `016023` | 引当処理対象になる伝票は、引当処理中に分割処理出来ません。しばらく時間をおいて、再度実行してください。 | 引当処理が終了するまで待機してください |
| `016999` | 分割処理中に例外が発生したため、処理を行いませんでした。 | 処理エラーを確認して対応してください |

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_base_divide/`](/openapi/operations/api_v1_receiveorder_base_divide/) (OpenAPI 3.1 のインタラクティブ仕様)
- エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味)
- フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目)

### 同じカテゴリの他のエンドポイント (受注伝票)

- [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate`
- [納品書印刷済み一括更新](/api/api_v1_receiveorder_base/bulkupdatereceipted/) — `POST /api_v1_receiveorder_base/bulkupdatereceipted`
- [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count`
- [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted`
- [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted`
- [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search`
- [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped`
- [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update`
- [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload`

---

# 納品書印刷済み一括更新
URL: https://developer.next-engine.com/api/api_v1_receiveorder_base/bulkupdatereceipted/
Method: POST
API Endpoint: https://api.next-engine.org/api_v1_receiveorder_base/bulkupdatereceipted
Tag: 受注伝票
Required parameters: access_token, data_type, data
Optional parameters: refresh_token, wait_flag, fields, offset, limit

## リクエストURL

ホスト

`https://api.next-engine.org`

エンドポイント

`/api_v1_receiveorder_base/bulkupdatereceipted`

## リファレンス内容


### 納品書印刷済み一括更新について

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。

指定した受注伝票を一括で納品書印刷済みに更新します。

処理結果はレスポンスのステータスコードで確認します。

### 入力パラメータ

| パラメータ | 値 | 省略 | 備考 |
| --- | --- | --- | --- |
| `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以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
| `data_type` | dataのファイル種類 | 必須 | xml:更新データXML, gz:更新データをgzipで圧縮 |
| `data` | 更新するデータ | 必須 | XML形式もしくはXMLファイルをgzipで圧縮したgz形式で指定します [形式はこちら](#xml形式)を参照 |

### 出力パラメータ

| パラメータ名 | 値 | 備考 |
| --- | --- | --- |
| `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 |
| `message` | 一括更新処理の状態を表すメッセージ | 詳細はサンプルをご覧ください。 |
| `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の有効期限切れ日時 | |

### XML形式

入力パラメータのdataで指定する値です 

 完成サンプルはこちらを参照

| 階層 | 要素 | 必須 | 繰返 | 属性 | 内容 |
| --- | --- | --- | --- | --- | --- |
| 1 | <root> | ○ | | | |
| 2 | <receiveorder> | ○ | ○ | receive_order_id receive_order_last_modified_date | 受注伝票番号と最終更新日を指定します。 更新する受注伝票が複数ある場合はその分、要素を繰り返します |
| 3 | < receive_order_label_print_flag> | | | | ラベル発行フラグ。1：配送情報出力対象にする |
| 2 | </receiveorder> | ○ | ○ | | |
| 1 | </root> | ○ | | | |

XML完成サンプル

```xml
<?xml version="1.0" encoding="utf-8"?>
<root>
 <receiveorder receive_order_id="1" receive_order_last_modified_date="2018-04-13 10:38:28">
 <receive_order_label_print_flag>1</receive_order_label_print_flag>
 </receiveorder>
 <receiveorder receive_order_id="2" receive_order_last_modified_date="2018-04-13 10:38:28">
 <receive_order_label_print_flag>0</receive_order_label_print_flag>
 </receiveorder>
</root>
```


### サンプル

リクエスト

```bash
curl -X POST -d 'access_token=xxx&refresh_token=xxx&data_type=xxx&data=xxx' "https://api.next-engine.org/api_v1_receiveorder_base/bulkupdatereceipted"
```

更新成功レスポンス

```json
{
 "result": "success",
 "message": "",
 "access_token":"xxxxxxxx",
 "refresh_token":"xxxxxxxx",
 "access_token_end_date":"2017-04-15 18:24:53"
 "refresh_token_end_date":"2017-04-15 18:24:53"
}
```

更新失敗レスポンス

```json
{
  "result": "error",
  "code": "021500",
  "message": [
    {
      "receive_order_id": "2",
      "code": "021005",
      "message": "受注伝票[2]は納品書印刷待ちではありません。"
    },
    {
      "receive_order_id": "3",
      "code": "021004",
      "message": "受注伝票[3]は存在しません。"
    }
  ],
  "access_token": "xxxxxxxxxx",
  "access_token_end_date": "2019-09-28 14:55:24",
  "refresh_token": "xxxxxxxxxx",
  "refresh_token_end_date": "2019-09-30 14:55:24"
}
```


## エラー

### エラーコード

エンドポイント固有のエラーコードを以下に示します。
共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。

| エラーコード | メッセージ | 対処方法 |
|---|---|---|
| `024001` | アクセス情報[xxxxxx]の許可が必要です。 | ネクストエンジンの「アプリを作る」「APIタブ」にてアクセス許可をする必要があります |
| `024002` | receiveorderタグにreceive_order_idが指定されていない、または値が空です。 | receive_order_idを指定してください |
| `024003` | 受注取込中のため、更新出来ません。 | しばらく時間を空けて再度APIを実行してください |
| `024004` | 受注伝票[xxxxxx]は存在しません。 | receive_order_idを確認してください |
| `024005` | 受注伝票[xxxxxx]は納品書印刷待ちではありません。 | 伝票の状態を確認してください |
| `024006` | 受注伝票[xxxxxx]は有効ではありません。キャンセルされてます。 | キャンセルされた伝票は処理できません |
| `024007` | 納品書印刷中の伝票があります。時間を空けて再度APIを実行して下さい。 | 納品書印刷処理終了後に実行してください |
| `024008` | receiveorderタグにreceive_order_last_modified_dateが指定されておりません。 | receive_order_last_modified_dateを指定してください |
| `024009` | receive_order_last_modified_dateが更新されています。再度受注伝票を検索してAPIを実行して下さい。 | 受注伝票を再検索して最新の日時を取得してください |
| `024010` | 棚卸中のため、更新出来ません。 | 棚卸を終了してから再度APIを実行してください |
| `024011` | 納品書印刷指示日[YYYY/MM/DD]が指定されてます。納品書印刷指示日がAPI実行日以前でない場合は更新できません。 | 納品書印刷指示日をAPI実行日以前に設定するか、設定を解除してください |
| `024013` | 受注伝票[xxxxxx]は配送情報出力済みです。 | 配送情報出力済みの伝票は処理できません |
| `024014` | data_typeの値を正しい形式で指定して下さい。 | data_typeを正しい形式で指定してください |
| `024015` | dataの値を解析できませんでした。正しい形式で指定して下さい。 | dataの形式を修正してください |
| `024016` | data_type[xml or gz]とdataの形式が一致しません。正しい形式で指定してください。 | data_typeとdataの形式を合わせてください |
| `024018` | POSTパラメータにdata_typeが指定されていない、または値が空です。 | data_typeを指定してください |
| `024019` | POSTパラメータにdataが指定されていない、または値が空です。 | dataを指定してください |
| `024020` | 一度に1000件より多くの受注伝票を更新出来ません。1000件以内にして再度実行して下さい。 | 1000件以内に分割してください |
| `024021` | 更新対象の受注伝票が１つも指定されていません。 | 更新対象を指定してください |
| `024500` | xxxxxxx | 納品書印刷済み一括更新エラーを確認してください |
| `024999` | 更新処理中に例外が発生したため、処理を行いませんでした。xxxxxx | 例外内容を確認して対応してください |

## 関連リンク

- 構造化スキーマビュー: [`/openapi/operations/api_v1_receiveorder_base_bulkupdatereceipted/`](/openapi/operations/api_v1_receiveorder_base_bulkupdatereceipted/) (OpenAPI 3.1 のインタラクティブ仕様)
- エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味)
- フィールド一覧: [`/guides/fields/receiveorder_base/`](/guides/fields/receiveorder_base/) (このエンドポイントが扱うデータ項目)

### 同じカテゴリの他のエンドポイント (受注伝票)

- [受注伝票一括更新](/api/api_v1_receiveorder_base/bulkupdate/) — `POST /api_v1_receiveorder_base/bulkupdate`
- [受注伝票件数取得](/api/api_v1_receiveorder_base/count/) — `POST /api_v1_receiveorder_base/count`
- [受注伝票分割](/api/api_v1_receiveorder_base/divide/) — `POST /api_v1_receiveorder_base/divide`
- [受注伝票配送情報出力済み](/api/api_v1_receiveorder_base/labelprinted/) — `POST /api_v1_receiveorder_base/labelprinted`
- [受注伝票納品書印刷済み](/api/api_v1_receiveorder_base/receipted/) — `POST /api_v1_receiveorder_base/receipted`
- [受注伝票検索](/api/api_v1_receiveorder_base/search/) — `POST /api_v1_receiveorder_base/search`
- [受注伝票出荷確定処理](/api/api_v1_receiveorder_base/shipped/) — `POST /api_v1_receiveorder_base/shipped`
- [受注伝票更新](/api/api_v1_receiveorder_base/update/) — `POST /api_v1_receiveorder_base/update`
- [受注伝票アップロード](/api/api_v1_receiveorder_base/upload/) — `POST /api_v1_receiveorder_base/upload`