Les détaillants peuvent gérer les informations des produits dans leur catalogue à l’aide de divers points de terminaison d’API. Ces API vous permettent de faire ce qui suit :

• mettre à jour les stocks des produits ;
• supprimer des produits du catalogue ;
• obtenir des informations détaillées sur les produits.

Mettre à jour le stock d’un produit

Pour mettre à jour le stock d’un produit, vous devez resynchroniser le produit avec CitrusAd et redéfinir le stock sur zéro. Les détaillants effectuent généralement ces mises à jour quotidiennement pour refléter les changements suivants :

• mises à jour du nom du produit ;
• état du stock. Si le stock d’un produit est défini sur zéro, cela signifie que le produit est épuisé. Cependant, de nouveaux stocks peuvent arriver dès le lendemain.

Paramètres de la requête

Voici les paramètres de requête et de corps :

Paramètre de requête

Paramètre du corps

POST $BASE_URL/v1/catalog-products?teamId=<YOUR_TEAM_ID> HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "catalogProducts": [
        {
            "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
            "gtin": "23556578965543",
            "inventory": 0,
            "price": "19.99",
            "tags": [
                 "imageurl:https://your.image.host.com/image.jpg","name:Covergirl Clean 120 Creamy Natural Liquid Foundation30mL"
            ],
            "filters": [
                 "category:Health&Beauty","category:Grocery","Brand:Covergirl","Special_Flag:0"
            ]
        }
    ]
}

Supprimer des produits de votre catalogue

Une fois qu’un produit est inscrit dans votre catalogue, vous souhaiterez peut-être le supprimer par la suite. Pour ce faire, suivez les étapes ci-dessous.

Paramètres de la requête

Le point de terminaison accepte un code produit par requête. Il s’agit généralement de votre identifiant GTIN. Pour supprimer un produit, effectuez une requête HTTP DELETE comme suit :

DELETE $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE> HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>

Temps de traitement

La suppression du produit peut prendre entre 30 minutes et une heure.

📘

Important

Si un produit est en rupture de stock, il doit être défini sur 0 mais pas supprimé. La suppression d’un produit supprimera la possibilité pour les annonceurs de le sélectionner dans la plateforme CitrusAd, même lorsqu’il sera de nouveau en stock.

Gestion des erreurs

Si le produit est introuvable, cela signifie probablement qu’il n’a pas été importé dans le système CitrusAd.

Récupérer les informations du produit

Vous devrez peut-être récupérer ultérieurement les informations actuelles d’un produit dans votre catalogue. Pour ce faire, vous pouvez envoyer une requête HTTP GET comme suit :

GET $BASE_URL/v1/catalog-products/<CATALOG_ID>/<PRODUCT_CODE> HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>

Vous devriez recevoir les informations telles qu’importées dans le système CitrusAd pour le code produit spécifié.

📘

Remarque

Les mises à jour des produits ne sont pas traitées instantanément dans le système CitrusAd. CitrusAd peut prendre du temps à ingérer et refléter intégralement la mise à jour. Ne vous inquiétez pas si les informations d’un produit ne sont pas immédiatement mises à jour lorsque vous les récupérez.