セット商品マスタアップロード

POST

/api_v1_master_setgoods/upload

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=set_syohin_code,syohin_code,suryo,set_baika_tnk,set_syohin_name
test-set1,test-0001,3,100,TEST-0001 3個セット
test-set1,test-0002,4,100,TEST-0002 3個セット' https://api.next-engine.org/api_v1_master_setgoods/upload

// POST /api_v1_master_setgoods/upload - セット商品マスタアップロード
const params = new URLSearchParams({
  access_token: '<access_token>',
  data_type: '<data_type>',
  data: '<data>',
})
const res = await fetch('https://api.next-engine.org/api_v1_master_setgoods/upload', {
  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_master_setgoods/upload - セット商品マスタアップロード
import requests

params = {
    'access_token': '<access_token>',
    'data_type': '<data_type>',
    'data': '<data>',
}
res = requests.post(
    'https://api.next-engine.org/api_v1_master_setgoods/upload',
    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

data_type

required

Dataのファイル種類 / csv:セット商品マスタCSV,gz:セット商品マスタCSVをGZIPで圧縮

string

data

required

セット商品マスタCSVのファイル内容 / メイン機能仕様と同じ（推奨: Shift_JISまたはUTF-8）

string

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

Example

{
  "result": "success",
  "que_id": "13",
  "access_token": "xxx",
  "access_token_end_date": "2022-09-01 14:19:22",
  "refresh_token": "xxx",
  "refresh_token_end_date": "2022-09-03 14:19:22"
}

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

セット商品マスタアップロード

Request Body required

Responses

200

Example

4XX

Example

Request Body^required