複数のカタログアイテムを編集します

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

各要求は、最大 50 個の項目をサポートできます。このエンドポイントは非同期です。

前提 条件

このエンドポイントを使用するには、アクセス許可を持つ catalogs.update_items API キーが必要です。

レート制限

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

パス パラメーター

要求パラメーター

要求の例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
      },
      "Open_Time": "2021-09-03T09:03:19.967+00:00"
    },
    {
      "id": "restaurant3",
      "City": "San Francisco",
      "Rating": 2
    }
  ]
}'

応答

このエンドポイント202には、 400404

成功応答の例

状態コード 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 は、要求内で一意である必要があります。| アイテム 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 |アイテムの種類は変換できません。|