Substituir itens do catálogo

Use este endpoint para substituir vários itens no seu catálogo.

Se um item de catálogo não existir, esse endpoint criará o item no seu catálogo. Cada solicitação pode suportar até 50 itens de catálogo. Esse endpoint é assíncrono.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão catalogs.replace_items.

Limite de taxa

Esse endpoint tem um limite de taxa compartilhado de 16.000 solicitações por minuto entre todos os endpoints assíncronos de itens de catálogo, conforme documentado em Limites de taxa da API.

Parâmetros de jornada

Parâmetros de solicitação

Exemplo de solicitação

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
curl --location --request PUT '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": [
        "Hamburger",
        "Deluxe Cheeseburger"
      ],
      "Open_Time": "2021-09-03T09:03:19.967+00:00"
    },
    {
      "id": "restaurant3",
      "City": "San Francisco",
      "Rating": 2,
      "Top_Dishes": [
        "Hot Dog",
        "French Fries"
      ]
    }
  ]
}'

Nota

O campo Location usa o tipo de dados geo, que espera um vetor formatado como [longitude, latitude].

Resposta

Há três respostas de código de status para esse endpoint: 202, 400 e 404.

Nota

O sistema também pode retornar uma resposta 400 se a sua empresa tiver atingido o limite de armazenamento do catálogo. A versão gratuita dos catálogos tem um limite de 100 MB. Para saber mais sobre os níveis de armazenamento e como fazer upgrade, consulte Limitações de armazenamento de dados.

Exemplo de resposta bem-sucedida

O código de status 202 poderia retornar o seguinte corpo de resposta.

1
2
3
{
  "message": "success"
}

Exemplo de resposta de erro

O código de status 400 poderia retornar o seguinte corpo de resposta. Consulte Solução de problemas para obter mais informações sobre os erros que você pode encontrar.

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

Solução de problemas

A tabela a seguir lista os possíveis erros retornados e as etapas de solução de problemas associadas.