REST API Importation des remplacements de produits (V1)
Cette source est utilisée pour l'importation des données de remplacement de produits dans Quant. Le format d'entrée et de sortie est JSON.
Utilisez la section Tâches automatiques pour créer et configurer une importation. Une fois créée, la liste des tâches contiendra l'ID que vous devrez transmettre dans l'URL de la requête.
Paramètres
Avant d'utiliser l'API, vous devez modifier les attributs suivants dans l'onglet Paramètres :
- Cochez l'attribut Activé pour activer la tâche.
- Dans Utilisateurs avec autorisation API, sélectionnez un ou plusieurs utilisateurs ayant le rôle Robot et pouvant exécuter la tâche.
- Dans Mappage des attributs de remplacement de produit, sélectionnez les attributs à importer et, si nécessaire, modifiez leurs clés JSON.
- Nous recommandons également de renseigner les e-mails pour les notifications, où vous pouvez saisir une ou plusieurs adresses e-mail auxquelles seront envoyés des e-mails relatifs aux statuts d’erreur.
Attributs
Attribut | Description | Type |
Activé | Spécifie si la tâche automatique est active et peut recevoir des données. | oui/non |
Titre | Nom personnalisé de la tâche automatique. | texte |
Description | Description personnalisée du rôle de la tâche automatique. | texte formaté |
Remarques | Notes. | texte long |
Emails pour notifications | Une ou plusieurs adresses e-mail pour recevoir les erreurs éventuelles. | liste de chaînes |
Utilisateurs avec autorisation API | Utilisateurs avec le rôle Robot autorisés à exécuter la tâche. | liste des utilisateurs |
Remplacer dans les planogrammes préparés | Détermine si les remplacements doivent aussi être effectués dans les planogrammes préparés. | oui/non |
Temps de mise en œuvre en jours | Délai en jours pour la mise en œuvre du planogramme remplacé. | |
Photo de mise en œuvre requise | Indique s'il est obligatoire de fournir une photo d'implémentation en cas de remplacement dans le planogramme implémenté. | oui/non |
Attribut de correspondance | Attribut de produit utilisé pour faire correspondre les articles importés aux produits existants. | sélection |
Délai en secondes avant nouvelle tentative | Délai recommandé en secondes avant de réessayer la requête en cas d'erreur 503. | nombre entier |
Mappage des attributs de remplacement de produit | Correspondance des champs JSON avec les attributs à importer. | type complexe |
Requête
/v1/import/product-replacement/{task_id}
Paramètre | Valeur |
URL | Ajoutez ?debug à l'URL pour afficher aussi les avertissements. Sinon, seules les messages d'erreurs sont affichés. |
Header | Accept: application/json |
Header | Content-type: application/json |
Header | Authorization: Bearer <TOKEN> Le TOKEN s'obtient via /authenticate (voir la section Connexion). |
Mèthode | POST |
Le contenu de la requête est un tableau d'objets JSON contenant les clés définies dans le paramètre Mappage des attributs de remplacement de produit.
II est important que la requête soit conforme aux standards du format JSON. Vous trouverez la définition complète de ces standards ici. Veuillez envoyer les valeurs des attributs numériques sans guillemets, voir l’exemple.
Réponse
Clé | Valeur |
Status | Une chaîne indiquant l'état final de l'importation.
|
Warnings | Il est facultatif, c'est-à-dire qu'il n'est inclus que si le paramètre ?debug est présent dans l'URL et que l'importation a généré au moins un avertissement. Liste des chaînes d'avertissement. |
Errors | Facultatif - inclus uniquement si l'importation a généré au moins une erreur. Liste des chaînes d'avertissement. |
Total Lines | Facultatif - inclus uniquement si l'importation ne s'est pas terminée avec le statut FAILURE. Nombre d'enregistrements en entrée. |
Produits manquants | Facultatif - uniquement inclus si l'importation ne s'est pas terminée avec le statut « FAILURE » Nombre d'enregistrements ignorés car le produit auquel l'enregistrement fait référence n'a pas été trouvé. |
Produits dupliqués | Facultatif - inclus uniquement si l'importation ne s'est pas terminée avec le statut « FAILURE » Nombre d'enregistrements ignorés car ce produit a déjà été importé dans la même requête. |
Nombre de magasins manquants | Facultatif - inclus uniquement si l'importation ne s'est pas terminée avec le statut « FAILURE » Nombre d'enregistrements pour lesquels le magasin référencé n'a pas été trouvé. |
ID vides | Facultatif - inclus uniquement si l'importation ne s'est pas terminée avec le statut « FAILURE » Nombre d'enregistrements dans lesquels certains ID étaient vides. |
Codes de statut
Statut | Valeur |
200 OK | Importation réussie avec le statut « SUCCESS » ou « PARTIAL_SUCCESS ». La réponse peut contenir des avertissements ou des erreurs mineures. |
400 Bad Request | Paramètres de tâche ou requête incorrects. |
401 Unauthorized | Le jeton d'autorisation invalide ou l'utilisateur connecté avec ce jeton n'est pas autorisé à exécuter cette tâche. |
404 Not Found | Aucune tâche trouvée avec l'ID spécifié dans l'URL. |
500 Internal Server Error | Une erreur serveur critique s'est produite lors de l'importation. |
503 Service Unavailable | La tâche est déjà en cours d'exécution. Réessayez de lancer la tâche après un délai indiqué dans l'en-tête de réponse Retry-After. |
Journal d'exécution
Dans Quant, en plus des paramètres des tâches, vous pouvez également consulter l'historique des importations individuelles, avec les statistiques, erreurs et avertissements.
Si vous sélectionnez un enregistrement spécifique, vous pouvez afficher ses détails en cliquant sur le bouton Afficher les éléments.
Requête
curl -X POST --location "http://[YOUR_COMPANY].iquant.eu/v1/import/product-replacements/54?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d "[{ \"Primary Product ID\": \"100001\", \"Replacement ID\": \"12345\", \"Store ID\": \"Prague 1\" }]"
Réponse
{
"Status": "SUCCESS",
"Total Lines": 1,
"Missing Products": 0,
"Empty IDs": 0,
"Duplicated Products": 0,
"Number of Missing Stores": 0
}