REST API Exportation des données produit spécifiques au magasin V1
Utilisez cette ressource pour exporter les données produit de Quant spécifiques à chaque magasin. Elle utilise actuellement le format JSON en entrée et en sortie.
Utilisez la section Tâches automatiques pour créer et configurer une exportation. Une fois créée, la liste des tâches affichera l'ID que vous devez passer dans l'URL de la requête.
Tâche automatique
ID de la tâche
Paramètres
Avant d'utiliser l'API, vous devez modifier les attributs suivants dans l'onglet Paramètres :
- Cochez l'attribut Activé pour autoriser 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 REST Mappage des attributs produit exportables pour le magasin, sélectionnez les attributs à exporter et modifiez éventuellement 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 |
Délai en secondes avant nouvelle tentative | Nombre de secondes pendant lesquelles le client doit attendre avant de réessayer l'exportation en cas de file d'attente de requêtes vers le serveur trop longue. | nombre entier |
REST Mappage des attributs de produit exportables pour le magasin | Mappage contenant une entrée pour chaque attribut à exporter. | type complexe |
Unité de mesure | Unité comme cm, mm, etc. | sélection |
Format de date | Format de date, par ex. 31.12.19 | sélection |
Format date et heure | Format de date et heure, par ex. 19.12.31 23:59:59 | sélection |
Séparateur des éléments de liste | Symbole utilisé pour séparer les éléments dans une liste de valeurs. | symbole |
Ensemble de produits | Permet de sélectionner les produits à exporter. | sélection |
Magasins | Permet de sélectionner les magasins à exporter. | sélection |
Paramètres
Requête
/v1/export/store-specific-product-data/{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). |
Method | POST |
Le contenu de la requête est un objet JSON contenant les clés suivantes :
Clé | Valeur |
StoreIds | Dans la requête, vous devez indiquer pour quel magasin les données produit doivent être exportées. Un seul magasin peut être sélectionné à la fois. Par exemple, si un magasin avec l'ID « 12 » n'est pas inclus dans les paramètres de la tâche automatique, l'export retournera uniquement une valeur vide. Exemple: { "StoreIds":"12"} |
Réponse
Clé | Valeur |
Status | Une chaîne indiquant l'état final de l'exportation.
|
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'exportation a généré au moins un avertissement. Liste des chaînes d'avertissement. |
Errors | Facultatif - inclus uniquement si l'exportation a généré au moins une erreur. Liste des chaînes d'avertissement. |
Total Lines | Facultatif - inclus uniquement si l'exportation ne s'est pas terminée avec le statut « FAILURE ». Nombre d'enregistrements d'entrée. |
Ignored Products | Facultatif - Inclus uniquement si l'exportation ne s'est pas terminée avec le statut « FAILURE ». Nombre de produits de l'entrée qui n'ont pas été exportés. Les raisons possibles sont les suivantes :
|
Codes de statut
Statut | Valeur |
200 OK | Exportation 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'exportation. |
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 exportations 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 "https://[YOUR_COMPANY].iquant.eu/v1/export/store-specific-product-data/149?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d "[{ \"Store ID\": \"12564\"}]"
Réponse
{
"Status": "SUCCESS", "Records": [
{"Store ID": "12564", "Primary Product ID": "100001", "Stock": "12"},
{"Store ID": "12564", "Primary Product ID": "100005", "Stock": "0"},
... ]
}