Lister les détails de plusieurs produits du catalogue

Utilisez cet endpoint pour retourner plusieurs produits du catalogue et leur contenu.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation catalogs.get_items.

Limite de débit

Cet endpoint a une limite de débit partagée de 50 requêtes par minute entre tous les endpoints d’éléments de catalogue synchrones, comme documenté dans Limites de débit de l’API.

Paramètres de chemin

Paramètres de requête

Notez que chaque appel à cet endpoint retournera 50 produits. Pour un catalogue comportant plus de 50 produits, utilisez l’en-tête Link pour récupérer les données de la page suivante, comme indiqué dans l’exemple de réponse ci-dessous.

Paramètres de demande

Cet endpoint n’a pas de corps de demande.

Exemples de requêtes

Sans curseur

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'

Avec curseur

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'

Réponse

Trois codes de statut de réponse existent pour cet endpoint : 200, 400 et 404.

Exemple de réponse réussie

Le code de statut 200 pourrait retourner l’en-tête et le corps de réponse suivants.

Remarque

L’en-tête Link n’existera pas si le catalogue possède 50 produits ou moins. Pour les appels sans curseur, prev ne s’affichera pas. Lors de la consultation de la dernière page de produits, next ne s’affichera pas.

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

Exemple de réponse échouée

Le code de statut 400 pourrait renvoyer le corps de réponse suivant. Consultez la section Résolution des problèmes pour plus d’informations concernant les erreurs que vous pourriez rencontrer.

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

Résolution des problèmes

Le tableau suivant répertorie les erreurs renvoyées possibles et les étapes de résolution des problèmes associées.