Différences entre versions de « NF17502 — API WebConnect »

De Documentation Polaris
Aller à : navigation, rechercher
 
(38 versions intermédiaires par le même utilisateur non affichées)
Ligne 4 : Ligne 4 :
 
=Gestion des appareils=
 
=Gestion des appareils=
 
*<Code><Système / gestion des appareils</Code>
 
*<Code><Système / gestion des appareils</Code>
−
*<Code>Nouvel appareil</Code> ou <Code>Nouveau prestataire</Code>
+
*<Code>Nouvel appareil</Code> ou <Code>Nouveau prestataire / WebConnect</Code>
 
{{depuis|11.02}}
 
{{depuis|11.02}}
 
*L'option [[NF20269|<Code>Cet accès n'est valable qu'en mode isolé (mode de test)</Code>]] permet de déclarer des accès API de production, d'autres de tests.  
 
*L'option [[NF20269|<Code>Cet accès n'est valable qu'en mode isolé (mode de test)</Code>]] permet de déclarer des accès API de production, d'autres de tests.  
 
**Les accès de production ne pourront se faire que sur un système hors mode isolé  
 
**Les accès de production ne pourront se faire que sur un système hors mode isolé  
 
**ceux de tests que lorsque le système est en mode isolé.
 
**ceux de tests que lorsque le système est en mode isolé.
 +
=Appareil "Webconnect"=
 +
Paramétrer :
 +
*<Code>Magasin de réference</Code>
 +
*<Code>Utiliser les descriptions du site internet</Code> : saisir le site internet
 +
*<Code>Exposer uniquement les produits publiés sur ce site</Code> :
 +
** si coché : exporte uniquement les articles publiés sur le site internet renseigné
 +
** si décoché :
 +
{{depuis|13.03}}
 +
*** OU <Code>Sinon, utiliser le filtrage suivant</Code> : décoché par défaut.
 +
****Si coché : permet de définir les articles exportés via des filtres.
 +
*<Code>Préfixe des références externes</Code>
 +
<br>
 +
*<Code>Autoriser :</Code>
 +
**<Code>Imports clients</Code>
 +
**<Code>Modif. clients existants</Code>
 +
**<Code>Import bons</Code>
 +
**<Code>Imports transferts</Code>
 +
**<Code>Imports réservations</Code>
 +
**<Code>Imports vente en gros</Code>
 +
**<Code>Exports clients</Code>
 +
{{depuis|11.02}}
 +
***<Code>Que les clients avec e-mail</Code> :
 +
****'''Décoché''' : (par défaut). Tous les clients
 +
****'''Coché''' : QUE les clients avec e-mail
 +
**<Code>Imports ventes</Code>
 +
**<Code>Exports bons</Code>
 +
**<Code>Exports des PA</Code>
 +
**<Code>Export réservations</Code>
 +
**<Code>Export ventes</Code>
 +
Lors de l'importation des ventes :
 +
*<Code>Code caisse par défaut</Code>
 +
*<Code>Code vendeur par défaut</Code>
 +
 +
*<Code>Magasins exposés</Code> : permet de filtrer les clients  sur le "Magasin lié" de la fiche client.
 +
**Sélectionner les magasins ou cocher <Code>Exposer tous les magasins</Code>
 +
{{depuis|11.02}}
 +
*<Code>Magasins autorisés pour les clients</Code> : "Magasin lié" de la fiche client
 +
**Sélectionner les magasins ou cocher <Code>Tous les magasins</Code>
  
−
=API "Catalog"=
+
=API WebConnect "Catalog"=
−
{{depuis|10.0.8}}
 
 
Les API suivantes intégrent les libellés renseignés dans le site internet :
 
Les API suivantes intégrent les libellés renseignés dans le site internet :
 
*<Code>Catalog/Categories1 à 4</Code>
 
*<Code>Catalog/Categories1 à 4</Code>
Ligne 19 : Ligne 56 :
 
*<Code>Catalog/Classifications</Code>
 
*<Code>Catalog/Classifications</Code>
 
*<Code>Catalog/ClassificationsEXT</Code>
 
*<Code>Catalog/ClassificationsEXT</Code>
−
*...
+
==API Webconnect CATALOG/Magasin (GET) CatalogGetMagasin ==
 +
{{depuis|12.2}}
 +
*Ajout de la rubrique "Horaires" qui renseigne les jours et horaires du magasin. par exemple :
 +
**"Horaires": "Dimanche : Fermé, Lundi : Fermé, Mardi : 10-19, Mercredi : 10-19, Jeudi : 10-19, Vendredi : 10-19, Samedi : 9-20"
 +
==API Webconnect CATALOG/Produits (GET)==
 +
===Rubriques===
 +
==== Rubrique "GrilleTaille"====
 +
{{depuis|12.2}}
 +
<Code>GrilleTaille</Code> : libellé de la grille taille :
 +
*"GrilleTaille": "chaussures 36 au 41",
 +
==== Rubrique "TauxTVA"====
 +
{{depuis|12.2}}
 +
<Code>TauxTVA</Code>
 +
*"TauxTVA": 0.2 pour une TVA à 20 %
 +
*"TauxTVA": 0.055 pour une TVA à 5.5 %
 +
 
 +
==== Rubrique "Zonage" taille====
 +
{{depuis|12.2}}
 +
*Dans Polaris pour paramétrer le zonage taille :
 +
*Système / paramétrages / applications / rayonnage / "Niveau du zonage dépôt" = tailles
 +
*Ajout du '''zonage à la taille''' : '''Zonage''' dans la rubrique '''Tailles'''.
 +
**Exemple de zonage à la taille renseigné
 +
"Tailles": [
 +
{
 +
"Taille": "s",
 +
"TailleFour": null,
 +
'''"Zonage": "a01p01e01",'''
 +
"Refs": [
 +
"11686484"
 +
],
 +
...
 +
**Exemple de zonage taille non renseigné
 +
"Tailles": [
 +
{
 +
"Taille": "s",
 +
"TailleFour": null,
 +
'''"Zonage": ""''',
 +
"Refs": [
 +
"11686460"
 +
],
 +
...
 +
{{Note|ATTENTION : si on repasse au paramétrage zonage au critère, Polaris n'efface pas le zonage saisi à la taille et l'API ressortira le zonage à la taille renseigné précédemment.}}
 +
 
 +
==API Webconnect CATALOG/ProduitsInvalides (GET)==
 +
{{depuis|12.2}}
 +
*Lorsque les produits sont supprimés/dépubliés, ils ne sortent plus dans le endpoint Produits et donc l'utilisateur de l'API n'est pas mis au courant que tel ou tel produit doit être supprimé du site.
 +
*L'API <Code>ProduitsInvalides</Code> Création d'un EndPoint permettant de lister tous les produits qui ne DOIVENT PAS/PLUS être sur le site.
 +
 
 +
Cela permet de boucler sur les références tailles (code barres Polaris) et de les supprimer du site s'ils existent.
 +
 
 +
=API WebConnect "Clients"=
 +
==API WebConnect '''ClientsPostBon'''==
 +
*Si le client ne fait pas partie des magasins autorisés pour les clients : "Message": "''Le client n'est associé à aucun magasin autorisé''"
 +
==API WebConnect '''ClientsGetBon'''==
 +
*Filtre sur le CB du bon : Le programme affiche le bon même si le client ne fait pas partie des "magasins autorisés pour les clients".
 +
==API WebConnect '''ClientsGetBons'''==
 +
*Le programme affiche uniquement les bons des clients dont le magasin fait partie des "magasins autorisés pour les clients".
 +
==API WebConnect '''ClientsGetCartePrePaye'''==
 +
*Filtre sur le CB de la carte pré-payée : Le programme n'affiche pas la CPP si le client ne fait pas partie des "magasins autorisés pour les clients" : "Message": "Not Found".
 +
==API WebConnect '''ClientsGetCartePrePayes'''==
 +
*Le programme affiche uniquement les cartes pré-payées des clients dont le magasin fait partie des "magasins autorisés pour les clients".
 +
==API WebConnect '''ClientsGetClient'''==
 +
*Si le magasin du client ne fait pas partie des magasins autorisés pour les clients : "Message": "Not Found".
 +
{{depuis|13.1.1.44971}}
 +
**Ajout des critères N°1 à 3 :
 +
"Crit1": "string",
 +
"Crit2": "string",
 +
"Crit3": "string",
 +
 
 +
==API WebConnect '''ClientsPostClient'''==
 +
*Si le magasin du client ne fait pas partie des magasins autorisés pour les clients : "Message": "Not Found".
 +
==API WebConnect '''ClientsDeleteClient'''==
 +
*ne supprime pas le client si le magasin du client ne fait pas partie des magasins autorisés pour les clients : "Message": "Le client n'est associé à aucun magasin autorisé".
 +
==API WebConnect '''ClientsPutClientCarte'''==
 +
*Si le magasin du client ne fait pas partie des magasins autorisés pour les clients : "Message": "Le client n'est associé à aucun magasin autorisé".
 +
==API WebConnect '''ClientsGetClients'''==
 +
*Le programme affiche uniquement les clients dont le magasin fait partie des "magasins autorisés pour les clients".
 +
{{depuis|13.1.1.44971}}
 +
**Ajout des critères N°1 à 3 :
 +
"Crit1": "string",
 +
"Crit2": "string",
 +
"Crit3": "string",
 +
 
 +
==API WebConnect '''ClientsGetDiffusion'''==
  
−
=API "Stocks"=
+
=API WebConnect "Stocks"=
−
==GET Stocks / Stocks==
+
==API Webconnect Stocks / Stocks (GET)==
 
===Filtres===
 
===Filtres===
 
{{depuis|10.0.8}}
 
{{depuis|10.0.8}}
Ligne 36 : Ligne 156 :
 
                 "2022-02-11T00:00:00"
 
                 "2022-02-11T00:00:00"
 
               ]
 
               ]
 +
=API WebConnect "Ventes"=
 +
==API Webconnect Ventes / Ventes (PUT) ==
 +
{{depuis|13.1.1}}
 +
*Ajout de la notion de vente défectueuse :
 +
"Defectueux": false
 +
"Defectueux": true

Version actuelle datée du 13 mai 2025 à 10:05

Voir la carte de la fonctionnalité : A classer



Gestion des appareils

  • <Système / gestion des appareils
  • Nouvel appareil ou Nouveau prestataire / WebConnect
Disponible depuis la version 11.02

Appareil "Webconnect"

Paramétrer :

  • Magasin de réference
  • Utiliser les descriptions du site internet : saisir le site internet
  • Exposer uniquement les produits publiés sur ce site :
    • si coché : exporte uniquement les articles publiés sur le site internet renseigné
    • si décoché :
Disponible depuis la version 13.03
      • OU Sinon, utiliser le filtrage suivant : décoché par défaut.
        • Si coché : permet de définir les articles exportés via des filtres.
  • Préfixe des références externes


  • Autoriser :
    • Imports clients
    • Modif. clients existants
    • Import bons
    • Imports transferts
    • Imports réservations
    • Imports vente en gros
    • Exports clients
Disponible depuis la version 11.02
      • Que les clients avec e-mail :
        • Décoché : (par défaut). Tous les clients
        • Coché : QUE les clients avec e-mail
    • Imports ventes
    • Exports bons
    • Exports des PA
    • Export réservations
    • Export ventes

Lors de l'importation des ventes :

  • Code caisse par défaut
  • Code vendeur par défaut
  • Magasins exposés : permet de filtrer les clients sur le "Magasin lié" de la fiche client.
    • Sélectionner les magasins ou cocher Exposer tous les magasins
Disponible depuis la version 11.02
  • Magasins autorisés pour les clients : "Magasin lié" de la fiche client
    • Sélectionner les magasins ou cocher Tous les magasins

API WebConnect "Catalog"

Les API suivantes intégrent les libellés renseignés dans le site internet :

  • Catalog/Categories1 à 4
  • Catalog/CategoriesEXT1 à 4
  • Catalog/Niveaux1 à 4
  • Catalog/NiveauxEXT1 à 4
  • Catalog/Classifications
  • Catalog/ClassificationsEXT

API Webconnect CATALOG/Magasin (GET) CatalogGetMagasin

Disponible depuis la version 12.2
  • Ajout de la rubrique "Horaires" qui renseigne les jours et horaires du magasin. par exemple :
    • "Horaires": "Dimanche : Fermé, Lundi : Fermé, Mardi : 10-19, Mercredi : 10-19, Jeudi : 10-19, Vendredi : 10-19, Samedi : 9-20"

API Webconnect CATALOG/Produits (GET)

Rubriques

Rubrique "GrilleTaille"

Disponible depuis la version 12.2

GrilleTaille : libellé de la grille taille :

  • "GrilleTaille": "chaussures 36 au 41",

Rubrique "TauxTVA"

Disponible depuis la version 12.2

TauxTVA

  • "TauxTVA": 0.2 pour une TVA à 20 %
  • "TauxTVA": 0.055 pour une TVA à 5.5 %

Rubrique "Zonage" taille

Disponible depuis la version 12.2
  • Dans Polaris pour paramétrer le zonage taille :
  • Système / paramétrages / applications / rayonnage / "Niveau du zonage dépôt" = tailles
  • Ajout du zonage à la taille : Zonage dans la rubrique Tailles.
    • Exemple de zonage à la taille renseigné
"Tailles": [
{
"Taille": "s",
"TailleFour": null,
"Zonage": "a01p01e01",
"Refs": [
"11686484"
],
...
    • Exemple de zonage taille non renseigné
"Tailles": [
{
"Taille": "s",
"TailleFour": null,
"Zonage": "",
"Refs": [
"11686460"
],
...


A savoir :
ATTENTION : si on repasse au paramétrage zonage au critère, Polaris n'efface pas le zonage saisi à la taille et l'API ressortira le zonage à la taille renseigné précédemment.

API Webconnect CATALOG/ProduitsInvalides (GET)

Disponible depuis la version 12.2
  • Lorsque les produits sont supprimés/dépubliés, ils ne sortent plus dans le endpoint Produits et donc l'utilisateur de l'API n'est pas mis au courant que tel ou tel produit doit être supprimé du site.
  • L'API ProduitsInvalides Création d'un EndPoint permettant de lister tous les produits qui ne DOIVENT PAS/PLUS être sur le site.

Cela permet de boucler sur les références tailles (code barres Polaris) et de les supprimer du site s'ils existent.

API WebConnect "Clients"

API WebConnect ClientsPostBon

  • Si le client ne fait pas partie des magasins autorisés pour les clients : "Message": "Le client n'est associé à aucun magasin autorisé"

API WebConnect ClientsGetBon

  • Filtre sur le CB du bon : Le programme affiche le bon même si le client ne fait pas partie des "magasins autorisés pour les clients".

API WebConnect ClientsGetBons

  • Le programme affiche uniquement les bons des clients dont le magasin fait partie des "magasins autorisés pour les clients".

API WebConnect ClientsGetCartePrePaye

  • Filtre sur le CB de la carte pré-payée : Le programme n'affiche pas la CPP si le client ne fait pas partie des "magasins autorisés pour les clients" : "Message": "Not Found".

API WebConnect ClientsGetCartePrePayes

  • Le programme affiche uniquement les cartes pré-payées des clients dont le magasin fait partie des "magasins autorisés pour les clients".

API WebConnect ClientsGetClient

  • Si le magasin du client ne fait pas partie des magasins autorisés pour les clients : "Message": "Not Found".
Disponible depuis la version 13.1.1.44971
    • Ajout des critères N°1 à 3 :
"Crit1": "string",
"Crit2": "string",
"Crit3": "string",

API WebConnect ClientsPostClient

  • Si le magasin du client ne fait pas partie des magasins autorisés pour les clients : "Message": "Not Found".

API WebConnect ClientsDeleteClient

  • ne supprime pas le client si le magasin du client ne fait pas partie des magasins autorisés pour les clients : "Message": "Le client n'est associé à aucun magasin autorisé".

API WebConnect ClientsPutClientCarte

  • Si le magasin du client ne fait pas partie des magasins autorisés pour les clients : "Message": "Le client n'est associé à aucun magasin autorisé".

API WebConnect ClientsGetClients

  • Le programme affiche uniquement les clients dont le magasin fait partie des "magasins autorisés pour les clients".
Disponible depuis la version 13.1.1.44971
    • Ajout des critères N°1 à 3 :
"Crit1": "string",
"Crit2": "string",
"Crit3": "string",

API WebConnect ClientsGetDiffusion

API WebConnect "Stocks"

API Webconnect Stocks / Stocks (GET)

Filtres

Disponible depuis la version 10.0.8
  • Nouveau filtre IsInternet (boolean) : Le plan de solde est valable sur internet
NF17502 APiWebconnect 1.png

Rubriques

Disponible depuis la version 10.0.8
  • La nouvelle rubrique DatesLivrPrev liste les dates de réception prévisionnelles des commandes fournisseur en cours (Commandes validées non ou partiellement reçues).

Par exemple : 

"DatesLivrPrev": [
               "2022-03-01T00:00:00",
               "2022-02-11T00:00:00"
             ]

API WebConnect "Ventes"

API Webconnect Ventes / Ventes (PUT)

Disponible depuis la version 13.1.1
  • Ajout de la notion de vente défectueuse :
"Defectueux": false
"Defectueux": true
Récupérée de « https://extranet.vega-info.fr/doc-polaris/index.php?title=NF17502_—_API_WebConnect&oldid=32353 »