Lister les détails du produit du catalogue
/catalogs/{catalog_name}/items/{item_id}
Utilisez cet endpoint pour renvoyer un produit de catalogue et son contenu.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation catalogs.get_item
.
Limite de débit
This endpoint has a shared rate limit of 50 requests per minute between all synchronous catalog item endpoints, as documented in API rate limits.
Paramètres de chemin
Paramètre | Requis | Type de données | Description |
---|---|---|---|
catalog_name |
Requis | Chaîne de caractères | Nom du catalogue. |
item_id |
Requis | Chaîne de caractères | L’ID du produit du catalogue. |
Paramètres de demande
Cet endpoint n’a pas de corps de demande.
Exemple de demande
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'
Réponse
Deux réponses de code de statut existent pour cet endpoint : 200
et 404
.
Exemple de réponse réussie
Le code de statut 200
pourrait renvoyer le corps de réponse suivant.
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"
}
Exemple de réponse échouée
Le code de statut 404
pourrait retourner la réponse suivante. Consultez la 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": "item-not-found",
"message": "Could not find item",
"parameters": [
"item_id"
],
"parameter_values": [
"restaurant34"
]
}
],
"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, le cas échéant.
Erreur | Résolution des problèmes |
---|---|
catalog-not-found |
Vérifiez que le nom du catalogue est valide. |
item-not-found |
Vérifiez que ce produit est dans le catalogue. |