Exportation de données de commande

Vous pouvez utiliser l'API REST de HCL Commerce pour exporter les données de commande d'un magasin spécifique. La sortie est exportée au format CSV.

Avant de commencer

Assurez-vous que l'interface utilisateur Swagger et l'API Discovery REST sont activées. Pour plus d'informations, voir Activation et désactivation de l'API Discovery REST.
Remarque : Par défaut, pour chaque magasin, une seule exportation de commande est autorisée par utilisateur (avec le rôle de contrôle d'accès approprié) toutes les heures. Pour modifier le délai minimum entre les exportations, voir Configuration du temps écoulé minimum entre les exportations de commande.

Procédure

  1. Utilisez la console d'administration de l'organisation pour attribuer les rôles suivants à un utilisateur HCL Commerce :
    • Attribuez le rôle Client enregistré à l'utilisateur. Ce rôle permet aux utilisateurs de se connecter au magasin et d'accéder aux outils d'exportation de commande dans l'interface utilisateur de Swagger. Ce rôle est nécessaire si le mot de passe de l'utilisateur est expiré et doit être réinitialisé à l'aide de la vitrine.
    • Attribuez l'un des rôles suivants pour fournir l'accès à l'exportation et au téléchargement des données de commande :
      • Gestionnaire des opérations
      • Acheteur (côté vente)
      • Gestionnaire de catégories
      • Responsable marketing
      • Gestionnaire des opérations
      • Responsable de la logistique
      • Responsable des ventes
      • Gestionnaire produit
      • Seller
      • Administrateur de site
  2. Accédez au magasin type Aurora et connectez-vous à ce magasin avec un compte utilisateur ayant accès aux commandes d'exportation. Vous devez vous connecter pour utiliser les services REST d'exportation de commande qui se trouvent dans l'interface utilisateur Swagger.
  3. Ouvrez un navigateur Web et accédez à l'URL suivante pour accéder à l'interface utilisateur Swagger :
    https://hostname/webapp/wcs/stores/servlet/swagger/index.html

    Dans l'interface utilisateur Swagger, la classe order_export est utilisée pour exporter des données de commande. Ensuite, la classe order_download est utilisée pour télécharger les données de commande exportées.

  4. Exportez les données de commande.
    1. Développez la classe order_export.
    2. Développez le chemin de méthode POST /store/{storeId}/order_export/.
    3. Entrez les paramètres nécessaires.
      Paramètre Valeur
      storeId
      Remarque : storeId est un paramètre obligatoire.
      		 Identificateur du magasin.
      body
      Remarque : Spécifiez les paramètres facultatifs au format JSON.
      		 Il y a deux valeurs que vous pouvez soumettre.
      état
      Exportez uniquement les commandes avec le statut spécifié. Les valeurs valides sont basées sur la colonne STATUS de la table de base de données ORDERS.
      Si status n'est pas spécifié, les valeurs par défaut suivantes sont utilisées
      "A","B","C","D","F","G","H","I","M","R","S","W"
      Remarque : La liste par défaut suppose que Sterling Order Management est utilisé. Par conséquent, si votre environnement n'est pas intégré à Sterling Order Management, vous remarquerez peut-être que la liste contient plus de valeurs STATUS que votre table ORDERS.
      timePlacedInDays
      Exportez les commandes qui ont été passées x jours depuis l'heure courante. Par exemple, 0 représente toutes les commandes passées depuis 00h00 aujourd'hui. 1 représente toutes les commandes passées depuis minuit hier.

      Si timePlacedInDays n'est pas spécifié, 0 est utilisé par défaut.

      Par exemple, les paramètres suivants exportent les commandes passées au cours des 100 derniers jours et dont le statut est 'M', 'A' ou 'B'.
      {
   "status":"M,A,B",
   "timePlacedInDays":"100"
}
    4. Cliquez sur Try it out!.
      Remarque : L'exportation de commande est stockée dans la table de base de données UPLOADFILE.
    5. Notez l'ID exportId dans le corps de la réponse. L'ID exportId est utilisé pour télécharger les données de commande dans l'étape suivante.
  5. Téléchargez les données de commande exportées.
    1. Développez la classe order_download.
    2. Développez le chemin de méthode GET /store/{storeId}/order_download/byExportId/.
    3. Entrez l'ID storeId que vous avez déjà utilisé, et l'ID exportId de l'étape 4.e.
    4. Cliquez sur Try it out!.
    5. Le corps de réponse contient les données de commande exportées au format CSV.
    6. Téléchargez le fichier CSV en accédant à l'URL de la demande de réponse dans votre navigateur Web.
      Par exemple, pour un magasin dont le storeId est 10151 et l'exportId est 10001, l'URL de réponse à la demande est 
      https://localhost:443/wcs/resources/store/10151/order_download/byExportId/10001