Skip to content

カタログ項目の詳細を一覧表示

get

/catalogs/{catalog_name}/items/{item_id}

カタログ項目とその内容を返すには、このエンドポイントを使用します。

See me in Postman

前提条件

このエンドポイントを使用するには、catalogs.get_item パーミッションを持つAPI キーが必要です。

レート制限

This endpoint has a shared rate limit of 50 requests per minute between all synchronous catalog item endpoints, as documented in API rate limits.

経路パラメータ

パラメータ｜必須｜データ型｜説明      
catalog_name ｜必須｜文字列｜カタログ名。      
item_id 必須 String カタログ項目のID。

リクエストパラメータ

このエンドポイントにはリクエストボディがない。

リクエスト例

1
2
3

curl --location --request GET 'https://rest.iad-03.braze.com/catalogs/restaurants/items/restaurant1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

応答

このエンドポイントには、200 と404 の2つのステータスコード・レスポンスがある。

成功応答例

ステータスコード200 、以下のレスポンスボディを返すことができる。

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
  "items": [
    {
      "id": "restaurant3",
      "Name": "Restaurant1",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 5,
      "Loyalty_Program": true,
      "Open_Time": "2022-11-01T09:03:19.967Z"
    }
  ],
  "message": "success"
}

エラー応答例

ステータスコード404 。遭遇する可能性のあるエラーの詳細については、「トラブルシューティング」を参照してください。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
  "errors": [
    {
      "id": "item-not-found",
      "message": "Could not find item",
      "parameters": [
        "item_id"
      ],
      "parameter_values": [
        "restaurant34"
      ]
    }
  ],
  "message": "Invalid Request"
}

トラブルシューティング

次の表は、返される可能性のあるエラーと、該当する場合はそれに関連するトラブルシューティングの手順を示したものです。

トラブルシューティング  
catalog-not-found カタログ名が有効であることを確認する。
item-not-found ｜アイテムがカタログに掲載されているか確認する。  
  Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!