Enregistrer et valider une commande WEB - GitMahalo/mahalo-php-v3 GitHub Wiki

Dossier 'commande'

Dans le dossier 'commande', vous trouverez différents exemples en php pour la création d'une commande WEB.

Remarques

  • Une fois la commande passée, il n'est plus possible de la modifier via les WS.
  • Une fois la commande passée, il est possible de valider la commande soit par l'ihm soit par WS (cf validationCommandeAbo.php)

Le paramètre : nePasModifierClient

  • 0 : écrase les données client lors de la validation de la commande. Il faut bien remettre toutes les données du client car celles absentes seront supprimées dans ce cas.
  • 1 : ne pas écraser les données client lors de la validation de la commande (préconisé)

Les paramètres : codeTarif et refTarif

L'un de ces 2 champs est obligatoire. Ces valeurs sont obtenues par l'api tarif.

  • codeTarif : code du tarif d'abonnement
  • refTarif : référence unique du tarif d'abonnement

Pour le visuel dans l'ihm, le mieux est de compléter ces 2 champs lors de la commande.

Le paramètre : typeAdresseLiv

Ce paramètre gère l'adresse de livraison en fonction de sa valeur :

  • 0 : adresse de livraison du 'codeClient'
  • 2 : nouvelle adresse de livraison avec création d'un nouveau client. Il faut ajouter les paramètres : civiliteLiv, nomLiv, prenomLiv, adresse2Liv, cpLiv, villeLiv, codeIsoPaysLiv (Obligatoire).
  • 5 : nouvelle adresse temporaire de livraison sans création d'un nouveau client. Il faut ajouter les paramètres : civiliteLiv, nomLiv, prenomLiv, adresse2Liv, cpLiv, villeLiv, codeIsoPaysLiv (Obligatoire).
  • 7 : adresse de livraison du bénéficiaire identifie par le 'codeClientLiv'. Il faut ajouter le paramètre : codeClientLiv (Obligatoire).

commandeAboAdresseLiv.php : exemple d'une commande avec les différents types d'adresse de livraison

Le paramètre : modePaiement

Ce paramètre gère le mode de paiement de la commande :

  • 1 : paiement par chèque
  • 2 : paiement CB One shot (cf commandeSimpleMultiOneShot.php)
  • 3 : paiement par prélèvement SEPA / RIB (création de Mandat nécessaire en amont) ce mode de paiement est lié à la clé système ‘CREATE_REGLEMENT_FOR_RIB_COMMANDE’. (cf commandeAboAvecMandatSepa.php)
  • 4 : paiement par virement
  • 5 : paiement Paypal
  • 6 : paiement par prélèvement CB (création de la CB nécessaire en amont) (cf commandeAboADLStripe.php)

Remarque : pour passer une commande sur un tarif gratuit. il ne faut pas ajouter le paramètre modePaiement. (cf commandeAboGratuit.php)

Le paramètre : pns (= premier numéro à servir) - titre de type numéro à numéro

commandeAboAvecPns.php : exemple pour forcer le premier numéro à servir (= pns) lors d'un abonnement ou d'un réabonnement.

pns: paramètre à ajouter sur la commande Si la clé système 'COMMANDES_FIND_ABONNEMENTS_ECHUS' vaut True alors on ne tient pas compte du pns car il est calculé tout seul coté Aboweb et il n'y a pas besoin d'ajouter la paramètre refAboEchu (paramètre qui permet de donner la référence de l'abonnement à réabonner cf commandePourReabo.php).

La clé système : 'WS_FORCE_DEBUT_ABO', permet de forcer le pns pour un abonnement quand 'COMMANDES_FIND_ABONNEMENTS_ECHUS' vaut False.

La clé système : 'WS_REABO_FORCE_PNS', permet de forcer le pns pour un réabonnement sur un tarif simple (ne fonctionne pas sur une formule)

Le paramètre : dateDebutAbo (= date du début d'abonnement) - titre de type date à date

Voir exemple : commandeAboAvecDateDebut.php

Pour un abonnement simple ou une formule, le paramètre dateDebutAbo permet de forcer la date de début de l'abonnement.

Remarque : dans le cas où Aboweb considère que c'est un réabonnement alors on fait un réabonnement sans tenir compte du paramètre dateDebutAbo.

Le paramètre : refCs

commandeAboALDirectAvecCS.php : exemple de commande avec des codes de sélection (= CS)

refCs : correspond à la référence CS obtenu par l'api : 'aidesaisie'

Il est possible d'ajouter un CS sur une facture, une ligne de facture ou un abonnement.

Pour modifier les CS d'un client, c'est possible lors de la commande si on est avec nePasModifierClient = 0. Donc pour éviter d'écraser des données, il est préférable d'utiliser les appels WS d'ajout et modification d'un CS.

Le paramètre : noCommandeBoutique

Ce paramètre correspond au numéro de commande côté éditeur (non obligatoire).

Le paramètre : cs9 ( = origine abonnement)

Ce paramètre permet d'ajouter un code origine abonnement sur les tarifs de type formule. Sa taille maximum vaut 20 caractères. Par défaut on met : ‘ABM’. (cf commandeAboAvecCodeOrigine.php)

Le paramètre : cs10 ( = référence origine)

Ce paramètre permet d'ajouter une référence origine sur l'abonnement.

Le paramètre : codePrescripteur

Ce paramètre permet d'ajouter un code client de type prescripteur sur l'abonnement.

(cf commandeAboAvecCodePrescripteur.php)

Remise sur une ligne de commande

commandeAboAvecRemise.php: exemple pour mettre une remise sur une ligne de commande avec le paramètre : tauxRemise qui correspond au pourcentage à appliquer sur le montant.

Recherche d'une commande passée

rechercheCommande.php : exemples de recherche de commandes passées avec comme critères :

  • noCommandeBoutique: numéro unique de la commande de la boutique
  • refAction : référence de la commande

Changement d'adresse d'un client

commandeChangementAdresse.php: exemples de changement d'adresse d'un contact en passant par le WS commande. Il est possible de passer la refAdresse que l'on modifie avec les champs 'adresse'. Si refAdresse non présent alors on modifie l'adresse principale du client.

Pour ne pas perdre de données déjà existantes, il est fortement conseillé de renseigner tous les champs 'adresse'.