コンテンツにスキップ

商品カテゴリ検索

POST

/api_v1_master_goodscategory/search

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'access_token=xxxxxxxxx&refresh_token=xxxxxxxxx&fields=xxxxxxxx,xxxxxxx&goods_category_id-like=xxxxx&offset=0&limit=2' https://api.next-engine.org/api_v1_master_goodscategory/search

// POST /api_v1_master_goodscategory/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_goodscategory/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_goodscategory/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_goodscategory/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_category_id

商品カテゴリID / 数値型

string | integer | number | boolean | null

goods_category_goods_id

商品コード / 文字列型

string | integer | number | boolean | null

goods_category_mall_id

モールコード / 数値型

string | integer | number | boolean | null

goods_category_mall_category_id

カテゴリ(ID) / 数値型 / モールの場合、本カラムにモールカテゴリIDが設定される

string | integer | number | boolean | null

goods_category_text

カテゴリ(テキスト) / 文字列型 / カートの場合、本カラムに店舗カテゴリのテキストが設定される

string | integer | number | boolean | null

goods_category_deleted_flag

削除フラグ / 文字列型

string | integer | number | boolean | null

goods_category_creation_date

作成日 / 日時型

string | integer | number | boolean | null

goods_category_last_modified_date

最終更新日 / 日時型

string | integer | number | boolean | null

goods_category_last_modified_null_safe_date

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

string | integer | number | boolean | null

goods_category_creator_id

作成担当者ID / 数値型

string | integer | number | boolean | null

goods_category_creator_name

作成担当者名 / 文字列型

string | integer | number | boolean | null

goods_category_last_modified_by_id

最終更新者ID / 数値型

string | integer | number | boolean | null

goods_category_last_modified_by_null_safe_id

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

string | integer | number | boolean | null

goods_category_last_modified_by_name

最終更新者名 / 文字列型

string | integer | number | boolean | null

goods_category_last_modified_by_null_safe_name

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

string | integer | number | boolean | null

key

additional properties

any

Example

{
  "result": "success",
  "count": "2",
  "data": [
    {
      "goods_category_id": "1",
      "goods_category_goods_id": "TestP001",
      "goods_category_mall_id": "90",
      "goods_category_text": "test product category",
      "goods_category_deleted_flag": "1",
      "goods_category_creation_date": "2017-02-09 13:45:13",
      "goods_category_last_modified_date": "2017-02-10 16:37:16",
      "goods_category_last_modified_null_safe_date": "2017-02-10 16:37:16",
      "goods_category_creator_id": "10003",
      "goods_category_creator_name": "xxxxx",
      "goods_category_last_modified_by_id": "10003",
      "goods_category_last_modified_by_null_safe_id": "10003",
      "goods_category_last_modified_by_name": "xxxxx",
      "goods_category_last_modified_by_null_safe_name": "xxxxx",
      "mall_category_id": null,
      "mall_category_mall_id": null,
      "mall_category_code": null,
      "mall_category_parent_mall_category_id": null,
      "mall_category_name": null,
      "mall_category_full_name": null,
      "mall_category_deleted_flag": null,
      "mall_category_creation_date": null,
      "mall_category_last_modified_date": null,
      "mall_category_last_modified_null_safe_date": null,
      "mall_category_creator_id": null,
      "mall_category_creator_name": null,
      "mall_category_last_modified_by_id": null,
      "mall_category_last_modified_by_null_safe_id": null,
      "mall_category_last_modified_by_name": null,
      "mall_category_last_modified_by_null_safe_name": null
    },
    {
      "goods_category_id": "2",
      "goods_category_goods_id": "TestP001",
      "goods_category_mall_id": "15",
      "goods_category_text": "",
      "goods_category_deleted_flag": "0",
      "goods_category_creation_date": "2017-02-09 13:51:39",
      "goods_category_last_modified_date": "2017-02-09 13:51:39",
      "goods_category_last_modified_null_safe_date": "2017-02-09 13:51:39",
      "goods_category_creator_id": "10003",
      "goods_category_creator_name": "xxxxx",
      "goods_category_last_modified_by_id": "10003",
      "goods_category_last_modified_by_null_safe_id": "10003",
      "goods_category_last_modified_by_name": "xxxxx",
      "goods_category_last_modified_by_null_safe_name": "xxxxx",
      "mall_category_id": "31402",
      "mall_category_mall_id": "15",
      "mall_category_code": "2084240603",
      "mall_category_parent_mall_category_id": "31400",
      "mall_category_name": "子ども用",
      "mall_category_full_name": "オークション > ファッション > ハンドメイド > 子ども用",
      "mall_category_deleted_flag": "0",
      "mall_category_creation_date": "2014-11-05 15:16:43",
      "mall_category_last_modified_date": "2015-01-19 11:45:24",
      "mall_category_last_modified_null_safe_date": "2015-01-19 11:45:24",
      "mall_category_creator_id": "9999",
      "mall_category_creator_name": "管理者",
      "mall_category_last_modified_by_id": "9999",
      "mall_category_last_modified_by_null_safe_id": "9999",
      "mall_category_last_modified_by_name": "管理者",
      "mall_category_last_modified_by_null_safe_name": "管理者"
    }
  ],
  "access_token": "xxxxx",
  "access_token_end_date": "2017-04-18 11:19:26",
  "refresh_token": "xxxxx",
  "refresh_token_end_date": "2017-04-20 11:19:26"
}

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