Créer des commandes web (et des clients) pour Yodaforex – Connect Yodaforex

Avant tout passage de commande dans l'environnement de production, une série de commandes de tests sont à faire dans l'espace de démonstrations et doivent être validées par nos services techniques.

Pas de commande mixte

Une commande ne peut PAS contenir des devises ET des métaux

Il faut impérativement dissocier les deux types de produits dans deux commandes différentes (nous recommandons de travailler avec deux types de paniers, cela permettra de gérer des modes de paiement our de livraison différents si nécessaire).

Les clients

La création d'un client se fait par /v1/customers

La recherche d'un client peut se faire par son id /v1/customers/{customerId} ou par son adresse e-mail /v1/customers/searchByEmail/{email}

Avant chaque validation de commande, il est conseillé de mettre à jour les données du client (qui peut avoir complété son compte depuis sa création par exemple) avec un /v1/customers/{customerId} en PATCH ou PUT suivant s'il s'agit d'un update partiel ou total

Récupérer les commandes

Pour récupérer toutes les commandes d'un client, utiliser /v1/customers/{customerId}/orders et /v1/customers/{customerId}/orders/{orderId} pour une commande spécifique

Créer une commande

Utiliser /v1/customers/{customerId}/orders pour créer une commande.

Informations sur la commande

id est un Int, saisir la valeur voulue ou laisser à vide pour une affectation automatique
timestamp ISO 8601 de la commande
transactionType deux valeurs possibles 1 pour les devises, 20 pour les métaux
shippingMode deux valeurs possibles R pour les retraits, L pour les livraisons
paymentMode trois valeurs possibles C pour les CB, V pour les virements, CQ pour les chèques
paymentDate⁽¹⁾ date de paiement, peut être rempli lors d'un paiement CB
status⁽¹⁾ deux valeurs possibles lors de l'enregistrement DO_NOT_HONOR ou HONOR, seules les commandes HONOR sont récupérables par Yodaforex.

Si vous utilisez directement l'API sans passer par une base passerelle, il est recommandé lors d'une commande payée par CB de créer la commande en DO_NOT_HONOR avant d'accéder au système de paiement, puis une fois le paiement validé de la transformer en HONOR avec un PATCH sur la commande.

Montants et lignes de commande

otherFeesAmount montant d'autres frais, peuvent être positifs (un emballage cadeau) ou négatifs (une remise) 2 décimales
shippingAmount montant des frais de port 2 décimales
summedItemsAmount montant des articles des lignes de commandes 2 décimales
totalOrderAmount total des trois valeurs ci-dessus, à régler par le client 2 décimales
orderLinesCount nombre de lignes de commande
orderLines une ligne pour chaque produit, voir ci-dessous

orderLines - Pour les devises

itemIsoOrRef = currency.iso
itemLabel Intitulé de la ligne de facture
Nous recommandons currency.name currency.country (par currency.base)
Yen, Japon (par 100) ou Livre, Angleterre
quantity quantité en devise, doit être un multiple de currency.smallestCut 0 décimale
rate = currency.webSellRate
totalAmount= (1/orderLine.rate * orderLine.quantity)/currency.base 2 décimales
itemFixing = 1/orderLine.rate

Optionnels pour les devises

isTC 1 si la devise est un Traveller Chèque
preferredNotes Coupures souhaitées par le client : S petites coupures, L grandes coupures, P panaché

orderLines - Pour les métaux

itemIsoOrRef = metal.ref
itemLabel = metal.name
quantity = quantité achetée 0 décimale
rate = metal.sellPrice.price ou plus rarement metal.deskSellRate 2 décimales
totalAmount = orderLine.quantity*orderLine.rate 2 décimales
itemFixing = orderLine.rate

orderLines - Champs communs

orderId = order.orderId s'il a été saisi, sinon laisser vide pour l'affectation automatique
itemId = metal.id ou currency.id
affiliatedId = order.affiliatedId s'il y a lieu

Suppléments obligatoires

billingCustomerLabel entité facturée, en général customer.civility customer.firstname customer.lastname ou customer.companyName

billingFullAddress et shippingFullAddress, adresses complètes de facturation et livraison sous la forme

customer.addressList.company<br />
customer.addressList.civility customer.addressList.firstname customer.addressList.name<br />
customer.addressList.street<br />
customer.addressList.postalCode customer.addressList.city<br />
customer.addressList.country

customerIp Ip du client, en v4 ou v6

Suppléments optionnels

cardAuthorizationNumber numéro d'autorisation de CB
customerComment commentaire du client, peut être complété par des notes du webmaster
customerPreferedDeadline date de livraison souhaitée par le client
pickupShopName agence de retrait

Autres

affiliateId id d'un partenaire affilié
totalOrderCryptocurrencyAmount montant en cryptomonnaie

Informations complétées par Yodaforex

billingDate date de facturation, se rempli automatiquement lors du passage en facturation
eta date de livraison estimée (peut être détourné pour une date de mise à disposition)
integrationInYFXDate date de récupération de la commande par Yodaforex
invoiceNumber numéro de facture Yodaforex, se rempli automatiquement lors du passage en facturation
paymentDate⁽¹⁾ date de paiement, se rempli automatiquement quand un virement est marqué Reçu
shippedOnDate date d'expédition, se rempli automatiquement lors du passage en facturation
shippingTrackingNumber numéro de suivi
status⁽¹⁾ CANCELLED si le marchand annule la commande

⁽¹⁾ Peuvent être remplis par le site et/ou Yodaforex