Skip to content

複数のカタログアイテムの詳細を一覧表示する

get

/catalogs/{catalog_name}/items

このエンドポイントを使用して、複数のカタログアイテムとそのコンテンツを返します。

See me in Postman

前提条件

このエンドポイントを使用するには、catalogs.get_items 権限を持つ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 必須 文字列 カタログの名前。

クエリパラメーター

このエンドポイントへの各呼び出しは、50 個の項目を返すことに注意してください。項目数が50 を超えるカタログの場合は、Link ヘッダを使用して、次のページのデータを取得します(応答例を参照)。

パラメータ 必須 データ型 説明
cursor オプション 文字列 カタログアイテムのページ分割を決定します。

要求パラメータ

このエンドポイントのリクエストボディはありません。

リクエスト例

カーソルなし

1
2
3

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

カーソルあり

1
2
3

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

レスポンス

このエンドポイントには、200、400、404 の3 つのステータスコード応答があります。

成功応答の例

ステータスコード200 は、以下のレスポンスヘッダと本文を返す可能性があります。

1

Link: </catalogs/all_restaurants/items?cursor=c2tpcDow>; rel="prev",</catalogs/all_restaurants/items?cursor=c2tpcDoxMDA=>; rel="next"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

{
  "items": [
    {
      "id": "restaurant1",
      "Name": "Restaurant1",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 5,
      "Loyalty_Program": true,
      "Open_Time": "2022-11-02T09:03:19.967Z"
    },
    {
      "id": "restaurant2",
      "Name": "Restaurant2",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 10,
      "Loyalty_Program": true,
      "Open_Time": "2022-11-02T09:03:19.967Z"
    },
    {
      "id": "restaurant3",
      "Name": "Restaurant3",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 5,
      "Loyalty_Program": false,
      "Open_Time": "2022-11-02T09:03:19.967Z"
    }
  ],
  "message": "success"
}

エラーレスポンス例

ステータスコード400 は、以下のレスポンスボディを返す可能性があります。発生する可能性のあるエラーの詳細については、トラブルシューティングを参照してください。

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

{
  "errors": [
    {
      "id": "invalid-cursor",
      "message": "'cursor' is not valid",
      "parameters": [
        "cursor"
      ],
      "parameter_values": [
        "bad-cursor"
      ]
    }
  ],
  "message": "Invalid Request"
}

トラブルシューティング

次の表に、返される可能性のあるエラーと関連するトラブルシューティング手順を示します。

エラー トラブルシューティング
catalog-not-found カタログ名が有効であることを確認します。
invalid-cursor cursor が有効であることを確認します。
  GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!