ReCORE.co-api

属性

属性検索

概要

• 属性情報の検索を行う

基本情報

• リクエストパス: GET /attributes
• スコープ: attribute:index
• 店舗IDの指定: 必要なし
• 基本制限レート: 5 rps

query

key	説明	制約など
ids	属性ID	整数のみ、カンマ区切りで複数指定可能
subject	対象	-
has_options	選択肢の有無で絞り込み	true または false
is_required	必須項目で絞り込み	true または false
is_pinned	表示固定で絞り込み	true または false
sc_category_id	カテゴリIDで絞り込み	整数のみ (*1)
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250

• *1) sc_category_idはproduct(商品)・item(在庫)の属性のみが対象です。

例

• Request

GET /attributes?subject=product&ids=1,2

• Response

[
  {
    "id": 1,
    "subject": "product",
    "key": "asin",
    "label": "ASIN",
    "description": "Amazon Standard Identification Number",
    "type": "single_text",
    "is_multiple": false,
    "has_options": false,
    "sort": 0,
    "is_required": false,
    "is_pinned": true,
    "scope": null,
    "mapping": { "leaves_key": "asin" },
    "constraints": [
      { "name": "regex", "value": "^[A-Z]{2}[0-9]{3}$" }
    ]
  }
]

key	type	説明
*	array<object>	属性
*.id	int	属性ID
*.subject	string	対象
*.key	string	属性キー
*.label	string	属性名
*.description	string | null	属性の説明文
*.type	string	属性タイプ
*.is_multiple	boolean	複数値か
*.has_options	boolean	選択肢を持つか (*1)
*.sort	int	表示順
*.is_required	boolean	必須か
*.is_pinned	boolean	表示を固定するか
*.scope	object | null	絞込条件
*.scope.category_ids	?array<int> | null	対象カテゴリID (*2)
*.mapping	object | null	外部連携キー
*.mapping.leaves_key	?string | null	商品DB連携キー (*3)
*.constraints	array<object> | null	値の制約
*.constraints.*.name	string	種別
*.constraints.*.value	?any	制約値

• *1) trueの属性の選択肢は属性選択肢検索で取得できます。

• *2) product(商品)・item(在庫)の属性のみ設定されます。

• *3) product(商品)の属性のみ設定されます。

• 対象(subject)

  • product 商品
  • item 在庫
  • member 会員
  • bas 店頭買取
  • big 一般仕入
  • bad 宅配買取
  • bap 質入れ
  • bac 委託仕入
  • sas 店頭販売
  • sig 一般販売
  • ec_order EC受注
  • item_change_price 在庫価格変更
  • item_activation 在庫品出し
  • item_change_store 在庫店間移動
  • item_change_location 在庫店内移動
  • item_inbound 在庫入庫
  • item_disposal 在庫廃棄
  • item_transfer 在庫振替

• 属性タイプ(type)

  • single_text 単一行テキスト
  • multi_text 複数行テキスト
  • numeric 数値
  • date 日付 (YYYY-MM-DD形式)
  • date_time 日時 (YYYY-MM-DD HH:mm:ss形式)
  • boolean 真偽値
  • json JSON
  • image 画像

属性選択肢検索

概要

• 指定した属性の選択肢の検索を行う

基本情報

• リクエストパス: GET /attributes/{attribute_id}/options
• スコープ: attribute:option:index
• 店舗IDの指定: 必要なし
• 基本制限レート: 5 rps

path

key	説明	制約など
attribute_id	属性ID	整数のみ

query

key	説明	制約など
q	選択肢値の部分一致検索	-
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250

例

• Request

GET /attributes/1/options?q=赤

• Response

[
  {
    "id": 10,
    "value": "赤",
    "sort": 0
  }
]

key	type	説明
*	array<object>	選択肢
*.id	int	選択肢ID
*.value	string	選択肢値
*.sort	int	表示順