ご利用マニュアル

Request 情報の更新

作成者: レコメンドサポート担当|2021.10.13

商品情報の更新を行うAPIです。
出力方法はJsonです。

Request 情報の更新(type = setitem)

Request

アイテム情報の更新を行います。即時反映はされず、朝/夜の1日2回の更新タイミングでレコメンドに反映されます。
単一のアイテム情報のみ指定できます。アイテムの項目名を指定しなければその項目の情報は更新されません。

パラメタ

要否

説明

type

必須

処理種別。アイテム情報の更新の場合は setitem を指定

account

必須

アカウント名
レコメンド管理画面にログインする際の「アカウントID」です。

recommend

必須

レコメンド名
レコメンド管理画面URL内のパスが、以下の構造になっています。
https://adm.rcmd.jp/アカウントID/レコメンド名/XXXXXXX
お手数ですが、レコメンド管理画面URLよりご確認をお願いします。

item

必須

更新したいアイテム情報を配列形式で指定

item に指定できる情報

項目名

要否

説明

code

必須

アイテムコード。

255文字以内の半角英数字、「-(ハイフン)」、「/(スラッシュ)」、「_(アンダースコア)を指定

url

必須

アイテムページのURL。URIエンコード後の文字長が1024文字以内の文字列指定

name

必須

アイテム名。255文字以内で指定

image

アイテム画像のURL。URLは255文字以内で指定

price

商品価格。半角数字、「,(カンマ)」のみ利用可能2147483647以下の数値を指定

category

カテゴリ情報。URIエンコード後の文字長が255文字以内の文字列指定

release_date

リリース日

YYYY-MM-DD、YYYY-MM-DD HH:MM:SS、YYYY/MM/DD、YYYY/MM/DD HH:MM:SS のフォーマットのみ利用可能

dysplay_start

掲載開始日。

YYYY-MM-DD、YYYY-MM-DD HH:MM:SS、YYYY/MM/DD、YYYY/MM/DD HH:MM:SS のフォーマットのみ利用可能

dysplay_end

掲載終了日。掲載開始日以降の日付を指定。

YYYY-MM-DD、YYYY-MM-DD HH:MM:SS、YYYY/MM/DD、YYYY/MM/DD HH:MM:SS のフォーマットのみ利用可能

stock

在庫。半角数字、「,(カンマ)」のみ利用可能2147483647以下の数値を指定

その他

ユーザ指定項目。レコメンドで利用したい情報を指定する。最大100個まで登録可能

Headers

Content-Type: application/json
Authorization: bearer [アクセストークン]

Body

{
"type": "setitem",
"account": [アカウント名],
"recommend": [レコメンド名],
"item": {
"code": [アイテムコード],
"url": [アイテムページのURL],
"name": [アイテム名],
"image": [アイテム画像のURL],
"price": [商品価格],
"category": [カテゴリ情報],
"release_date": [リリース日],
"stock": [在庫],
"tax": [税金],(ユーザ任意項目)
"info": [商品説明],(ユーザ任意項目)
  : }
}

利用例

  1. ユーザ認証を実施して、access_token を取得してください
    "access_token": "187113305cfd78f0afe3dfeb94a3f6b0a1e7ae1410a96abaaa1965477dd4dc16"
  2. 以下のURLへPOSTでリクエストを送信してください
    https://api.rcmd.jp/connector/items/manage
    リクエストヘッダには以下をご指定ください。1で取得した access_token はここで利用します。
    Content-Type: application/json
    Authorization: bearer
    187113305cfd78f0afe3dfeb94a3f6b0a1e7ae1410a96abaaa1965477dd4dc16
    アイテム情報の更新の場合は type に “setitem” をご指定ください。
    account にアカウント名、recommend にレコメンド名、item に更新したいアイテムの情報を指定してください。
    {
    "type": "setitem",
    "account": "test_account",
    "recommend": "test",
    “item": {
    "code": "testitem",
    "url": "http://test.rcmd.jp/products/detail.php?product_id=testitem",
    "name": "テストアイテム",
    "image": "/upload/save_image/testitem.jpg",
    "release_date": "2018/10/31 19:46:00" }
    }

  3. 成功の場合はリターンコード 200 が返却され、2で指定したアイテムの情報が更新されます。