ここでは、注文項目の取得、作成、更新、削除について詳しく説明します。
注文項目は/phaser-order-rowsエンドポイントからアクセスできます。
注文項目の取得 #
phaser-order-rowsエンドポイントにGET-requestを送信して注文項目を取得します:
様々なパラメータで注文商品を検索することができます:
- phaser_order_id。
- Skyplannerの内部オーダー IDは、/phaser-orders-endpointから見つけることができます。
- 外部ID
- 注文商品の外部識別子
- 例えば、外部システム(ERPなど)からの一意の識別子。
- プロダクション_プランニング_プロダクトID
- 内部スカイプランナー製品ID
- products-endpointから見つけることができます。
- parent_id
- 注文アイテムにサブアイテム(例えばサブ商品)がある場合、サブアイテムは親注文アイテムのidをparent_idフィールドに持ちます。
- 行インデックス
- 注文商品のインデックス番号
- ワークナンバー
- オーダー項目のワークナンバー値
- ステータス
- 注文状況
- 許可される値:新規、開始、完了
- 位置
- オーダーアイテムのポジション値
- 配達日
- 注文商品の配達日
- フォーマット2025-06-05T22:00:00+00:00
- 配達日条件
- 納期検索のオプション条件
- オプション:>、=、<=、=、!
- 指定された値がない場合、 > = の条件が使用される。
- is_prospect
- 見込みのある注文品のみ返品する
- インクルード・アーカイブド
- アーカイブされた(ソフト削除された)注文アイテムをフェッチに含める
- is_archive値で示される
- モディファイド
- 指定された日付以降に変更された注文項目を返す
- フォーマット2025-06-05T22:00:00+00:00
- 修正条件
- 修正値検索のオプション条件
- オプション:>、=、<=、=、!
- 指定された値がない場合、 > = の条件が使用される。
このように検索パラメーターを組み合わせて検索することもできる:
Skyplannerの内部IDで特定の注文アイテムを取得するには、次のようにリクエストします:
注文項目の作成 #
注文項目を作成する前に注文を作成する必要があることに注意してください!
オーダーアイテムを作成するには、/phaser-order-rowsエンドポイントに POST リクエストを送信します:
ここでは、注文アイテムを作成する際に使用できるフィールドの概要を説明します:
- phaser_order_id。
- オーダーアイテムが属するオーダーのSkyplanner内部ID
- 必須項目
- 生産計画オーダー行番号
- オーダーがSkyplannerの生産スケジューリングモジュールにエクスポートされると、生産計画オーダー行という別のエンティティが作成され、そのidがこのフィールドに設定されます。
- 使用を推奨しない (NULLのままにするか、リクエストフィールドにこのフィールドをまったく送信しない)
- プロダクション_プランニング_プロダクトID
- 注文アイテムが生産する商品のSkyplanner商品ID
- 製品からデフォルトのプロセスステップを取り込む場合は必須です。
- 外部ID
- 注文商品の一意な識別子
- 外部システム(ERPなど)からSkyplannerの受注商品とリンクさせる場合に使用します。
- ユニークでなければならない
- parent_id
- 注文アイテムが他の注文アイテムのサブアイテムである場合、親のid値をここに指定する。
- 行インデックス
- この項目がオーダー内のオーダー項目リストのどの位置にあるか
- ワークナンバー
- 注文アイテムのワークナンバー値としてのみ使用されます。
- スカイプランナーUIには表示されない
- ステータス
- 注文商品のステータス
- 許可される値:新規、開始、準備完了、段階的
- is_archive
- 注文項目はアーカイブされていますか(ソフト削除)
- 位置
- 注文項目の識別子値(図3参照。)
- 量
- 製品の総生産量
- 注文金額
- 注文数量
- 価格
- 製品単価
- カスタム素材の使用
- 製品データからデフォルトの材料設定を使用したくない場合は、この値をtrueに設定してください。
- デフォルト:false
- カスタム材料を使用する。
- カスタム材料の数量は、製品の製造数量に基づいて計算されます。
- falseに設定すると、材料の量は固定されます。
- デフォルト:false
- ゲット_デフォルト_ステップス
- 商品のデフォルトのプロセスステップに基づいて、商品を注文するためのプロセスステップを作成する。
- デフォルト:false
- 使用_calculated_job_durations
- 過去のタイムログデータに基づき、プロセスステップの所要時間を計算します。
- 計算するのに十分なデータがない場合は、デフォルトの期間が使用される。
- デフォルト:false
- サブアイテム
- 可能であれば、商品のサブアイテムも作成する。
- デフォルト:false
- 配達日
- フォーマット2022-01-01 10:30:11
- 参加資格開始日
- フォーマット2022-01-01 10:30:11
- 図面識別子
- 図面/青写真/説明書識別子
- 記述
- 注文項目の説明
- additional_description(追加記述
- 注文項目に関する補足説明
- is_prospect
- 注文項目は見込み客か
- デフォルト:false
注文項目の更新 #
注文項目のデータを更新するには、/phaser-order-rowsエンドポイントに PUT リクエストを送信します:
注文項目の削除 #
注文項目の削除は「ソフト削除」メソッドで行われる。事実上、注文項目を削除すると、そのis_archive値が true に変更されます。つまり、is_archive値をfalseに更新することで、削除された注文項目を復元することができます。
オーダーアイテムを削除する際、システムは関連するプロセスステップも削除します。
注文項目を削除するには、/phaser-order-rowsエンドポイントに DELETE リクエストを送信します:
配列“ids “にSkyplanner内部のidを指定するか、配列“external_ids “にexternal_idを指定することで、オーダー項目を削除できます。