Skip to content

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

patch

/catalogs/{catalog_name}/items

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

各リクエストは最大50個のアイテムに対応できます。このエンドポイントは非同期です。

See me in Postman

前提条件

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

レート制限

このエンドポイントには、APIレート制限に記載されているように、すべての非同期カタログアイテムエンドポイント間で1分あたり16,000リクエストの共有レート制限があります。

パスパラメーター

パラメーター 必須 データタイプ 説明
catalog_name 必須 文字列 カタログ名。

リクエストパラメーター

パラメーター 必須 データタイプ 説明
items 必須 配列 アイテムオブジェクトを含む配列。アイテムオブジェクトには、カタログに存在するフィールドが含まれている必要があります。リクエストごとに最大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
36

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": [-73.988103, 40.779109],
      "Preferences": {
        "favorite_brand": "Nike",
        "shirt_size": "L"
      },
      "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 アイテムタイプは変換できません。
New Stuff!