拠点在庫マスタアップロード
リクエストURL
Section titled “リクエストURL”ホスト
https://api.next-engine.org
エンドポイント
/api_v1_warehouse_stock/upload
リファレンス内容
Section titled “リファレンス内容”拠点在庫マスタ予約一括登録
Section titled “拠点在庫マスタ予約一括登録”入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります。
動作は商品管理の一括登録と同じで、非同期でメイン機能に登録可能になった時に登録されます。
登録結果は、アップロードキューを検索して確認します。
入力パラメータ
Section titled “入力パラメータ”| パラメータ | 値 | 省略 | 備考 |
|---|---|---|---|
access_token | access_token取得により取得した値 | 必須(SDKの場合不要) | |
refresh_token | access_token取得により取得した値 | 可能(SDKの場合不要) | 【指定してaccess_tokenの有効期限が切れた場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます 【省略してaccess_tokenの有効期限が切れた場合】 出力パラメータ「result」の値がredirectになります(成功時以外の出力パラメータ参照) |
wait_flag | 1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却 | 可能(省略時は1以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい |
data_type | dataのファイル種類 | 必須 | csv:拠点在庫マスタCSV,gz:拠点在庫マスタCSVをGZIPで圧縮 |
data | 拠点在庫マスタCSVのファイル内容(3000件まで) | 必須 | メイン機能仕様と同じ(推奨: Shift_JISまたはUTF-8) |
出力パラメータ
Section titled “出力パラメータ”| パラメータ名 | 値 | 備考 |
|---|---|---|
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"}エラーコード
Section titled “エラーコード”エンドポイント固有のエラーコードはありません。 共通エラーコードは メッセージコード一覧 を参照してください。
- 構造化スキーマビュー:
/openapi/operations/api_v1_warehouse_stock_upload/(OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧:
/guides/param/message/(result/code/messageの意味)
同じカテゴリの他のエンドポイント (拠点在庫マスタ)
Section titled “同じカテゴリの他のエンドポイント (拠点在庫マスタ)”- 拠点在庫マスタ件数取得 —
POST /api_v1_warehouse_stock/count - 拠点在庫マスタ検索 —
POST /api_v1_warehouse_stock/search