Récupérer et afficher les produits métaux

L'API reflète le contenu de la base Yodaforex Web Connect : des produits peuvent être ajoutés, modifiés mais aussi supprimés par le marchand. Il convient au webmaster de traiter ces trois cas.

Accéder aux produits métaux

/v1/products/metal ou /v1/products/metals/{metalId} retournent l'intégralité des métaux ou un métal spécifique.

Toutes les valeurs proviennent directement de Yodaforex, sauf pour buyPrice, sellPrice et  internationalPrice qui sont eux automatiquement calculés par l'API toutes les 15 minutes.

Données d'identification du produit

• id code unique d'identification du produit métal
• ref code marchand du metal, sert d'identifiant pour la facturation et pour afficher les images du produit 
• name nom du produit
• shortName nom court du produit

Données de classement et tri

Les catégories sont choisies dans Yodaforex suivant les familles de produits, qui répondent à des réglementations fiscales bien spécifiques, elles ne doivent pas être utilisée en première intention pour trier les produits.

• category 
  • argent (français démonétisé), argent_inter (argent international), argent_neuf (argent neuf, régime de taxation spécifique),
  • or_bourse (or de bourse, ces produits possèdent un prix cpor), refus_bourse (idem que or_bourse mais second choix), or_inter (or international)
  • hors_cote (produit non côtés), numismatique
  • bijoux_fonte, fonte
• material métal du produit
• isFavorite Le produit est coché comme Favori dans Yodaforex
• isNew Le produit est coché comme Nouveau dans Yodaforex
• isSpecial Le produit est coché comme Spéciale dans Yodaforex
• isSoldOnline Le produit est coché comme Vente en ligne
• isBullion Le produit est coché comme étant un Lingot ou un lingotin
• isBoughtOnline Le produit est coché comme Rachat en ligne
• displayOrder Numéro d'ordre d'affichage
• fineWeight poids de fin du produit (quantité de material)

Données financières

Chaque produit a deux déclinaisons de prix : un prix guichet et un prix web.
Le marchand peut décider de différencier ces deux tarifs.
Les prix web ainsi que la cotation Internationale sont automatiquement recalculés toutes les 15 minutes, suivant la formule choisie dans Yodaforex.

• cporRate prix de la Bourse de Paris (change une fois par jour vers 13h), ne concerne que les produits de la catégorie or_bourse, doit être mis à jour dans Yodaforex
• deskBuyRate prix de rachat guichet
• deskSellRate prix de vente guichet
• metalCalculationResponse les prix web recalculés toutes les 15 minutes automatiquement par l'API, que Yodaforex soit ou non ouvert
  • buyPrice prix de rachat web calculé*
  • sellPrice prix de vente web calculé*
  • internationalPrice valeur calculée* du produit sur sa cotation internationale, en fonction de son poids de fin
  * recalcul automatique toutes les 15 minutes
• precisionRoundSellPrice type d'arrondis à appliquer à un prix de vente ou d'achat (voir round.php)

Remises par quantités

• minimumPriceRange1, minimumPriceRange2 et minimumPriceRange3 correspondent aux tranches auxquelles appliquer les remises définies ci-dessous
• discountPercentagePriceRange1, discountPercentagePriceRange2 et discountPercentagePriceRange3 correspondent aux pourcentages de remise à appliquer aux tranches définies ci-dessus

50, 99 et 200 par exemple pour avoir un prix unitaire jusqu'à 50, puis appliquer discountPercentagePriceRange1 de remise de 51 à 99, puis discountPercentagePriceRange2 de 100 à 199 puis discountPercentagePriceRange3 au delà de 200

Ordre de bourse (déprécié, voué à disparaitre)

1. buySpreadCPOROrder et sellSpreadCPOROrder : pourcentage à ajouter ou retrancher du prix cporRate
2. minimumCPOROrderBuyQuantity et minimumCPOROrderSellQuantity : quantité minimum au rachat et à la vente
3. minimumCPOROrderPriceRange1, minimumCPOROrderPriceRange2 et minimumCPOROrderPriceRange3 : optionel - quantités pour des remises par tranche
4. discountPercentageCPOROrderPriceRange1, discountPercentageCPOROrderPriceRange2 et discountPercentageCPOROrderPriceRange3 : optionnel - remise par tranche
   
   50, 99 et 200 par exemple pour avoir un prix unitaire jusqu'à 50, puis appliquer discountPercentageCPOROrderPriceRange1 de 51 à 99, puis discountPercentageCPOROrderPriceRange2 de 100 à 199 puis discountPercentageCPOROrderPriceRange3 au delà de 200

Calcul automatique des prix web (/v1/calculations/metal/prices devient inutile)

Le champ metalCalculationResponse utilise /v1/calculations/metal/prices et les champs suivants pour fonctionner

• fineWeight et /v1/fixings/metal/ material pour calculer sa valeur en métal sur le fixing international
• buyPriceCalculationMode et sellPriceCalculationMode méthodes de calcul choisie pour le prix web de rachat et de vente de ce produit 
  • BEST_BTWN_CPOR_AND_INTER, BEST_BTWN_CPOR_AND_INTER_AND_YFX, BEST_BTWN_INTER_AND_YFX, CPOR_PLUS_SPREAD_PRCNTG,
    INTERNATIONAL_PLUS_SPREAD_PRCNTG, YFX_PRICE
• sellSpread coefficient à la vente (pourcentage à rajouter au prix de base : inter ou cpor)
• buySpread coefficient au rachat (pourcentage à soustraire au prix de base : inter ou cpor)
• webBuyRate et webSellRate prix de rachat et de vente web saisi dans Yodaforex

Promotions

• webDiscountEndDate date et heure de fin d'une promotion web
• deskDiscountEndDate date et heure de fin d'une promotion guichet
• discountDeskBuyRate prix promotionnel d'un rachat guichet
• discountDeskSellRate prix promotionnel de vente guichet
• discountWebBuyRate prix promotionnel d'un rachat web
• discountWebSellRate prix promotionnel de vente web

Pour qu'une promotion soit applicable il faut vérifier que

1. la date de fin ne soit pas dépassée
2. le prix promotionnel soit plus avantageux pour le client

Autres

• isNotShippable l'article ne peut pas être expédié
• fineness finesse, titre, exprimé en ‰
• grossWeight poids brut
• minimumWebOrderBuyQuantity quantité minimum lors d'un rachat
• minimumWebOrderSellQuantity quantité minimum lors d'une vente
• mustBeBoughtByBatchdoit être racheté par lots (multiple de la quantité minimum)
• mustBeSoldByBatchdoit être vendu par lots (multiple de la quantité minimum)