Différences entre versions de « WebAPI Catalog.SearchProducts »

Version actuelle datée du 26 janvier 2024 à 10:31

Disponible depuis la version 6.02

L'API par Webservice vous permet de piloter ou d'interroger votre solution de gestion depuis un programme externe via un langage normalisé. Pour obtenir plus d'informations sur la bibliothèque d'APIs, consultez la page de documentation suivante : Interface de programmation applicative par Webservice (API).

L'API Catalog permet d'interroger le système d'information sur les données publiques et le catalogue des produits gérés et proposés à la vente

⚠️⚠️⚠️ Ce webservice a été déclaré obsolète et sera prochainement retiré du backoffice Polaris.
Vous devez utiliser nos nouvelles API REST dont vous trouverez la ProductsFound Catalog.SearchProducts ([Int64 noSite = 0], [Filter filter = null], [Int64 (Optionnel) noMagasinPrix = null], [String tri = null], [String ordreTri = ASC], [Int32 pageNo = 1], [Int32 pageSize = 24], [xml|json output = xml ])

Recherche de produits

Arguments :

Nom	Type	Description
noSite	Int64	(optionnel, par défaut: 0) Numéro de site internet pour lequel nous tirons les données. Indiquer 0 pour tirer les informations de base, en dehors de toute considération de données de site Internet.
filter	Filter	(optionnel, par défaut: null) Filtre de recherche
noMagasinPrix	Int64 (Optionnel)	(optionnel, par défaut: null) Numéro de magasin de référence de prix pour le tri par prix
tri	String	(optionnel, par défaut: null) Tri des données (ref, prix, nouveau, modif)
ordreTri	String	(optionnel, par défaut: ASC) Ordre du tri (ASC ascendant / DESC descendant)
pageNo	Int32	(optionnel, par défaut: 1) Numéro de la page de résultats souhaités
pageSize	Int32	(optionnel, par défaut: 24) Nombre de produits par page de résultats
output	xml\|json	(optionnel, par défaut: xml) Format de la réponse
Retour	[/core/api/Catalog.SearchProducts?doc&docType=RepDaemon.WebService2.CoreAPI.Catalog%2bProductsFound ProductsFound]	Non documenté

Politique de sécurité et règles d'accès à l'API :

au moins une des conditions suivantes doit être vérifiée :

être identifié
passer par un lien de type boucle locale
passer par un lien de type machine
passer par un lien de type lien local

@@ Ligne 4 : / Ligne 4 : @@
 Pour obtenir plus d'informations sur la bibliothèque d'APIs, consultez la page de documentation suivante : [[NF13075|Interface de programmation applicative par Webservice (API)]].
-<div id='api-body'><p class='prp'>L'API Catalog permet d'interroger le système d'information sur les données publiques et le catalogue des produits gérés et proposés à la vente</p><br/><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>https://nur298.ws-dev.polarisgestionmag.net/core/api/Catalog.SearchProducts</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Catalog+ProductsFound|ProductsFound]]</span> <span class='method-name'>Catalog.SearchProducts</span><span class='parameters'>&nbsp;(<span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</span> <span class='parameter-name'>noSite</span> = 0]</span>, <span class='opt'>[<span class='parameter-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Catalog+Filter|Filter]]</span> <span class='parameter-name'>filter</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64 (Optionnel)]</span> <span class='parameter-name'>noMagasinPrix</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>tri</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>ordreTri</span> = ASC]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</span> <span class='parameter-name'>pageNo</span> = 1]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</span> <span class='parameter-name'>pageSize</span> = 24]</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Recherche de produits</p><div class='args'><p><span class='lbl'>Arguments&nbsp;:</span></p><table class='t-args'><tr><th>Nom</th><th>Type</th><th>Description</th></tr><tr><th class='parameter-name'>noSite</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 0)<br/></span><span class='param-doc'>Numéro de site internet pour lequel nous tirons les données. Indiquer 0 pour tirer les informations de base, en dehors de toute considération de données de site Internet.</span></td></tr><tr><th class='parameter-name'>filter</th><td class='parameter-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Catalog+Filter|Filter]]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Filtre de recherche</span></td></tr><tr><th class='parameter-name'>noMagasinPrix</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64 (Optionnel)]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Numéro de magasin de référence de prix pour le tri par prix</span></td></tr><tr><th class='parameter-name'>tri</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Tri des données (ref, prix, nouveau, modif)</span></td></tr><tr><th class='parameter-name'>ordreTri</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: ASC)<br/></span><span class='param-doc'>Ordre du tri (ASC ascendant / DESC descendant)</span></td></tr><tr><th class='parameter-name'>pageNo</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 1)<br/></span><span class='param-doc'>Numéro de la page de résultats souhaités</span></td></tr><tr><th class='parameter-name'>pageSize</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 24)<br/></span><span class='param-doc'>Nombre de produits par page de résultats</span></td></tr><tr><th class='parameter-name'>output</th><td class='parameter-type'>xml|json</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: xml)<br/></span><span class='param-doc'>Format de la réponse</span></td></tr><tr class='t-return'><th>Retour</th><td class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Catalog+ProductsFound|ProductsFound]]</td><td class='return-doc'>Non documenté</td></tr></table><p><span class='lbl'>Politique de sécurité et règles d'accès à l'API&nbsp;:</span></p><p style='padding-left:1em;'>au moins une des conditions suivantes doit être vérifiée&nbsp;: <ul><li>être identifié</li><li>passer par un lien de type <span class='security-elt'>boucle locale</span></li><li>passer par un lien de type <span class='security-elt'>machine</span></li><li>passer par un lien de type <span class='security-elt'>lien local</span></li></ul></p></div></div>
+<div id='api-body'><p class='prp'>L'API Catalog permet d'interroger le système d'information sur les données publiques et le catalogue des produits gérés et proposés à la vente</p><br/><div class="obsolete">⚠️⚠️⚠️ <strong>Ce webservice a été déclaré obsolète et sera prochainement retiré du backoffice Polaris.</strong><br>Vous devez utiliser nos nouvelles API REST dont vous trouverez la [[WebAPI Type RepDaemon.WebService2.CoreAPI.Catalog+ProductsFound|ProductsFound]]</span> <span class='method-name'>Catalog.SearchProducts</span><span class='parameters'>&nbsp;(<span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</span> <span class='parameter-name'>noSite</span> = 0]</span>, <span class='opt'>[<span class='parameter-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Catalog+Filter|Filter]]</span> <span class='parameter-name'>filter</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64 (Optionnel)]</span> <span class='parameter-name'>noMagasinPrix</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>tri</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>ordreTri</span> = ASC]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</span> <span class='parameter-name'>pageNo</span> = 1]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</span> <span class='parameter-name'>pageSize</span> = 24]</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Recherche de produits</p><div class='args'><p><span class='lbl'>Arguments&nbsp;:</span></p><table class='t-args'><tr><th>Nom</th><th>Type</th><th>Description</th></tr><tr><th class='parameter-name'>noSite</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 0)<br/></span><span class='param-doc'>Numéro de site internet pour lequel nous tirons les données. Indiquer 0 pour tirer les informations de base, en dehors de toute considération de données de site Internet.</span></td></tr><tr><th class='parameter-name'>filter</th><td class='parameter-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.Catalog+Filter|Filter]]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Filtre de recherche</span></td></tr><tr><th class='parameter-name'>noMagasinPrix</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int64 Int64 (Optionnel)]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Numéro de magasin de référence de prix pour le tri par prix</span></td></tr><tr><th class='parameter-name'>tri</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Tri des données (ref, prix, nouveau, modif)</span></td></tr><tr><th class='parameter-name'>ordreTri</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: ASC)<br/></span><span class='param-doc'>Ordre du tri (ASC ascendant / DESC descendant)</span></td></tr><tr><th class='parameter-name'>pageNo</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 1)<br/></span><span class='param-doc'>Numéro de la page de résultats souhaités</span></td></tr><tr><th class='parameter-name'>pageSize</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Int32 Int32]</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: 24)<br/></span><span class='param-doc'>Nombre de produits par page de résultats</span></td></tr><tr><th class='parameter-name'>output</th><td class='parameter-type'>xml|json</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: xml)<br/></span><span class='param-doc'>Format de la réponse</span></td></tr><tr class='t-return'><th>Retour</th><td class='return-type'>[/core/api/Catalog.SearchProducts?doc&docType=RepDaemon.WebService2.CoreAPI.Catalog%2bProductsFound ProductsFound]</td><td class='return-doc'>Non documenté</td></tr></table><p><span class='lbl'>Politique de sécurité et règles d'accès à l'API&nbsp;:</span></p><p style='padding-left:1em;'>au moins une des conditions suivantes doit être vérifiée&nbsp;: <ul><li>être identifié</li><li>passer par un lien de type <span class='security-elt'>boucle locale</span></li><li>passer par un lien de type <span class='security-elt'>machine</span></li><li>passer par un lien de type <span class='security-elt'>lien local</span></li></ul></p></div></div>
 {{FinInfoCartographe}}
 [[Catégorie:Webservice Catalog|SearchProducts]]