コンテンツにスキップ

セット商品マスタ検索

POST

/api_v1_master_setgoods/search

curl -X POST "Content-Type:application/x-www-form-urlencoded" -d "access_token=xxx&refresh_token=xxx&wait_flag=1&fields=set_goods_id,set_goods_name,set_goods_detail_goods_id,set_goods_detail_quantity&set_goods_detail_goods_id-like=test-syohin00001%&offset=0&limit=100" https://api.next-engine.org/api_v1_master_setgoods/search

// POST /api_v1_master_setgoods/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_master_setgoods/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_master_setgoods/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_master_setgoods/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

set_goods_id

セット商品コード / 文字列型

string | integer | number | boolean | null

set_goods_name

セット商品名 / 文字列型

string | integer | number | boolean | null

set_goods_selling_price

セット商品単価（セット販売価格） / 数値型

string | integer | number | boolean | null

set_goods_detail_goods_id

商品コード（内訳） / 文字列型

string | integer | number | boolean | null

set_goods_detail_quantity

数量（内訳） / 数値型

string | integer | number | boolean | null

set_goods_representation_id

代表商品コード / 文字列型

string | integer | number | boolean | null

set_goods_tax_rate

消費税率 / 数値型

string | integer | number | boolean | null

set_goods_jan_code

JANコード / 文字列型

string | integer | number | boolean | null

set_goods_foreign_name

英語表記名 / 文字列型

string | integer | number | boolean | null

set_goods_display_price

定価 / 数値型

string | integer | number | boolean | null

set_goods_tax_id

消費税 / 数値型 / 0:税別 1:税込 2:非課税

string | integer | number | boolean | null

set_goods_model_number

型番 / 文字列型

string | integer | number | boolean | null

set_goods_location

ロケーションコード / 文字列型

string | integer | number | boolean | null

set_goods_gift_ok_flg

ギフト可否 / 数値型 / 0:不可 1:可

string | integer | number | boolean | null

set_goods_size

サイズ / 文字列型

string | integer | number | boolean | null

set_goods_maker_model_number

メーカー型番 / 文字列型

string | integer | number | boolean | null

set_goods_condition_id

商品状態 / 文字列型 / 01:新品 02:中古 03:その他 04:未使用に近い 05:目立った傷や汚れなし 06:やや傷や汚れあり 07:傷や汚れあり 08:全体的に状態が悪い

string | integer | number | boolean | null

set_goods_condition_description

商品状態説明 / 文字列型

string | integer | number | boolean | null

set_goods_width

パッケージ込みの幅 / 数値型

string | integer | number | boolean | null

set_goods_length

パッケージ込みの奥行き / 数値型

string | integer | number | boolean | null

set_goods_height

パッケージ込みの高さ / 数値型

string | integer | number | boolean | null

set_goods_weight

パッケージ込みの重さ / 数値型

string | integer | number | boolean | null

set_goods_same_day_delivery_id

当日・翌日発送 / 数値型 / 1:当日 2:翌日

string | integer | number | boolean | null

set_goods_option_noshi_id

のし対応 / 数値型 / 0:対応しない 1:対応する

string | integer | number | boolean | null

set_goods_color

色 / 文字列型

string | integer | number | boolean | null

set_goods_brand_name

ブランド名 / 文字列型

string | integer | number | boolean | null

set_goods_maker_name

メーカー名 / 文字列型

string | integer | number | boolean | null

set_goods_first_time_sold_date

販売開始日 / 日時型

string | integer | number | boolean | null

set_goods_last_time_sold_date

販売終了日 / 日時型

string | integer | number | boolean | null

set_goods_creation_date

作成日 / 日時型

string | integer | number | boolean | null

set_goods_creator_id

作成担当者ID / 数値型

string | integer | number | boolean | null

set_goods_creator_name

作成担当者名 / 文字列型

string | integer | number | boolean | null

set_goods_last_modified_date

最終更新日 / 日時型

string | integer | number | boolean | null

set_goods_last_modified_by_id

最終更新担当者ID / 数値型

string | integer | number | boolean | null

set_goods_last_modified_by_name

最終更新担当者名 / 文字列型

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "result": "success",
  "count": "2",
  "data": [
    {
      "set_goods_id": "set-test-syohin00001",
      "set_goods_name": "セットテスト商品00001",
      "set_goods_detail_goods_id": "test-syohin00001",
      "set_goods_detail_quantity": "4"
    },
    {
      "set_goods_id": "set-test-syohin10001",
      "set_goods_name": "セットテスト商品10001",
      "set_goods_detail_goods_id": "test-syohin00001",
      "set_goods_detail_quantity": "4"
    }
  ],
  "access_token": "xxx",
  "access_token_end_date": "2022-09-27 18:45:17",
  "refresh_token": "xxx",
  "refresh_token_end_date": "2022-09-29 18:45:17"
}

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