ReCORE.co-api

カタログ

カタログ検索

概要

• カタログ情報の検索を行う

基本情報

• リクエストパス: GET /products
• JWTスコープ: product:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

query

key	説明	制約など
ids	カタログID	整数のみ、カンマ区切りで複数指定可能
codes	カタログコード	カンマ区切りで複数指定可能
alias_codes	代替商品コード	カンマ区切りで複数指定可能
statuses	ステータス	カンマ区切りで複数指定可能
title	タイトル	-
category_id	カテゴリID	整数のみ
created_at_from	作成日から	2024-04-12 12:08:38 形式
created_at_to	作成日まで	同上
updated_at_from	更新日から	同上
updated_at_to	更新日まで	同上
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

例

• Request

GET /products?ids=76369

• Response

[
  {
    "id": 76369,
    "code": "PD1CBEB3VM4C",
    "alias_code": null,
    "status": "ACTIVE",
    "title": "ファミコン通信 (カドカワエンタメムック)",
    "attribute": {
      "jan": "9784047332027",
      "asin": "404733202X",
      "brand": "KADOKAWA",
      "manufacturer": "KADOKAWA",
      "release_date": "2016-11-10"
    },
    "image_urls": [
      "https://images-na.ssl-images-amazon.com/images/I/61Zd0Djx-1L.jpg",
      "https://images-na.ssl-images-amazon.com/images/I/51pxyjean-L.jpg",
      "https://images-na.ssl-images-amazon.com/images/I/61ZEDO5xnML.jpg",
      "https://images-na.ssl-images-amazon.com/images/I/61CHKtdux9L.jpg"
    ],
    "category": {
      "id": 1,
      "name": "その他",
      "ancestors": []
    },
    "created_at": 1673411650,
    "updated_at": 1673411650
  }
]

key	type	説明
*	array<object>	カタログ
*.id	int	カタログID
*.code	string	カタログコード
*.alias_code	string | null	代替商品コード
*.status	string	ステータス
*.title	string	商品名
*.attribute	object | null	商品属性
*.image_urls	array<string>	商品画像URL
*.category	object	カテゴリ
*.category.id	int	カテゴリID
*.category.name	string	カテゴリ名
*.category.ancestors	array<object>	親カテゴリ、カテゴリ先頭から並ぶ
*.category.ancestors.*.id	int	親カテゴリID
*.category.ancestors.*.name	name	親カテゴリ名
*.created_at	int | null	作成日時
*.updated_at	int | null	更新日時

カタログ取得

概要

• カタログ情報を1件取得する

基本情報

• リクエストパス: GET /products/{product_id}
• JWTスコープ: product:show
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

GET /products/76369

• Response

カタログ検索のresponse[0]と同様

カタログ作成

概要

• カタログ情報を作成する

基本情報

• リクエストパス: POST /products
• JWTスコープ: product:store
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
alias_code	?string | null	代替商品コード	50文字まで
status	?string	ステータス	デフォルト:ACTIVE
title	string	商品名	空不可
attribute	?object	商品属性	-
image_urls	?array<string>	商品画像URL	(*1)
category_id	?int	カテゴリID	-

• *1) ファイルアップロード(公開ファイル)で取得したファイルURLを使用

例

• Request

POST /products

{
  "alias_code": "abc",
  "title": "テスト商品",
  "image_urls": ["https://***", "https://***"]
}

• Response

カタログ取得と同様

カタログ更新

概要

• カタログ情報を更新する

基本情報

• リクエストパス: PUT /products/{product_id}
• JWTスコープ: product:update
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
alias_code	?string | null	代替商品コード	50文字まで
status	?string	ステータス	-
title	?string	商品名	空不可
attribute	?object	商品属性	(*1)
image_urls	?array<string>	商品画像URL	(*2) (*3)
category_id	?int	カテゴリID	-

• *1) 既存の項目とマージされる、キーを削除したい場合はnullを指定
• *2) ファイルアップロード(公開ファイル)で取得したファイルURLを使用
• *3) 既存の項目とマージされず完全上書きとなる、追記したい場合は予め取得API等で既存の値を取得しておく

例

• Request

PUT /products/76369

{
  "attribute": {
    "color": "red",
    "jan": null
  },
  "image_urls": ["https://***", "https://***"]
}

• Response

カタログ取得と同様

カタログ一括作成

概要

• カタログ情報を一括作成する

基本情報

• リクエストパス: POST /products/bulk
• JWTスコープ: product:bulk:store
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
*	array<object>	-	1件以上 1000件まで
*.*	-	(以下カタログ作成と同様)	-

例

• Request

POST /products/bulk

[
  {
    "title": "テスト商品",
    "image_urls": ["https://***", "https://***"]
  }
]

• Response

カタログ検索と同様

カタログ一括更新

概要

• カタログ情報を一括更新する

基本情報

• リクエストパス: PUT /products/bulk
• JWTスコープ: product:bulk:update
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
*	array<object>	-	1件以上 1000件まで
*.id	int	カタログID	-
*.*	-	(以下カタログ更新と同様)	-

例

• Request

PUT /products/bulk

[
  {
    "id": 234,
    "attribute": {
      "color": "red",
      "jan": null
    },
    "image_urls": ["https://***", "https://***"]
  }
]

• Response

カタログ検索と同様

買取販売推奨価格取得

概要

• 売買価格ルール設定(店舗別)で設定した価格を取得する
• 価格はモードが固定値の場合のみ返す

基本情報

• リクエストパス: GET /products/price_suggests
• JWTスコープ: product:price_suggest:index
• 必須個別JWTパラメータ: store_id (またはX-Store-Idヘッダ)
• レートリミット: 5 rps

query

key	説明	制約など
product_ids	カタログID	必須、整数のみ、カンマ区切りで複数指定可能

例

• Request

GET /products/price_suggests?product_ids=76369,76368

• Response

[
  {
    "product_id": 76369,
    "suggests": []
  },
  {
    "product_id": 76368,
    "suggests": [
      {
        "grade_id": 1,
        "grade_name": "新品",
        "buy_price": 123,
        "sell_price": 444
      },
      {
        "grade_id": 6,
        "grade_name": "未使用",
        "buy_price": 123,
        "sell_price": 444
      }
    ]
  }
]

key	type	説明
*	array<object>	-
*.product_id	int	カタログID
*.suggests	array<object>	-
*.suggests.*.grade_id	int	グレードID
*.suggests.*.grade_name	string	グレード名
*.suggests.*.buy_price	int | null	買取価格設定値
*.suggests.*.sell_price	int | null	販売価格設定値

商品属性検索

概要

• 商品属性情報の検索を行う

基本情報

• リクエストパス: GET /products/attributes
• JWTスコープ: product:attribute:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

query

key	説明	制約など
ids	在庫ID	整数のみ、カンマ区切りで複数指定可能
category_id	カテゴリID	-
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250

例

• Request

GET /products/attributes?ids=1,2

• Response

[
  {
    "id": 1,
    "key": "asin",
    "label": "ASIN",
    "type": "TEXT",
    "sort": 0,
    "is_required": false
  }
]

key	type	説明
*	array<object>	商品属性
*.key	string	商品属性キー
*.label	string	商品属性名
*.type	string	属性タイプ
*.sort	int	表示順
*.is_required	boolean	必須項目かどうか