コンテンツにスキップ

アップロードキュー検索

POST

/api_v1_system_que/search

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxx&refresh_token=xxxxxxxxx&fields=que_id%2Cque_method_name%2Cque_shop_id%2Cque_upload_name%2Cque_client_file_name%2Cque_file_name%2Cque_status_id%2Cque_message%2Cque_deleted_flag%2Cque_creation_date%2Cque_last_modified_date%2Cque_last_modified_null_safe_date%2Cque_creator_id%2Cque_creator_name%2Cque_last_modified_by_id%2Cque_last_modified_by_name%2Cque_last_modified_by_null_safe_id%2Cque_last_modified_by_null_safe_name&offset=1&limit=2' https://api.next-engine.org/api_v1_system_que/search

// POST /api_v1_system_que/search - アップロードキュー検索
const params = new URLSearchParams({
  access_token: '<access_token>',
  fields: 'field1,field2',
  offset: '0',
  limit: '50',
})
const res = await fetch('https://api.next-engine.org/api_v1_system_que/search', {
  method: 'POST',
  headers: { 'content-type': 'application/x-www-form-urlencoded' },
  body: params,
})
const json = await res.json()
if (json.result !== 'success') throw new Error(json.message ?? json.code)
console.log(json.data)

# POST /api_v1_system_que/search - アップロードキュー検索
import requests

params = {
    'access_token': '<access_token>',
    'fields': 'field1,field2',
    'offset': '0',
    'limit': '50',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_system_que/search',
    data=params,
)
json = res.json()
if json['result'] != 'success':
    raise RuntimeError(json.get('message') or json.get('code'))
print(json.get('data'))

Request Body^required

application/x-www-form-urlencoded

object

access_token

required

OAuth2 アクセストークン (必須)

string

refresh_token

OAuth2 リフレッシュトークン (access_token 期限切れ時の自動更新に使用)

string

wait_flag

同期実行フラグ。“1” 指定で処理完了を待つ

string

Allowed values: 0 1

fields

取得するフィールドをカンマ区切りで指定 (search 系のみ)

string

offset

検索開始位置 (search 系のみ)

integer

limit

取得件数 (search 系のみ)

integer

>= 1

Responses

200

実行結果 (result が success / error / redirect のいずれか)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

data

Array<object>

object

que_id

アップロードキューID / 数値型

string | integer | number | boolean | null

que_method_name

機能名 / 文字列型 / SYOHIN_KIHON_CSV:商品マスタCSVアップロード,MALL_SYOHIN_CSV_TO_MASTER:商品情報一括登録

string | integer | number | boolean | null

que_shop_id

店舗ID / 文字列型

string | integer | number | boolean | null

que_upload_name

アップロード名 / 文字列型 / SYOHIN_KIHON_QUE:商品マスタ予約アップロード,TENPO_SYOHIN:商品情報一括登録（モール商品履歴表示用）,SYOHIN_KIHON:商品情報一括登録（商品マスタ履歴表示用）,MALL_SYOHIN_CSV_TO_MASTER_SYOHIN_KIHON:商品情報一括登録（商品マスタ取込用）,PAGE_SYOHIN:商品情報一括登録（ページ管理履歴表示用）,NE_API:ネクストエンジンAPI

string | integer | number | boolean | null

que_client_file_name

クライアントファイル名 / 文字列型 / ユーザーがアップロードした時のファイル名。

string | integer | number | boolean | null

que_file_name

ファイル名 / 文字列型 / 商品マスタCSV、モール商品CSV等

string | integer | number | boolean | null

que_status_id

ステータス / 数値型 / 2:全て処理成功、1:処理中、0:処理待ち、-1:処理失敗

string | integer | number | boolean | null

que_message

メッセージ / 文字列型 / 処理中の場合、進捗状況、処理失敗の場合は、エラーになった理由（メイン機能のアップロード履歴と同じ）。

string | integer | number | boolean | null

que_deleted_flag

削除フラグ / 文字列型

string | integer | number | boolean | null

que_creation_date

作成日 / 日時型

string | integer | number | boolean | null

que_last_modified_date

最終更新日 / 日時型

string | integer | number | boolean | null

que_last_modified_null_safe_date

最終更新日 / 日時型 / NULLの場合作成日

string | integer | number | boolean | null

que_creator_id

作成担当者ID / 数値型

string | integer | number | boolean | null

que_creator_name

作成担当者名 / 文字列型

string | integer | number | boolean | null

que_last_modified_by_id

最終更新者ID / 数値型

string | integer | number | boolean | null

que_last_modified_by_null_safe_id

最終更新者ID / 数値型 / NULLの場合作成者ID

string | integer | number | boolean | null

que_last_modified_by_name

最終更新者名 / 文字列型

string | integer | number | boolean | null

que_last_modified_by_null_safe_name

最終更新者名 / 文字列型 / NULLの場合作成者名

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "result": "success",
  "count": "2",
  "data": [
    {
      "que_id": "1",
      "que_method_name": "SYOHIN_KIHON_CSV",
      "que_shop_id": "",
      "que_upload_name": "NE_API",
      "que_client_file_name": "xxxxxxx",
      "que_file_name": "商品マスタCSV",
      "que_status_id": "2",
      "que_message": "正常に[1]件、取り込みました。",
      "que_deleted_flag": "0",
      "que_creation_date": "2017-01-19 11:27:55",
      "que_last_modified_date": "2017-01-19 11:29:02",
      "que_last_modified_null_safe_date": "2017-01-19 11:29:02",
      "que_creator_id": "10004",
      "que_creator_name": "xxxxxx",
      "que_last_modified_by_id": "0",
      "que_last_modified_by_name": "System",
      "que_last_modified_by_null_safe_id": "0",
      "que_last_modified_by_null_safe_name": "System"
    },
    {
      "que_id": "2",
      "que_method_name": "SYOHIN_KIHON_CSV",
      "que_shop_id": "",
      "que_upload_name": "NE_API",
      "que_client_file_name": "xxxxxx",
      "que_file_name": "商品マスタCSV",
      "que_status_id": "2",
      "que_message": "正常に[1]件、取り込みました。",
      "que_deleted_flag": "0",
      "que_creation_date": "2017-01-19 11:29:39",
      "que_last_modified_date": "2017-01-19 11:30:36",
      "que_last_modified_null_safe_date": "2017-01-19 11:30:36",
      "que_creator_id": "10002",
      "que_creator_name": "xxxxxxx",
      "que_last_modified_by_id": "0",
      "que_last_modified_by_name": "System",
      "que_last_modified_by_null_safe_id": "0",
      "que_last_modified_by_null_safe_name": "System"
    }
  ],
  "access_token": "xxxxxxxxxx",
  "access_token_end_date": "2017-04-15 13:03:47",
  "refresh_token": "xxxxxxxxxxx",
  "refresh_token_end_date": "2017-04-17 13:03:47"
}

4XX

クライアントエラー (HTTP ステータス自体は 200 + result=error で返ることが多い)

application/json

object

result

required

実行結果ステータス

string

Allowed values: success error redirect

code

エラー時のエラーコード

string

message

One of:

string
Array<object>

string

access_token

更新後のアクセストークン

string

access_token_end_date

アクセストークン有効期限 (YYYY-MM-DD HH:MM:SS)

string

refresh_token

更新後のリフレッシュトークン

string

refresh_token_end_date

リフレッシュトークン有効期限

string

data

エンドポイント固有のレスポンスデータ

count

Count/search 系のヒット件数 (form-urlencoded レスポンスでは文字列で返ることがある)

integer | string

Example

{
  "result": "success"
}