Skip to content

カタログ項目を置換

put

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

このエンドポイントを使用して、カタログの項目を置換します。

item_id が見つからない場合、このエンドポイントはカタログにアイテムを作成します。このエンドポイントは同期的です。

See me in Postman

前提条件

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

レート制限

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

パスパラメーター

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

リクエストパラメーター

パラメーター 必須 データタイプ 説明
items 必須 配列 アイテムオブジェクトを含む配列。アイテムオブジェクトには、id フィールドを除き、カタログに存在するフィールドを含める必要があります。1つのリクエストにつき、1つのアイテムオブジェクトのみが許可されます。

リクエスト例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

curl --location --request PUT 'https://rest.iad-03.braze.com/catalogs/restaurants/items/restaurant1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "items": [
    {
      "Name": "Restaurant",
      "Loyalty_Program": false,
      "Location": {
        "Latitude": 33.6112,
        "Longitude": -117.8711
      },
      "Top_Dishes": [
        "Hamburger",
        "Deluxe Cheeseburger"
      ],
      "Open_Time": "2021-09-03T09:03:19.967+00:00"
    }
  ]
}'

応答

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

成功応答の例

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

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"
}

トラブルシューティング

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

エラー トラブルシューティング
arbitrary-error 任意のエラーが発生しました。もう一度試すか、サポートに連絡してください。
catalog-not-found カタログ名が有効であることを確認してください。
filtered-set-field-too-long フィールド値が、項目の文字数制限を超えるフィルターセットで使用されています。
id-in-body リクエスト本文の項目IDを削除してください。
ids-too-large 各アイテムIDの文字数制限は250文字です。
invalid-ids アイテムID名に使用できる文字は、アルファベット、数字、ハイフン、アンダースコアです。
invalid-fields APIリクエストで送信するすべてのフィールドが、すでにカタログに存在していることを確認してください。これは、エラーに記載されているIDフィールドとは関係ありません。
invalid-keys-in-value-object アイテムオブジェクトのキーに . または $ を含めることはできません。
item-already-exists そのアイテムはすでにカタログに存在しています。
item-array-invalid items はオブジェクトの配列でなければなりません。
items-too-large 各項目の文字数制限は5,000文字です。
request-includes-too-many-items 1つのリクエストにつき1つのカタログ項目のみ作成できます。
too-deep-nesting-in-value-object アイテムオブジェクトは50レベル以上のネストを持つことはできません。
unable-to-coerce-value アイテムタイプは変換できません。
New Stuff!