コンテンツにスキップ

商品マスタ検索

POST

/api_v1_master_goods/search

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1&fields=goods_id,goods_name,stock_quantity,supplier_name&goods_id-eq=TestP001&offset=0&limit=100' https://api.next-engine.org/api_v1_master_goods/search

// POST /api_v1_master_goods/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_goods/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_goods/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_goods/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

goods_id

商品コード / 文字列型

string | integer | number | boolean | null

goods_representation_id

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

string | integer | number | boolean | null

goods_name

商品名 / 文字列型

string | integer | number | boolean | null

goods_foreign_name

英語商品名 / 文字列型

string | integer | number | boolean | null

goods_type_id

商品区分 / 文字列型

string | integer | number | boolean | null

goods_type_name

商品区分名 / 文字列型

string | integer | number | boolean | null

goods_merchandise_id

取扱区分 / 文字列型

string | integer | number | boolean | null

goods_merchandise_name

取扱区分名 / 文字列型

string | integer | number | boolean | null

goods_forwarding_method_id

輸送方法指定 / 文字列型

string | integer | number | boolean | null

goods_forwarding_method_name

輸送方法指定名 / 文字列型

string | integer | number | boolean | null

goods_status_id

商品ステータス区分 / 文字列型

string | integer | number | boolean | null

goods_status_name

商品ステータス名 / 文字列型

string | integer | number | boolean | null

goods_delivery_id

発送方法区分 / 文字列型 / 商品マスタの配送業者の区分値

string | integer | number | boolean | null

goods_delivery_name

発送方法名 / 文字列型 / 商品マスタの配送業者の名称

string | integer | number | boolean | null

goods_supplier_id

仕入先コード / 文字列型

string | integer | number | boolean | null

goods_jan_code

JANコード / 文字列型

string | integer | number | boolean | null

goods_maker_name

メーカー名 / 文字列型

string | integer | number | boolean | null

goods_maker_kana

メーカーカナ / 文字列型

string | integer | number | boolean | null

goods_maker_address

メーカー住所 / 文字列型

string | integer | number | boolean | null

goods_maker_zip_code

メーカー郵便番号 / 文字列型

string | integer | number | boolean | null

goods_model_number

型番 / 文字列型

string | integer | number | boolean | null

goods_color

色 / 文字列型

string | integer | number | boolean | null

goods_mall_category

モールカテゴリ / 文字列型

string | integer | number | boolean | null

goods_shop_category

店舗カテゴリ / 文字列型

string | integer | number | boolean | null

goods_cost_price

原価 / 数値型

string | integer | number | boolean | null

goods_display_price

定価 / 数値型

string | integer | number | boolean | null

goods_selling_price

売価単価 / 数値型

string | integer | number | boolean | null

goods_foreign_selling_price

外国売価単価 / 数値型

string | integer | number | boolean | null

goods_tax_rate

消費税率（%） / 数値型

string | integer | number | boolean | null

goods_wholesale_retail_ratio

掛率 / 数値型

string | integer | number | boolean | null

goods_weight

重さ / 数値型

string | integer | number | boolean | null

goods_width

幅 / 数値型

string | integer | number | boolean | null

goods_length

奥行き / 数値型

string | integer | number | boolean | null

goods_height

高さ / 数値型

string | integer | number | boolean | null

goods_release_date

発売日 / 日時型

string | integer | number | boolean | null

goods_first_time_sold_date

初販売日 / 日時型

string | integer | number | boolean | null

goods_last_time_sold_date

最終販売日 / 日時型

string | integer | number | boolean | null

goods_first_time_supplied_date

初仕入れ日 / 日時型

string | integer | number | boolean | null

goods_last_time_supplied_date

最終仕入れ日 / 日時型

string | integer | number | boolean | null

goods_stock_constant

在庫定数 / 数値型

string | integer | number | boolean | null

goods_order_point

発注点 / 数値型

string | integer | number | boolean | null

goods_lot

ロット / 数値型

string | integer | number | boolean | null

goods_publication_date

掲載日 / 日時型

string | integer | number | boolean | null

goods_stock_management_flag

在庫管理フラグ / 文字列型

string | integer | number | boolean | null

goods_note

備考 / 文字列型

string | integer | number | boolean | null

goods_visible_flag

表示フラグ / 文字列型

string | integer | number | boolean | null

goods_tag

商品分類タグ / 文字列型 / 値は名称値(goods_tag_name)が設定されている。複数設定可能。

string | integer | number | boolean | null

goods_location

ロケーション / 文字列型

string | integer | number | boolean | null

goods_delivery_mail_flag

メール便可否フラグ / 数値型

string | integer | number | boolean | null

goods_delivery_mail_maximum_quality

メール便最大数量 / 文字列型

string | integer | number | boolean | null

goods_gift_ok_flg

ギフト可フラグ / 数値型

string | integer | number | boolean | null

goods_size

サイズ / 文字列型

string | integer | number | boolean | null

goods_maker_model_number

メーカー型番 / 文字列型

string | integer | number | boolean | null

goods_stock_alert_mail_threshold

在庫アラートメール閾値 / 数値型

string | integer | number | boolean | null

goods_wholesale_mortgage_threshold

卸引当用敷居値 / 数値型

string | integer | number | boolean | null

goods_shipping_base_id

発送元コード / 文字列型

string | integer | number | boolean | null

goods_mail_tag_id

メールタグ / 文字列型

string | integer | number | boolean | null

goods_1_item

項目１ / 文字列型

string | integer | number | boolean | null

goods_2_item

項目２ / 文字列型

string | integer | number | boolean | null

goods_3_item

項目３ / 文字列型

string | integer | number | boolean | null

goods_4_item

項目４ / 文字列型

string | integer | number | boolean | null

goods_5_item

項目５ / 文字列型

string | integer | number | boolean | null

goods_6_item

項目６ / 文字列型

string | integer | number | boolean | null

goods_7_item

項目７ / 文字列型

string | integer | number | boolean | null

goods_8_item

項目８ / 文字列型

string | integer | number | boolean | null

goods_9_item

項目９ / 文字列型

string | integer | number | boolean | null

goods_10_item

項目１０ / 文字列型

string | integer | number | boolean | null

goods_11_item

項目１１ / 文字列型

string | integer | number | boolean | null

goods_12_item

項目１２ / 文字列型

string | integer | number | boolean | null

goods_13_item

項目１３ / 文字列型

string | integer | number | boolean | null

goods_14_item

項目１４ / 文字列型

string | integer | number | boolean | null

goods_15_item

項目１５ / 文字列型

string | integer | number | boolean | null

goods_16_item

項目１６ / 文字列型

string | integer | number | boolean | null

goods_17_item

項目１７ / 文字列型

string | integer | number | boolean | null

goods_18_item

項目１８ / 文字列型

string | integer | number | boolean | null

goods_19_item

項目１９ / 文字列型

string | integer | number | boolean | null

goods_20_item

項目２０ / 文字列型

string | integer | number | boolean | null

goods_1_select_id

選択肢ID１ / 数値型

string | integer | number | boolean | null

goods_1_select_name

選択肢名１ / 文字列型

string | integer | number | boolean | null

goods_2_select_id

選択肢ID２ / 数値型

string | integer | number | boolean | null

goods_2_select_name

選択肢名２ / 文字列型

string | integer | number | boolean | null

goods_3_select_id

選択肢ID３ / 数値型

string | integer | number | boolean | null

goods_3_select_name

選択肢名３ / 文字列型

string | integer | number | boolean | null

goods_4_select_id

選択肢ID４ / 数値型

string | integer | number | boolean | null

goods_4_select_name

選択肢名４ / 文字列型

string | integer | number | boolean | null

goods_5_select_id

選択肢ID５ / 数値型

string | integer | number | boolean | null

goods_5_select_name

選択肢名５ / 文字列型

string | integer | number | boolean | null

goods_6_select_id

選択肢ID６ / 数値型

string | integer | number | boolean | null

goods_6_select_name

選択肢名６ / 文字列型

string | integer | number | boolean | null

goods_7_select_id

選択肢ID７ / 数値型

string | integer | number | boolean | null

goods_7_select_name

選択肢名７ / 文字列型

string | integer | number | boolean | null

goods_8_select_id

選択肢ID８ / 数値型

string | integer | number | boolean | null

goods_8_select_name

選択肢名８ / 文字列型

string | integer | number | boolean | null

goods_9_select_id

選択肢ID９ / 数値型

string | integer | number | boolean | null

goods_9_select_name

選択肢名９ / 文字列型

string | integer | number | boolean | null

goods_10_select_id

選択肢ID１０ / 数値型

string | integer | number | boolean | null

goods_10_select_name

選択肢名１０ / 文字列型

string | integer | number | boolean | null

goods_publication_pic_id

掲載担当者ID / 数値型

string | integer | number | boolean | null

goods_publication_pic_name

掲載担当者名 / 文字列型

string | integer | number | boolean | null

goods_stock_wholesale_quantity

卸在庫数 / 数値型

string | integer | number | boolean | null

goods_description_text

商品説明（テキスト） / 文字列型

string | integer | number | boolean | null

goods_description_html

商品説明（HTML） / 文字列型

string | integer | number | boolean | null

goods_spec_text

スペック（テキスト） / 文字列型

string | integer | number | boolean | null

goods_spec_html

スペック（HTML） / 文字列型

string | integer | number | boolean | null

goods_caution_text

注意事項（テキスト） / 文字列型

string | integer | number | boolean | null

goods_caution_html

注意事項（HTML） / 文字列型

string | integer | number | boolean | null

goods_condition_description

商品状態説明 / 文字列型

string | integer | number | boolean | null

goods_condition_id

商品状態ID / 文字列型 / 01:新品 10:中古 99:その他

string | integer | number | boolean | null

goods_hit_syohin_alert_quantity

ヒット商品お知らせ個数 / 数値型

string | integer | number | boolean | null

goods_delivery_date_id

納期ID / 文字列型

string | integer | number | boolean | null

goods_designated_delivery_date

納期指定日 / 文字列型 / 納期IDが’date’の場合のみ有効

string | integer | number | boolean | null

goods_package_height

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

string | integer | number | boolean | null

goods_package_width

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

string | integer | number | boolean | null

goods_package_length

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

string | integer | number | boolean | null

goods_package_weight

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

string | integer | number | boolean | null

goods_first_available_date

販売開始日 / 日時型

string | integer | number | boolean | null

goods_last_available_date

販売終了日 / 日時型

string | integer | number | boolean | null

goods_tax_id

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

string | integer | number | boolean | null

goods_brand_name

ブランド名 / 文字列型

string | integer | number | boolean | null

goods_origin_place

原産地 / 文字列型

string | integer | number | boolean | null

goods_raw_materials

原材料 / 文字列型

string | integer | number | boolean | null

goods_preservation_method

保存方法 / 文字列型

string | integer | number | boolean | null

goods_warranty

保証書の有無 / 数値型 / 0:なし 1:あり

string | integer | number | boolean | null

goods_option_noshi_id

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

string | integer | number | boolean | null

goods_same_day_delivery_id

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

string | integer | number | boolean | null

goods_creation_date

作成日 / 日時型

string | integer | number | boolean | null

goods_last_modified_date

最終更新日 / 日時型

string | integer | number | boolean | null

goods_last_modified_null_safe_date

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

string | integer | number | boolean | null

goods_creator_id

作成担当者ID / 数値型

string | integer | number | boolean | null

goods_creator_name

作成担当者名 / 文字列型

string | integer | number | boolean | null

goods_last_modified_by_id

最終更新者ID / 数値型

string | integer | number | boolean | null

goods_last_modified_by_null_safe_id

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

string | integer | number | boolean | null

goods_last_modified_by_name

最終更新者名 / 文字列型

string | integer | number | boolean | null

goods_last_modified_by_null_safe_name

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

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "result": "success",
  "count": "1",
  "data": [
    {
      "goods_id": "TestP001",
      "goods_name": "登録時必須",
      "stock_quantity": "27",
      "supplier_name": "設定なし"
    }
  ],
  "access_token": "xxxxx",
  "access_token_end_date": "2017-04-15 13:03:47",
  "refresh_token": "xxxxx",
  "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"
}