Skip to content

Créer un produit du catalogue

post

/catalogs/{catalog_name}/items/{item_id}

Utilisez cet endpoint pour créer un produit dans votre catalogue.

See me in Postman

Conditions préalables

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

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è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 requête

Paramètre Requis Type de données Description
items Requis Tableau Un tableau qui contient des objets produit. Les objets produit doivent contenir tous les champs existant dans le catalogue, à l’exception du champ id. Un seul objet produit est autorisé par requête.

Exemple de requête

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restaurants/items/restaurant1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "items": [
    {
      "Name": "Restaurant1",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 5,
      "Loyalty_Program": true,
      "Location": [-73.988103, 40.779109],
      "Preferences": {
        "favorite_brand": "Nike",
        "shirt_size": "L"
      },
      "Top_Dishes": [
        "Hamburger",
        "Deluxe Cheeseburger"
      ],
      "Created_At": "2022-11-01T09:03:19.967+00:00"
    }
  ]
}'

Réponse

Trois codes de statut existent pour cet endpoint : 201, 400 et 404.

Exemple de réponse réussie

Le code de statut 201 pourrait renvoyer le corps de réponse suivant.

1
2
3

{
  "message": "success"
}

Exemple de réponse en erreur

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-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 possibles et les étapes de résolution associées.

Erreur Résolution des problèmes
arbitrary-error Une erreur arbitraire est survenue. Veuillez réessayer ou contacter l’assistance.
catalog-not-found Vérifiez que le nom du catalogue est valide.
filtered-set-field-too-long La valeur du champ est utilisée dans un ensemble filtré qui dépasse la limite de caractères pour un produit.
id-in-body Supprimez tous les ID de produit dans le corps de la requête.
ids-too-large La limite de caractères pour chaque ID de produit est de 250 caractères.
invalid-ids Les caractères pris en charge pour les noms d’ID de produit sont les lettres, les chiffres, les tirets et les 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’est pas lié au champ ID mentionné dans l’erreur.
invalid-keys-in-value-object Les clés d’objet produit ne peuvent pas inclure . ou $.
item-already-exists Ce produit existe déjà dans le catalogue.
item-array-invalid items doit être un tableau d’objets.
items-too-large La limite de caractères pour chaque produit est de 5 000 caractères.
request-includes-too-many-items Vous ne pouvez créer qu’un seul produit de catalogue par requête.
too-deep-nesting-in-value-object Les objets produit ne peuvent pas avoir plus de 50 niveaux d’imbrication.
unable-to-coerce-value Les types de produit ne peuvent pas être convertis.
New Stuff!