受注伝票アップロード

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_receiveorder_base/upload

リファレンス内容

受注一括登録

入力パラメータは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_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)を確認することが出来ます。

サンプル

リクエスト

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

レスポンス

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

エラー

エラーコード

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

エラーコード	メッセージ	対処方法
`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日です