受注一括登録パターン情報取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_receiveorder_uploadpattern/info

リファレンス内容

情報取得について

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

情報取得と検索APIの違いは、以下の通りです

情報取得は、対象データを全て取得します（検索条件などの指定が不可能）
情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能）

入力パラメータ

パラメータ	値	省略	備考
`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以外とする)	詳細はパラメータ共通事項「待機フラグについて」を参照して下さい

出力パラメータ

パラメータ名	値	備考
`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になります
`access_token_end_date`	入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時
`refresh_token_end_date`	入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時
`count`	検索結果の件数
`data`	検索結果の連想配列(JSONのオブジェクト型)	検索対象の全フィールドを返却します

受注一括登録パターン

項目名	フィールド名	データ型	備考
受注一括登録パターンID	`receive_order_upload_pattern_id`	数値型
受注一括登録パターン名	`receive_order_upload_pattern_name`	文字列型
受注一括登録フォーマットパターンID	`receive_order_upload_pattern_format_id`	数値型	参考資料：受注一括登録フォーマットパターンのIDと名称参照
店舗ID	`receive_order_upload_pattern_shop_id`	数値型
削除フラグ	`receive_order_upload_pattern_deleted_flag`	文字列型	1:有効 1以外:無効
作成日	`receive_order_upload_pattern_creation_date`	日付型
最終更新日	`receive_order_upload_pattern_last_modified_date`	日付型
作成担当者ID	`receive_order_upload_pattern_creator_id`	数値型
作成担当者名	`receive_order_upload_pattern_creator_name`	文字列型
最終更新者ID	`receive_order_upload_pattern_last_modified_by_id`	数値型
最終更新者名	`receive_order_upload_pattern_last_modified_by_name`	文字列型

参考資料：受注一括登録フォーマットパターンのID・名称

受注一括登録フォーマットパターンID	受注一括登録フォーマットパターン名
15	Yahooオークション標準パターン
40	DeNA BtoB market標準パターン
48	ebay標準パターン
50	楽天全カラムDLパターン
90	汎用標準パターン
9001	たまごリピートパターン
10001	楽天ペイ全カラムDLパターン
10003	DeNAショッピングパターン
100011	アマゾンパターン
100013	おちゃのこネット（オーダーメイド対応）パターン
100014	ショップサーブパターン
100019	FutureShop2 パターン
100022	Color Me Shop! Pro 2009-12
100023	`superdelivery`
100025	マーキュリー備考欄ラッピング追加パターン
100026	ワイズカートASP/ZERO
100034	ヤマダモール（楽天互換形式安定版）パターン
100035	MakeShopパターン
100042	ポンパレパターン
100043	アマゾン海外パターン
100045	LINE MALLパターン
200002	YAHOOショッピング（ストアクリエイターPro）パターン
1000302	Wow!manager全カラムDLパターン

サンプル

リクエスト

curl -X POST -H 'content-type: application/x-www-form-urlencoded' \ -d 'access_token=xxx&refresh_token=xxx&wait_flag=1' \ https://api.next-engine.org/api_v1_receiveorder_uploadpattern/info

レスポンス

{
  "result": "success",
  "count": "2",
  "data": [
    {
      "receive_order_upload_pattern_id": "2",
      "receive_order_upload_pattern_name": "Test01(楽天全カラムDLパターン)",
      "receive_order_upload_pattern_format_id": "50",
      "receive_order_upload_pattern_shop_id": "1",
      "receive_order_upload_pattern_deleted_flag": "0",
      "receive_order_upload_pattern_creation_date": "2016-12-19 18:04:03",
      "receive_order_upload_pattern_last_modified_date": "2016-12-19 18:04:03",
      "receive_order_upload_pattern_creator_id": "2",
      "receive_order_upload_pattern_creator_name": "ネクスト太郎",
      "receive_order_upload_pattern_last_modified_by_id": "2",
      "receive_order_upload_pattern_last_modified_by_name": "ネクスト太郎"
    },
    {
      "receive_order_upload_pattern_id": "3",
      "receive_order_upload_pattern_name": "Test01(新楽天オークション)",
      "receive_order_upload_pattern_format_id": "43",
      "receive_order_upload_pattern_shop_id": "1",
      "receive_order_upload_pattern_deleted_flag": "0",
      "receive_order_upload_pattern_creation_date": "2016-12-19 18:04:03",
      "receive_order_upload_pattern_last_modified_date": "2016-12-19 18:04:03",
      "receive_order_upload_pattern_creator_id": "2",
      "receive_order_upload_pattern_creator_name": "ネクスト太郎",
      "receive_order_upload_pattern_last_modified_by_id": "2",
      "receive_order_upload_pattern_last_modified_by_name": "ネクスト太郎"
    }
  ],
  "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"
}

エラー

エラーコード

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