Listar detalhes do item do catálogo

Use esse ponto de extremidade para retornar um item 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_item.

Limite de taxa

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

Parâmetros da jornada

Parâmetros de solicitação

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

Exemplo de solicitação

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

Resposta

Existem dois códigos de status para este endpoint: 200 e 404.

Exemplo de resposta bem-sucedida

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "items": [
    {
      "id": "restaurant3",
      "Name": "Restaurant1",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 5,
      "Loyalty_Program": true,
      "Open_Time": "2022-11-01T09:03:19.967Z"
    }
  ],
  "message": "success"
}

Exemplo de resposta de erro

O código de status 404 poderia retornar a seguinte 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": "item-not-found",
      "message": "Could not find item",
      "parameters": [
        "item_id"
      ],
      "parameter_values": [
        "restaurant34"
      ]
    }
  ],
  "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, se aplicável.