modifier plusieurs produits du catalogue
/catalogs/{catalog_name}/items
Utilisez cet endpoint pour modifier plusieurs éléments existants dans votre catalogue.
Chaque requête peut prendre en charge jusqu’à 50 objets. Cet endpoint est asynchrone.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation catalogs.update_items
.
Limite de débit
This endpoint has a shared rate limit of 16,000 requests per minute between all asynchronous 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. |
Paramètres de demande
Paramètre | Requis | Type de données | Description |
---|---|---|---|
items |
Requis | Tableau | Un tableau qui contient certains objets Produit. Les objets Produits devraient contenir des champs qui existent dans le catalogue. Jusqu’à 50 objets sont autorisés par requête. |
Exemple de demande
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
33
34
35
curl --location --request PATCH '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": {
"Latitude": 33.6112,
"Longitude": -117.8711
},
"Top_Dishes": {
"$add": [
"Biscuits",
"Coleslaw"
],
"$remove": [
"French Fries"
]
},
"Open_Time": "2021-09-03T09:03:19.967+00:00"
},
{
"id": "restaurant3",
"City": "San Francisco",
"Rating": 2,
"Top_Dishes": [
"Buffalo Wings",
"Philly Cheesesteak"
]
}
]
}'
Les opérateurs $add
et $remove
ne s’appliquent qu’aux champs de type tableau et ne sont pris en charge que par les endpoints PATCH.
Réponse
Trois réponses de code de statut existent pour cet endpoint : 202
, 400
et 404
.
Exemple de réponse réussie
Le code de statut 202
pourrait renvoyer le corps de réponse suivant.
1
2
3
{
"message": "success"
}
Exemple de réponse échouée
Le code de statut 400
pourrait renvoyer le corps de réponse suivant. 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": "invalid-fields",
"message": "Some of the fields given do not exist in the catalog",
"parameters": [
"id"
],
"parameter_values": [
"restaurant1"
]
}
],
"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.
Erreur | Résolution des problèmes |
---|---|
catalog-not-found |
Vérifiez que le nom du catalogue est valide. |
ids-too-large |
Les ID de produit ne peuvent pas contenir plus de 250 caractères. |
ids-not-strings |
Les ID de produit doivent être de type chaîne de caractères. |
ids-not-unique |
Les ID de produit doivent être uniques au sein de la requête. |
invalid-ids |
Ces ID de produit peuvent uniquement inclure des lettres, des chiffres, des traits d’union et des traits de soulignement. |
invalid-fields |
Confirmez que tous les champs que vous envoyez dans la requête API existent déjà dans le catalogue. Cela n’a rien à voir avec le champ ID mentionné dans l’erreur. |
invalid-keys-in-value-object |
Les clés d’objet de produit ne peuvent pas inclure . ou $ . |
items-missing-ids |
Il y a des produits qui n’ont pas d’ID de produit. Vérifiez que chaque produit possède un ID de produit. |
item-array-invalid |
items doit être un tableau d’objets. |
items-too-large |
Les valeurs de produits ne peuvent pas dépasser 5 000 caractères. |
request-includes-too-many-items |
Votre requête contient trop de produits. La limite de produit par requête est de 50. |
too-deep-nesting-in-value-object |
Les objets de produit ne peuvent pas avoir plus de 50 niveaux d’imbrication. |
unable-to-coerce-value |
Les types de produits ne peuvent pas être convertis. |