拠点在庫マスタアップロード

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_warehouse_stock/upload

リファレンス内容

拠点在庫マスタ予約一括登録

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

動作は商品管理の一括登録と同じで、非同期でメイン機能に登録可能になった時に登録されます。

登録結果は、アップロードキューを検索して確認します。

在庫を動かさずに拠点と商品を紐づける

data（拠点在庫マスタCSV）に kyoten_syohin_himoduke 列を追加し、値に a を指定すると、在庫数を変えずに商品と拠点の組み合わせだけを登録できます。

syohin_code,kyoten_mei,kyoten_syohin_himoduke
product001,拠点1,a

1行につき kasan_su（加算数）・gensan_su（減算数）・kyoten_syohin_sakujyo（拠点商品削除）・kyoten_syohin_himoduke（拠点商品紐づけ）のうち、必ずどれか1つだけに値を入れてください。0個（すべて空欄）の行も、2つ以上に値がある行もエラーになります
kyoten_syohin_himoduke に a 以外の値を指定した行はエラーになります
基本拠点を指定した行はエラーになります。kyoten_mei（拠点名）を省略した行・空欄にした行も基本拠点として扱われ、同様にエラーになります
すでに紐づいている商品と拠点の組み合わせを指定した行はエラーにはならず、そのままスキップされます（アップロードキューの成功件数にも含まれません）
この列を指定した行では nyusyukko_riyu（入出庫理由）の値は使われません。入出庫履歴には固定の理由「拠点紐付け」が記録されます

拠点と商品の紐づけを解除する（拠点在庫を削除する）

data（拠点在庫マスタCSV）には kyoten_syohin_sakujyo 列があり、値に d を指定すると、商品と拠点の紐づけを解除します。紐づけを解除すると、その時点で登録されていた拠点在庫数（在庫数）も削除されます。

syohin_code,kyoten_mei,kyoten_syohin_sakujyo
product001,拠点1,d

1行につき kasan_su（加算数）・gensan_su（減算数）・kyoten_syohin_himoduke（拠点商品紐づけ）・kyoten_syohin_sakujyo（拠点商品削除）のうち、必ずどれか1つだけに値を入れてください。0個（すべて空欄）の行も、2つ以上に値がある行もエラーになります
kyoten_syohin_sakujyo に d 以外の値を指定した行はエラーになります
基本拠点を指定した行はエラーになります。kyoten_mei（拠点名）を省略した行・空欄にした行も基本拠点として扱われ、同様にエラーになります
引当数が1以上、または0未満の拠点在庫はエラーになり削除できません。引当数が0の場合だけ削除できます（在庫数が残っていても、引当数が0であれば削除されます）
まだ紐づいていない商品と拠点の組み合わせを指定した行はエラーになります（kyoten_syohin_himoduke の場合と違い、スキップはされません）
この列を指定した行では nyusyukko_riyu（入出庫理由）に指定した値が、そのまま入出庫履歴に記録されます（kyoten_syohin_himoduke のように固定の文言に置き換わることはありません。省略した行は空欄のまま記録されます）

入力パラメータ

パラメータ	値	省略	備考
`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のファイル種類	必須	csv:拠点在庫マスタCSV,gz:拠点在庫マスタCSVをGZIPで圧縮
`data`	拠点在庫マスタCSVのファイル内容（3000件まで）	必須	メイン機能仕様と同じ（推奨: Shift_JISまたはUTF-8）

出力パラメータ

パラメータ名	値	備考
`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)を確認することが出来ます。

サンプル

リクエスト

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxx&refresh_token=xxx&wait_flag=1&data_type=csv&data=kyoten_mei,syohin_code,kasan_su,nyusyukko_riyu
拠点A,test-0001,3,在庫数調整のため
拠点B,test-0002,4,在庫数調整のため' https://api.next-engine.org/api_v1_warehouse_stock/upload

レスポンス

{
  "result": "success",
  "que_id": "5",
  "access_token": "xxx",
  "access_token_end_date": "2023-05-01 14:19:22",
  "refresh_token": "xxx",
  "refresh_token_end_date": "2023-05-03 14:19:22"
}

エラー

エラーコード

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