Ajout de la prise en charge d'une devise à HCL Commerce

Vous pouvez utiliser l'API REST pour mettre à jour votre base de données d'environnement afin d'ajouter la prise en charge d'une nouvelle devise à HCL Commerce. En ajoutant la prise en charge de la devise, vous pouvez ensuite ajouter la prise en charge de la devise à des magasins spécifiques afin que les clients puissent afficher les prix dans cette nouvelle devise.

En outre, vous pouvez utiliser l'API REST pour définir le format d'affichage de la devise et définir la manière de convertir les prix dans d'autres devises vers votre nouvelle devise. Vous pouvez également utiliser l'API REST pour créer des facettes de recherche afin de représenter les prix dans la nouvelle devise sur les pages de magasin.

Before you begin

Lorsque vous ajoutez une devise, vous devez connaître et utiliser le code de devise standard ISO 4217 pour la devise. Pour plus d'informations sur ces normes, voir.

Procedure

  1. Composez la requête d'API REST pour ajouter la devise dans HCL Commerce.
    Lorsque vous ajoutez des descriptions, vous devez utiliser l'API REST administrative suivante :
    • Devises (https://localhost:443/rest/admin/v2/currencies)
    Le corps de l'appel permettant d'ajouter la devise peut ressembler à l'exemple suivant, qui ajoute la roupie indienne (code de devise de l'INR).
    
{
  "id\": \"{{code}}\",
  "numericCurrencyCode\": {{numericCode}},
  "currencyExponent\": -2
}
    Pour composer l'appel API, vous avez besoin des détails suivants pour identifier le magasin et la devise :
    • Le code de devise. Ce code est le code ISO 4217 à 3 caractères de la devise, tel que USD pour la devise en dollars des Etats-Unis.
    • Le code de devise numérique. Ce code est le code ISO 4217 numérique pour la devise, tel que 840 pour la devise en dollars des Etats-Unis.
    • L'exposant de devise, qui est la valeur exponentielle par laquelle une sous-unité de la monnaie (comme les centimes) est multipliée pour obtenir l'unité de devise principale. Par exemple, pour la monnaie en dollars des Etats-Unis, vous multipliez le nombre de centimes par 10 à la puissance -2 pour obtenir le nombre de dollars.
  2. Composez la requête d'API REST pour ajouter les informations descriptives, telles qu'un nom d'affichage, pour la nouvelle devise.
    Cette description est utilisée par les clients et les utilisateurs professionnels pour identifier la devise. Ces informations descriptives peuvent être visibles dans la vitrine lorsque les utilisateurs parcourent le magasin. Les informations descriptives s'affichent également pour la devise dans Management Center.
    Lorsque vous ajoutez des descriptions, vous devez utiliser l'API REST administrative suivante :
    Le corps de l'appel permettant d'ajouter la description de la devise peut ressembler à la structure de corps suivante :
    
{
  \"code\": \"{{code}}\",
  \"languageId\": {{langId_en}},
  \"description\": \"{{description}}\"
}
    Pour composer l'appel API, vous avez besoin des détails suivants pour identifier le magasin et la devise :
    • Le code de devise.
    • L'ID pour identifier la langue de la description dans HCL Commerce.
  3. Composez la requête d'API REST pour définir comment convertir les prix d'une autre devise vers votre nouvelle devise.
    Lorsque vous ajoutez des détails de taux de conversion de devises, vous devez utiliser l'API REST administrative suivante : Pour composer cet appel d'API, vous avez besoin de détails pour identifier les deux devises et définir le taux de conversion. Le corps de l'appel permettant d'ajouter le taux de conversion de la devise peut ressembler à la structure de corps suivante :
    
{   
  \"storeId\": {{catalogAssetStoreId}},
  \"fromCurrency\": \"USD\",
  \"toCurrency\": \"{{code}}\",
  \"conversionFactor\": 2.3215,
  \"multiplyOrDivide\": \"M\",
  \"bidirectional\": \"Y\",
  \"updatable\": \"Y\"
}
  4. Composez la requête d'API REST pour définir comment la devise doit être formatée pour l'affichage sur la vitrine.
    Lorsque vous ajoutez des informations sur le format de devise, vous devez utiliser l'API REST administrative suivante : Pour composer cet appel API, vous avez besoin de détails pour identifier la devise et le format de devise. Le corps de l'appel permettant d'ajout du format de devise peut ressembler à la structure de corps suivante :
    
{
  \"storeId\": {{catalogAssetStoreId}},
  \"currency\": \"{{code}}\",
  \"roundingMultiple\": 1,
  \"numberUsg\": -1,
  \"roundingMethod\": \"R\",
  \"decimalPlaces\": 2,
  \"minimumApproveAmount\": null
}
  5. Composez la requête d'API REST pour définir les informations descriptives du format de devise, par exemple pour définir le symbole de la devise.
    Lorsque vous ajoutez des descriptions sur le format de devise, vous devez utiliser l'API REST administrative suivante :
    • Formats de devise (https://localhost:443/rest/admin/v2/currency-format-descriptions)
    Pour composer cet appel API, vous avez besoin de détails pour identifier la devise et la langue. Le corps pour l'appel permettant d'ajouter des informations descriptives peut ressembler à la structure de corps suivant :
    
{
  \"languageId\": {{langId_en}},
  \"currencySymbol\": \"{{symbol}}\",
  \"customizedCurrencyCode\": null,
  \"currencyPrefixPositive\": \"{{symbol}}\",
  \"currencyPrefixNegative\": \"-{{symbol}}\",
  \"currencySuffixPositive\": null,
  \"currencySuffixNegative\": null,
  \"displayLocale\": null,
  \"radixPoint\": null,
  \"groupingCharacter\": null,
  \"numberPattern\": \"#,##\",
  \"description\": \"{{description}}\",
  \"storeId\": {{catalogAssetStoreId}},
  \"currency\": \"{{code}}\",
  \"numberUsg\": -1        
}
  6. Composez la requête d'API REST pour définir les zones de recherche de la devise.
    En ajoutant les zones de recherche, vous pouvez créer des facettes de recherche basées sur les prix dans la devise afin que les utilisateurs de la vitrine puissent filtrer les résultats de recherche par prix dans la devise.
    Lorsque vous ajoutez les zones de recherche, vous devez utiliser l'API REST administrative suivante :
    Pour composer cet appel d'API, vous avez besoin de détails pour identifier l'index de recherche et la devise. Le corps pour l'appel permettant d'ajouter la zone de recherche peut ressembler à la structure de corps suivante :
    
{
  \"id\": 10001,
  \"indexId\": \"0\",
  \"indexType\": \"CatalogEntry\",
  \"identifier\": \"_cat.OfferPrice_{{code}}\"
}
  7. Composez la requête d'API REST pour définir les propriétés de la zone de recherche de la devise afin de créer une facette de recherche pour la devise.
    Ces propriétés définissent les fourchettes de prix qui seront utilisées en tant que facettes de recherche. Lorsque vous ajoutez les propriétés de la zone de recherche, vous devez utiliser l'API REST administrative suivante : Pour composer cet appel d'API, vous avez besoin de détails pour identifier la zone de recherche. Le corps pour l'appel consistant à ajouter les propriétés de zone peut ressembler à la structure de corps suivante : 
    
{
  \"fieldId\": 10001,
  \"property\": \"facet\",
  \"fieldName\": \"price_{{code}}:{* TO 100];{100 TO 200];{200 TO 300];{300 TO 400];{400 TO 500];{500 TO *}\"
}
  8. Composez la requête d'API REST pour définir les propriétés des facettes de recherche de devises.
    Lorsque vous ajoutez les propriétés de la facette de recherche, vous devez utiliser l'API REST administrative suivante : Pour composer cet appel d'API, vous avez besoin de détails pour identifier la facette de recherche. Le corps pour l'appel consistant à ajouter les propriétés de facette peut ressembler à la structure de corps suivante :
    
{
  \"id\": 10001,
  \"attributeId\": null,
  \"fieldId\": 10001,
  \"storeId\": 0,
  \"selection\": 0,
  \"sortOrder\": 0,
  \"searchDisplay\": 1,
  \"zeroDisplay\": 0,
  \"maxDisplay\": 20,
  \"sequence\": 0,
  \"field1\": null,
  \"field2\": null,
  \"field3\": null,
  \"groupId\": 0
}
  9. Composez la requête d'API REST pour définir les informations descriptives des facettes de recherche de devises.
    Lorsque vous ajoutez des descriptions de recherche de facette, vous devez utiliser l'API REST administrative suivante : Pour composer cet appel d'API, vous avez besoin de détails pour identifier la facette de recherche pour une langue spécifique. Le corps pour l'appel permettant d'ajouter la description de la facette peut ressembler à la structure de corps suivant :
    
{
  \"facetId\": 10001,    
  \"languageId\": {{langId_en}},
  \"name\": \"Price ({{code}})\",
  \"description\": \"Price-{{code}}\",
  \"field1\": null,    
  \"field2\": null,
  \"field3\": null
}
  10. Exécutez vos appels d'API REST et ajoutez la devise à HCL Commerce.
    Pour exécuter vos appels d'API REST, vous pouvez regrouper vos appels REST dans une collection JSON avec les appels API pour ajouter la devise à un magasin afin d'exécuter tous les appels dans l'ordre. La collection suivante montre comment regrouper les appels d'API pour l'ajout d'une devise.
    Pour utiliser cette collection, vous devez définir les variables d'environnement de l'API. Les appels API de la collection sont structurés avec des variables. Les valeurs utilisées pour les variables peuvent être incluses dans un fichier JSON distinct. Le fichier suivant comprend des exemples de valeurs pour définir la devise roupie indienne (INR). Remplacez les exemples de valeurs définis dans le fichier par les valeurs des magasins et la devise que vous ajoutez à votre environnement. Vous pouvez ensuite utiliser la collection et les fichiers de valeurs pour exécuter les requête d'API afin d'ajouter la devise.