ご利用マニュアル

Request 非表示化

アイテム情報の非表示化を行うAPIです。

Request 非表示化(type = disable)

Request

アイテム情報の非表示化を行います。非表示化は即時反映されます。

非表示化は一時的なもので、情報の更新(type = setitem)リクエストがあった場合は、翌日以降にレコメンドに再表示されます。

パラメタ

要否

説明

type

必須

処理種別。非表示化の場合は disable を指定

account

必須

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

recommend

必須

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

codes

必須

アイテムコード文字列。カンマ区切りで複数指定可能

Headers

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

Body

{
"type": "disable",
"account": [アカウント名],
"recommend": [レコメンド名],
"codes": [アイテムコード,,,]
}

利用例

  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 に “disable” をご指定ください。
    account にアカウント名、recommend にレコメンド名、codes に非表示化したいアイテムのコードを指定してください。
    {
    "type": "disable",
    "account": "test_account",
    "recommend": "test",
    "codes": “item_code1, item_code2,,,,"
    }

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

関連するマニュアル

関連するよくあるご質問

TOPへ