- Informations générales
- Gestion de stock
Rapport d’import générique (genericimportreport)
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
Structure du fichier XML
-
1. Utilisation
Ce Webservice permet de visualiser l’état de soumission de votre stock à partir du numéro « importid » fourni dans le Webservice précédent (ou visible dans : « Mon compte > Envoyer mes fichiers de stock »)
Le fichier de stock peut être :
Reçu : ReçuTraité : Traité
En attente : En attente
M.à.j. en cours: Import en coursAnnulé : Annulé
Aucune ligne n’a été chargée : Fichier XML corrompu
Ce Webservice est accessible aux vendeurs professionnels uniquement.
-
2. Url
https://ws.fr.shopping.rakuten.com/stock_ws?action=genericimportreport&login=xxxxx&pwd=xxxxx&version=xxxx-xx-xx&fileid=xxxxx
<errorresponse xsi:schemaLocation=”https://static.fr.shopping.rakuten.com/res/schema/error https://static.fr.shopping.rakuten.com/res/schema/error/error.xsd”>
<error>
<type>Unknown error</type>
<code>Unknown error</code>
<message>Service unavailable</message>
<details>
<detail></detail>
</details>
</error>
</errorresponse><2errorresponse xsi:schemaLocation=”https://static.fr.shopping.rakuten.com/res/schema/error https://static.fr.shopping.rakuten.com/res/schema/error/error.xsd”>
<error>
<type>Unknown error</type>
<code>Unknown error</code>
<message>Service unavailable</message>
<details>
<detail></detail>
</details>
</error>
</errorresponse> -
3. Paramètres
Nom Description Obligatoire action genericimportreport Oui login login du vendeur Oui pwd Vous avez besoin de votre Token. Plus d’informations ICI. Et vous trouverez votre Token ICI. Oui versionversion du Webservice à utiliser OuiCliquer ici pour voir le dernier numéro de version fileid Numéro du fichier dans la file d’attente (répondu par le précédent Webservice) ou visible dans : « mon compte > Envoyer mes fichiers de stock » Oui nexttoken permet de paginer les résultats Non -
4. XSD
5. Erreurs possibles Type Code Message Detail Sender InvalidUserConnection Unknown user or password. Incorrect login or password Sender Parameters Error Problem with parameters The version xxx is not supported Sender Parameters Error Problem with parameters Could not find the following fileId : xxx Ci-dessous les différents codes d’erreur : Valeur Description 10 Fichier XML mal formé 20 Id Annonce/Produit n’est pas un nombre 30 Balise <key> ou <value> manquante 40 Annonce / Produit non trouvé 50 Plusieurs annonces/produits correspondent 60 Valeur manquante / non acceptée <xs:schema xmlns:xs=”http://www.w3.org/2001/XMLSchema“ xmlns:ns=”https://static.fr.shopping.rakuten.com/res/schema/genericimportreport“ elementFormDefault=”qualified“ targetNamespace=”https://static.fr.shopping.rakuten.com/res/schema/genericimportreport“><xs:element name=”genericimportreportresult“><xs:annotation><xs:documentation><![CDATA[ This service allows you to get a report on the state of your submitted stock import file. This webservice can be called on a URL like this one: https://ws.priceminister.<country_suffix>/stock_ws?action=genericimportreport&version=<version>&login=<login>pwd=<password>&fileid=<fileid>&nexttoken=<nexttoken> If the call succeeds, you will get an element ‘request’ that lists the parameters you have passed in your call, as well as an element ‘response’ containing the requested data. If the call fails, you will get an error message that uses a standard XML structure common to all priceminister webservices. You can get the schema for the error response here: https://static.fr.shopping.rakuten.com/res/schema/error/error.xsd ]]></xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element name=”request“ type=”ns:RequestType“/><xs:element name=”response“ type=”ns:ResponseType“/></xs:sequence></xs:complexType></xs:element><xs:complexType name=”RequestType“><xs:sequence><xs:element name=”user“ type=”xs:string“/><xs:element name=”version“ type=”xs:string“><xs:annotation><xs:documentation><![CDATA[ The webservice version: YYYY-MM-DD ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”fileid“ type=”xs:long“><xs:annotation><xs:documentation><![CDATA[ The id of the file in the processing list. This number can come from either the data file submission service response or the screen “My account >Upload my incoming stock data”. ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”nexttoken“ type=”xs:long“ minOccurs=”0“ maxOccurs=”1“><xs:annotation><xs:documentation><![CDATA[ This webservice includes a pagination. This is the id of the page you are trying to get the results from. ]]></xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType><xs:complexType name=”ResponseType“><xs:sequence><xs:element name=”file“ type=”ns:FileType“/><xs:element name=”product“ type=”ns:ProductType“ minOccurs=”0“ maxOccurs=”unbounded“/><xs:element name=”nexttoken“ type=”xs:long“ minOccurs=”0“ maxOccurs=”1“><xs:annotation><xs:documentation><![CDATA[ If all the results of the report cannot be retrieved in one time, this tag indicates the id of the next page to request to get the missing data. Results on massive reports can require numerous requests to get the full report. ]]></xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType><xs:complexType name=”FileType“><xs:sequence><xs:element name=”filename“ type=”xs:string“><xs:annotation><xs:documentation><![CDATA[ The name of the submitted stock import file ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”status“ type=”xs:string“><xs:annotation><xs:documentation><![CDATA[ The status of the file, indicating its current state in the processing system ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”uploaddate“ type=”xs:dateTime“><xs:annotation><xs:documentation><![CDATA[ The date of the upload ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”processdate“ type=”xs:dateTime“><xs:annotation><xs:documentation><![CDATA[ The date when the file started being processed ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”totallines“ type=”xs:long“><xs:annotation><xs:documentation><![CDATA[ Total number of line in the file ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”processedlines“ type=”xs:long“><xs:annotation><xs:documentation><![CDATA[ Total lines processed ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”errorlines“ type=”xs:long“><xs:annotation><xs:documentation><![CDATA[ Total lines in error ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”successrate“ type=”xs:string“ minOccurs=”0“ maxOccurs=”1“><xs:annotation><xs:documentation><![CDATA[ The percentage of lines that has been processed (appearence depends on the state of the file) ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”imageprocessstatus“ type=”xs:string“><xs:annotation><xs:documentation> </xs:documentation></xs:annotation></xs:element><xs:element name=”imageerrorlist“ type=”ns:ImageErrorListType“ minOccurs=”0“ maxOccurs=”1“><xs:annotation><xs:documentation><![CDATA[ The list of images in error ]]></xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType><xs:complexType name=”ProductType“><xs:sequence><xs:element name=”sku“ type=”xs:string“ minOccurs=”0“ maxOccurs=”1“/><xs:element name=”status“ type=”xs:string“/><xs:element name=”pid“ type=”xs:long“ minOccurs=”0“ maxOccurs=”1“/><xs:element name=”aid“ type=”xs:long“ minOccurs=”0“ maxOccurs=”1“/><xs:element name=”errors“ type=”ns:ErrorListType“ minOccurs=”0“ maxOccurs=”1“/></xs:sequence></xs:complexType><xs:complexType name=”ErrorListType“><xs:sequence><xs:element name=”error“ type=”ns:ErrorType“ minOccurs=”0“ maxOccurs=”unbounded“/></xs:sequence></xs:complexType><xs:complexType name=”ErrorType“><xs:sequence><xs:element name=”error_key“ type=”xs:string“ minOccurs=”0“ maxOccurs=”1“><xs:annotation><xs:documentation><![CDATA[ The key of the attribute concerned. ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”error_code“ type=”xs:long“><xs:annotation><xs:documentation><![CDATA[ The code of the error that occurred. ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”error_text“ type=”xs:string“><xs:annotation><xs:documentation><![CDATA[ A label describing the error. ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”fatal_error“><xs:annotation><xs:documentation><![CDATA[ The error stopping the line process. ]]></xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType><xs:complexType name=”ImageErrorListType“><xs:sequence><xs:element name=”error“ type=”ns:ImageErrorType“ minOccurs=”0“ maxOccurs=”unbounded“/></xs:sequence></xs:complexType><xs:complexType name=”ImageErrorType“><xs:sequence><xs:element name=”urlimg“ type=”xs:string“/><xs:element name=”advertid“ type=”xs:long“/><xs:element name=”detail“ type=”xs:string“/></xs:sequence></xs:complexType></xs:schema><aa xs:schema xmlns:xs=”http://www.w3.org/2001/XMLSchema“ xmlns:ns=”https://static.fr.shopping.rakuten.com/res/schema/genericimportreport“ elementFormDefault=”qualified“ targetNamespace=”https://static.fr.shopping.rakuten.com/res/schema/genericimportreport“><xs:element name=”genericimportreportresult“><xs:annotation><xs:documentation><![CDATA[ This service allows you to get a report on the state of your submitted stock import file. This webservice can be called on a URL like this one: https://ws.priceminister.<country_suffix>/stock_ws?action=genericimportreport&version=<version>&login=<login>pwd=<password>&fileid=<fileid>&nexttoken=<nexttoken> If the call succeeds, you will get an element ‘request’ that lists the parameters you have passed in your call, as well as an element ‘response’ containing the requested data. If the call fails, you will get an error message that uses a standard XML structure common to all priceminister webservices. You can get the schema for the error response here: https://static.fr.shopping.rakuten.com/res/schema/error/error.xsd ]]></xs:documentation></xs:annotation><xs:complexType><xs:sequence><xs:element name=”request“ type=”ns:RequestType“/><xs:element name=”response“ type=”ns:ResponseType“/></xs:sequence></xs:complexType></xs:element><xs:complexType name=”RequestType“><xs:sequence><xs:element name=”user“ type=”xs:string“/><xs:element name=”version“ type=”xs:string“><xs:annotation><xs:documentation><![CDATA[ The webservice version: YYYY-MM-DD ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”fileid“ type=”xs:long“><xs:annotation><xs:documentation><![CDATA[ The id of the file in the processing list. This number can come from either the data file submission service response or the screen “My account >Upload my incoming stock data”. ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”nexttoken“ type=”xs:long“ minOccurs=”0“ maxOccurs=”1“><xs:annotation><xs:documentation><![CDATA[ This webservice includes a pagination. This is the id of the page you are trying to get the results from. ]]></xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType><xs:complexType name=”ResponseType“><xs:sequence><xs:element name=”file“ type=”ns:FileType“/><xs:element name=”product“ type=”ns:ProductType“ minOccurs=”0“ maxOccurs=”unbounded“/><xs:element name=”nexttoken“ type=”xs:long“ minOccurs=”0“ maxOccurs=”1“><xs:annotation><xs:documentation><![CDATA[ If all the results of the report cannot be retrieved in one time, this tag indicates the id of the next page to request to get the missing data. Results on massive reports can require numerous requests to get the full report. ]]></xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType><xs:complexType name=”FileType“><xs:sequence><xs:element name=”filename“ type=”xs:string“><xs:annotation><xs:documentation><![CDATA[ The name of the submitted stock import file ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”status“ type=”xs:string“><xs:annotation><xs:documentation><![CDATA[ The status of the file, indicating its current state in the processing system ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”uploaddate“ type=”xs:dateTime“><xs:annotation><xs:documentation><![CDATA[ The date of the upload ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”processdate“ type=”xs:dateTime“><xs:annotation><xs:documentation><![CDATA[ The date when the file started being processed ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”totallines“ type=”xs:long“><xs:annotation><xs:documentation><![CDATA[ Total number of line in the file ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”processedlines“ type=”xs:long“><xs:annotation><xs:documentation><![CDATA[ Total lines processed ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”errorlines“ type=”xs:long“><xs:annotation><xs:documentation><![CDATA[ Total lines in error ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”successrate“ type=”xs:string“ minOccurs=”0“ maxOccurs=”1“><xs:annotation><xs:documentation><![CDATA[ The percentage of lines that has been processed (appearence depends on the state of the file) ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”imageprocessstatus“ type=”xs:string“><xs:annotation><xs:documentation> </xs:documentation></xs:annotation></xs:element><xs:element name=”imageerrorlist“ type=”ns:ImageErrorListType“ minOccurs=”0“ maxOccurs=”1“><xs:annotation><xs:documentation><![CDATA[ The list of images in error ]]></xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType><xs:complexType name=”ProductType“><xs:sequence><xs:element name=”sku“ type=”xs:string“ minOccurs=”0“ maxOccurs=”1“/><xs:element name=”status“ type=”xs:string“/><xs:element name=”pid“ type=”xs:long“ minOccurs=”0“ maxOccurs=”1“/><xs:element name=”aid“ type=”xs:long“ minOccurs=”0“ maxOccurs=”1“/><xs:element name=”errors“ type=”ns:ErrorListType“ minOccurs=”0“ maxOccurs=”1“/></xs:sequence></xs:complexType><xs:complexType name=”ErrorListType“><xs:sequence><xs:element name=”error“ type=”ns:ErrorType“ minOccurs=”0“ maxOccurs=”unbounded“/></xs:sequence></xs:complexType><xs:complexType name=”ErrorType“><xs:sequence><xs:element name=”error_key“ type=”xs:string“ minOccurs=”0“ maxOccurs=”1“><xs:annotation><xs:documentation><![CDATA[ The key of the attribute concerned. ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”error_code“ type=”xs:long“><xs:annotation><xs:documentation><![CDATA[ The code of the error that occurred. ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”error_text“ type=”xs:string“><xs:annotation><xs:documentation><![CDATA[ A label describing the error. ]]></xs:documentation></xs:annotation></xs:element><xs:element name=”fatal_error“><xs:annotation><xs:documentation><![CDATA[ The error stopping the line process. ]]></xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType><xs:complexType name=”ImageErrorListType“><xs:sequence><xs:element name=”error“ type=”ns:ImageErrorType“ minOccurs=”0“ maxOccurs=”unbounded“/></xs:sequence></xs:complexType><xs:complexType name=”ImageErrorType“><xs:sequence><xs:element name=”urlimg“ type=”xs:string“/><xs:element name=”advertid“ type=”xs:long“/><xs:element name=”detail“ type=”xs:string“/></xs:sequence></xs:complexType></xs:schema> -
5. Erreurs possibles
Type Code Message Detail Sender InvalidUserConnection Unknown user or password. Incorrect login or password Sender Parameters Error Problem with parameters The version xxx is not supported Sender Parameters Error Problem with parameters Could not find the following fileId : xxx Ci-dessous les différents codes d’erreur : Valeur Description 10 Fichier XML mal formé 20 Id Annonce/Produit n’est pas un nombre 30 Balise <key> ou <value> manquante 40 Annonce / Produit non trouvé 50 Plusieurs annonces/produits correspondent 60 Valeur manquante / non acceptée 70 Droits insuffisants -
6. Données de retour
Valeur Description user Login du vendeur version Version du webservice utilisé fileid Identifiant du fichier envoyé successrate Taux de réussite de l’import de stock totallines Nombre de lignes dans le fichier processedlines Nombre de lignes traitées errorlines Nombre de lignes en erreur successrate Taux de succès Product sku Référence privée du vendeur status Statut de l’import pid Identifiant du produit crée ou modifié aid Identifiant de l’annonce crée ou modifié errors Liste des erreurs Error Erreurs error_key Clé de l’attribut en erreur error_code Code d’erreur (voir ci-dessus) error_text Texte explicatif de l’erreur fatal_errorApparait si l’erreur est fatale. Dans le cas d’une création, cela bloque la création Dans le cas d’une modification, les autres modifications seront bloquées Images imageprocessstatus L’état de l’avancement de l’intégration des images de vos annonces: NONE, IN_PROCESS ou PROCESSED imageerrorlist / error La liste des images avec erreur urlimg L’URL de l’image avec erreur advertid L’id de l’annonce ayant une l’image avec erreur detail Le motif pour lequel l’image n’a pas pu être intégrée nextoken Nettoken de la page suivante -
7. Exemple de sortie
<genericimportreportresult xsi:schemaLocation=”http://pmcdn.priceminister.com/res/schema/genericimportreport http://pmcdn.priceminister.com/res/schema/genericimportreport/genericimportreport.2011-11-29.xsd”>
<request>
<user>xxxxxx</user>
<version>2011-11-29</version>
<fileid>xxxxxx</fileid>
</request>
<response>
<file>
<filename>file.xml</filename>
<status>Traité</status>
<uploaddate>2012-04-04T11:19:33</uploaddate>
<processdate>2012-04-04T11:30:56</processdate>
<totallines>1</totallines>
<processedlines>1</processedlines>
<errorlines>0</errorlines>
<successrate>100%</successrate>
</file>
<product>
<status>Traité</status>
<sku>mon SKU</sku>
<pid>1375729</pid>
<aid>551313383</aid>
<errors/>
</product>
</response>
</genericimportreportresult><genericimportreportresult xsi:schemaLocation=”http://pmcdn.priceminister.com/res/schema/genericimportreport http://pmcdn.priceminister.com/res/schema/genericimportreport/genericimportreport.2011-11-29.xsd”>
<request>
<user>xxxxx</user>
<version>2011-11-29</version>
<fileid>xxxxx</fileid>
</request>
<response>
<file>
<filename>file.xml</filename>
<status>Traité</status>
<uploaddate>2012-04-04T11:27:14</uploaddate>
<processdate>2012-04-04T11:31:02</processdate>
<totallines>1</totallines>
<processedlines>0</processedlines>
<errorlines>1</errorlines>
<successrate>0%</successrate>
</file>
<product>
<sku>mon SKU</sku>
<status>Erreur</status>
<errors>
<error>
<error_key>qty</error_key>
<error_code>60</error_code>
<error_text>Saisissez une quantité</error_text>
<fatal_error/>
</error>
</errors>
</product>
</response>
</genericimportreportresult>