Skip to content

複数のカタログ項目を編集する

patch

/catalogs/{catalog_name}/items

このエンドポイントを使用して、カタログ内の複数の既存アイテムを編集する。

各リクエストは最大50個の項目まで対応できます。このエンドポイントは非同期である。

See me in Postman

前提条件

このエンドポイントを使用するには、catalogs.update_items 権限を持つ API キーが必要です。

レート制限

パスパラメーター

パラメーター required データ型 説明
catalog_name 必須 string カタログ名。

リクエストパラメーター

パラメーター required データ型 説明
items required 配列 アイテム・オブジェクトを含む配列。項目オブジェクトには、カタログに存在するフィールドを含める必要があります。1回のリクエストにつき、アイテムオブジェクトは50個まで認められる。

リクエスト例

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
33
34
35

curl --location --request PATCH 'https://rest.iad-03.braze.com/catalogs/restaurants/items' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "items": [
    {
      "id": "restaurant1",
      "Name": "Restaurant",
      "Loyalty_Program": false,
      "Location": {
        "Latitude": 33.6112,
        "Longitude": -117.8711
      },
      "Top_Dishes": {
        "$add": [
          "Biscuits",
          "Coleslaw"
        ],
        "$remove": [
          "French Fries"
        ]
      },
      "Open_Time": "2021-09-03T09:03:19.967+00:00"
    },
    {
      "id": "restaurant3",
      "City": "San Francisco",
      "Rating": 2,
      "Top_Dishes": [
        "Buffalo Wings",
        "Philly Cheesesteak"
      ]
    }
  ]
}'

応答

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

成功応答の例

ステータスコード 202 は、次の応答本文を返す可能性があります。

1
2
3

{
  "message": "success"
}

エラー応答例

ステータスコード 400 は、次の応答本文を返す可能性があります。遭遇する可能性のあるエラーの詳細については、「トラブルシューティング」を参照のこと。

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

{
  "errors": [
    {
      "id": "invalid-fields",
      "message": "Some of the fields given do not exist in the catalog",
      "parameters": [
        "id"
      ],
      "parameter_values": [
        "restaurant1"
      ]
    }
  ],
  "message": "Invalid Request"
}

トラブルシューティング

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

エラー トラブルシューティング
catalog-not-found カタログ名が有効であることを確認する。
ids-too-large 項目 ID は250文字以内にする必要があります。
ids-not-strings 項目 ID は文字列型でなければなりません。
ids-not-unique 項目 ID はリクエスト内で一意でなければなりません。
invalid-ids 項目 ID には、英字、数字、ハイフン、アンダースコアのみを使用できます。
invalid-fields APIリクエストで送信するすべてのフィールドが、すでにカタログに存在していることを確認する。これは、エラーに記載されている ID フィールドとは関係ありません。
invalid-keys-in-value-object 項目オブジェクトのキーに . または $ を含めることはできません。
items-missing-ids アイテムIDを持たないアイテムがある。各項目が項目 ID を持っていることを確認します。
item-array-invalid items はオブジェクト配列でなければなりません。
items-too-large 項目値は5,000文字を超えることはできない。
request-includes-too-many-items リクエスト内に項目が多すぎますリクエストごとの項目の上限は50個です。
too-deep-nesting-in-value-object アイテム・オブジェクトは50レベル以上の入れ子を持つことはできない。
unable-to-coerce-value 項目タイプは変換できません。
Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!