Listar vários detalhes de itens do catálogo

Use esse endpoint para retornar vários itens de catálogo e seu conteúdo.

Pré-requisitos

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

Limite de taxa

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

Parâmetros de jornada

Parâmetros de consulta

Observe que cada chamada a esse endpoint retornará 50 itens. Para um catálogo com mais de 50 itens, use o cabeçalho Link para recuperar os dados na próxima página, conforme mostrado no exemplo de resposta a seguir.

Parâmetros de solicitação

Não há corpo de solicitação para esse endpoint.

Exemplos de solicitações

Sem cursor

1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/catalogs/restaurants/items' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Com cursor

1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/catalogs/restaurants/items?cursor=c2tpcDow' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Resposta

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

Exemplo de resposta bem-sucedida

O código de status 200 poderia retornar o seguinte cabeçalho e corpo de resposta.

Nota

O cabeçalho Link não existirá se o catálogo tiver até 50 itens. Nas chamadas sem cursor, prev não será exibido. Ao visualizar a última página de itens, next não será exibido.

1
Link: </catalogs/all_restaurants/items?cursor=c2tpcDow>; rel="prev",</catalogs/all_restaurants/items?cursor=c2tpcDoxMDA=>; rel="next"

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
{
  "items": [
    {
      "id": "restaurant1",
      "Name": "Restaurant1",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 5,
      "Loyalty_Program": true,
      "Open_Time": "2022-11-02T09:03:19.967Z"
    },
    {
      "id": "restaurant2",
      "Name": "Restaurant2",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 10,
      "Loyalty_Program": true,
      "Open_Time": "2022-11-02T09:03:19.967Z"
    },
    {
      "id": "restaurant3",
      "Name": "Restaurant3",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 5,
      "Loyalty_Program": false,
      "Open_Time": "2022-11-02T09:03:19.967Z"
    }
  ],
  "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 saber mais 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-cursor",
      "message": "'cursor' is not valid",
      "parameters": [
        "cursor"
      ],
      "parameter_values": [
        "bad-cursor"
      ]
    }
  ],
  "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.