REST API Exportation des catégories de produits V1
Cette ressource est utilisée pour exporter des données relatives aux catégories 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 exportation. Une fois créée, la liste des tâches aura l'ID que vous devrez transmettre dans l'URL de la requête.
ID de la tâche automatique
- 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 Mappage des attributs des catégories de produits, 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 |
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 |
Mappage des attributs des catégories de produits | Mappage contenant une entrée pour chaque attribut ou catégorie de produit exporté. | type complexe |
Séparateur des éléments de liste | Symbole utilisé pour séparer les éléments dans une liste de valeurs. | symbole |
Délai en secondes avant nouvelle tentative | En cas de code d'état 503, le client doit réessayer l'envoi de la requête après quelques secondes. | numéro |
Lignes séparées par catégorie | Si activé, génère un enregistrement personnalisé pour chaque catégorie du produit, sinon un seul enregistrement par produit, où les attributs de catégorie sont de type tableau JSON. | oui/non |
Ensemble de produits | Filtre spécifiant la liste des produits à exporter | type complexe |
Requête
/v1/export/product-categories/{task_id}
Paramèter | 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 peut être vide (texte vide) ou un objet JSON vide.
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. |
Records | Optionnel - inclus si l'exportation ne s'est pas terminée avec le statut « FAILURE ». Liste d'objets exportés avec la clé de correspondance définie dans les paramètres de la tâche. |
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 "http://[YOUR_COMPANY].iquant.eu/v1/export/product-categories/246?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d "{}"
- Type de réponse « lignes séparées » :
{
"Status": "SUCCESS", "Records": [
{
"QID Product": "400020",
"Primary Id": "10039",
"Category ID": "CAT203"
},
{
"QID Product": "400020",
"Primary Id": "10039",
"Category ID": "CAT3"
},
...
]}
- Type de réponse « lignes cumulées » :
{
"Status": "SUCCESS", "Records": [
{
"QID Product": "400020",
"Primary Id": "10039",
"Category ID": [
"CAT203",
"CAT3"
]
}, {
"QID Product": "400021",
"Primary Id": "10040",
"Category ID": [
"CAT8",
"CAT12",
"CAT55",
"CAT112"
]
},
...
]}