Export van de bestellingen
URL van de Webservice : https://sws.spartoo.nl/mp/xml_export_orders.phpDeze webservice laat toe om gegevens over bestellingen te kennen vanaf een bepaalde datum of op basis van een referentie.
Bestellingen kunnen gefilterd worden op status
Lijst met parameters
De parameters van deze webservice dienen verplicht als POST te zijnParameter | Omschrijving |
---|---|
partner | Dit dient uw unieke ID te bevatten: |
date | Datum vanaf dewelke u bestellingen wenst te selecteren. Formaat: JJJJ-MM-DD:uu:mm:ss (voorbeeld: 2011-11-27:03:00:00) |
oID | Referentie van de bestelling |
statut |
Status van de te ontvangen bestellingen. Indien de parameter niet is ingevuld, worden hierdoor al de bestellingen geselecteerd. > Bekijk de lijst met statussen |
De Partner parameter is verplicht en een van de twee parameters datum of bestelreferentie is verplicht. De parameter status is facultatief.
Formaat van de teruggestuurde XML data
<root> <orders> <order> <orders_id>string</orders_id> <customers> <customers_firstname>string</customers_firstname> <customers_lastname>string</customers_lastname> <customers_housenumber>string</customers_housenumber> <customers_street_address>string</customers_street_address> <customers_suburb>string</customers_suburb> <customers_city>string</customers_city> <customers_postcode>string</customers_postcode> <customers_state>string</customers_state> <customers_country>string</customers_country> <customers_email_address>string</customers_email_address> <customers_telephone>string</customers_telephone> </customers> <delivery> <delivery_firstname>string</delivery_firstname> <delivery_lastname>string</delivery_lastname> <!-- ... Het HTML-element "relay_info" wordt alleen getoond voor bestellingen die op het afhaalpunt geleverd worden ... --> <relay_info> <relay_id>int</relay_id> <relay_type>string</relay_type> <relay_name>string</relay_name> <relay_address>string</relay_address> <relay_city>string</relay_city> <relay_postcode>string</relay_postcode> <relay_country_iso>string</relay_country_iso> </relay_info> <!-- ... De onderstaande HTML-elementen "delivery_*" worden alleen getoond bij bestellingen die niet op een afhaalpunt geleverd worden ... --> <delivery_housenumber>string</delivery_housenumbery> <delivery_suburb>string</delivery_suburb> <delivery_street_address>string</delivery_street_address> <delivery_city>string</delivery_city> <delivery_postcode>string</delivery_postcode> <delivery_state>string</delivery_state> <delivery_country>string</delivery_country> </delivery> <payment_method>string</payment_method> <payment_price>float</payment_price> <shipping_price>float</shipping_price> <shipping_name>string</shipping_name> <order_total>float</order_total> <orders_status_name>string</orders_status_name> <orders_status_id>int</orders_status_id> <date_purchased>[DATE]</date_purchased> <last_modified>[DATE]</last_modified> <products> <product> <products_reference>string</products_reference> <products_name>string</products_name> <products_qty>int</products_qty> <products_spartoo>int</products_spartoo> <products_manufacturers>string</products_manufacturers> <products_size>string</products_size> <products_size_reference>string</products_size_reference> <products_color>string</products_color> <products_price_unit>float</products_price_unit> <products_price_unit_with_reduce>float</products_price_unit_with_reduce> <products_final_price>float</products_final_price> </product> <!-- ... Meerdere tags "product" mogelijk ... --> </products> <errors> <error> <id>int</id> <description>string</description> </error> </errors> </order> <!-- ... Meerdere tags "order" mogelijk ... --> </orders> <statut> <id>int</id> <description>string</description> </statut> </root>
Optionele HTML-elementen
Als het een bestelling betreft dat op een afhaalpunt wordt geleverd dan het HTML-element relay_info toevoegen en de HTML-elementen delivery_* verwijderen, met uitzondering van de achternaam en voornaam.Als het een bestelling betreft dat niet op een afhaalpunt wordt geleverd dan HTML-element relay_info verwijderen en alle HTML-elementen delivery_* tonen.
Lijst met de foutcodes van de webservice
Code | Omschrijving |
---|---|
1 | Geen fouten in de parameters |
-1 | De parameter partenaire werd niet als parameter aangemaakt of is leeg |
-2 | De partenaire parameter bestaat niet |
-3 | Er ontbreekt een verplichte parameter (date of oID/rID ) |
-4 | Formaat van de datum ongeldig |
-428 | Uw account is gedeactiveerd. U kunt niet langer gebruik maken van de webservices |
-429 | U heeft te veel gebruik gemaakt van deze webservice voor dit uur |
Omschrijving van de velden van het XML antwoord
Tag | Omschrijving |
---|---|
orders_id | Referentie bestelling |
customers | Informatie over klant voor facturatie |
delivery | Informatie over klant voor levering |
customers_firstname / delivery_firstname | Voornaam klant |
customers_lastname / delivery_lastname | Achternaam klant |
customers_company / delivery_company | Bedrijf klant |
customers_street_address / delivery_street_address | Adres klant |
customers_suburb / delivery_suburb | Adrestoevoeging klant |
customers_city / delivery_city | Woonplaats klant |
customers_postcode / delivery_postcode | Postcode klant |
customers_country / delivery_country | Land klant |
customers_telephone | Telefoon klant |
relay_info | Informatie over het afhaalpunt |
relay_id | Gegevens over het afhaalpunt |
relay_type | Type afhaalpunt |
relay_name | Naam van het afhaalpunt |
relay_address | Adres van het afhaalpunt |
relay_city | Woonplaats van het afhaalpunt |
relay_postcode | Postcode van het afhaalpunt |
relay_country | Land van het afhaalpunt |
payment_method | Betaalwijze |
payment_price | Kost betaling (momenteel nog steeds 0) |
order_total | Totaal bestelling |
orders_status_name | Naam huidige status van de bestelling |
orders_status_id | Id huidige status van de bestelling |
date_purchased | Datum van bestelling |
last_modified | Datum laatste wijziging van de bestelling |
products | Lijst producten |
products_reference | Productreferentie partner |
products_spartoo | Productreferentie Spartoo |
products_name | Naam model |
products_qty | Bestelde aantal |
products_manufacturers | Naam van het merk |
products_size | Bestelde maat |
products_color | Kleur product |
products_price_unit | Eenheidsprijs |
products_price_unit_with_reduce | Prijs met korting |
products_final_price | products_price_unit_with_reduce x products_qty |
Voorbeelden van XML retour
Voorbeeld KO :
<root> <orders> <order> <orders_id>90D813EA1A2365A8</orders_id> <customers> </customers> <delivery> <delivery_firstname><![CDATA[Robert]]></delivery_firstname> <delivery_lastname><![CDATA[Durand]]></delivery_lastname> <relay_info> <relay_id>1505</relay_id> <relay_type><![CDATA[kiala]]></relay_type> <relay_name><![CDATA[(NP)LE PAPYRUS]]></relay_name> <relay_address><![CDATA[Boulevard Gambetta]]></relay_address> <relay_city><![CDATA[Grenoble]]></relay_city> <relay_postcode><![CDATA[38000]]></relay_postcode> <relay_country_iso><![CDATA[FR]]></relay_country_iso> </relay_info> <delivery_company><![CDATA[Spartoo]]></delivery_company> <delivery_suburb><![CDATA[16 rue Henri Barbusse]]></delivery_suburb> <delivery_street_address><![CDATA[16 rue Henri Barbusse]]></delivery_street_address> <delivery_city><![CDATA[Grenoble]]></delivery_city> <delivery_postcode><![CDATA[38100]]></delivery_postcode> <delivery_state></delivery_state> <delivery_country><![CDATA[France]]></delivery_country> </delivery> <payment_method><![CDATA[Paiement par carte bancaire]]></payment_method> <payment_price>0</payment_price> <order_total>120.0000</order_total> <orders_status_name><![CDATA[Commande Vérifiée]]></orders_status_name> <orders_status_id>11</orders_status_id> <date_purchased>2013-02-12 14:00:00</date_purchased> <last_modified>2013-02-12 14:00:00</last_modified> <products> <product> <products_reference><![CDATA[ABCD]]></products_reference> <products_name><![CDATA[ALL STAR HI]]></products_name> <products_qty>2</products_qty> <products_spartoo>123456</products_spartoo> <products_manufacturers><![CDATA[Converse]]></products_manufacturers> <products_size>42</products_size> <products_size_reference><![CDATA[AAAAAA]]></products_size_reference> <products_color><![CDATA[Blanc]]></products_color> <products_price_unit>60.00</products_price_unit> <products_price_unit_with_reduce>200.00</products_price_unit_with_reduce> <products_final_price>120.00</products_final_price> </product> </products> <errors> <error> <id>-1</id> <description>Le paramètre partenaire n'est passé ou est vide</description> </error> </errors> </order> </orders> <statut> <id>41</id> <description>Annulation commande</description> </statut> </root>
Voorbeeld OK :
<root> <orders> <order> <orders_id>90D813EA1A2365A8</orders_id> <customers> <customers_firstname><![CDATA[Robert]]></customers_firstname> <customers_lastname><![CDATA[Durand]]></customers_lastname> <customers_company><![CDATA[Spartoo]]></customers_company> <customers_street_address><![CDATA[16 rue Henri Barbusse]]></customers_street_address> <customers_suburb><![CDATA[2eme Etage]]></customers_suburb> <customers_city><![CDATA[Grenoble]]></customers_city> <customers_postcode><![CDATA[38100]]></customers_postcode> <customers_state></customers_state> <customers_country><![CDATA[France]]></customers_country> <customers_telephone><![CDATA[0612345678]]></customers_telephone> </customers> <delivery> <delivery_firstname><![CDATA[Robert]]></delivery_firstname> <delivery_lastname><![CDATA[Durand]]></delivery_lastname> <relay_info> <relay_id>1505</relay_id> <relay_type><![CDATA[kiala]]></relay_type> <relay_name><![CDATA[(NP)LE PAPYRUS]]></relay_name> <relay_address><![CDATA[Boulevard Gambetta]]></relay_address> <relay_city><![CDATA[Grenoble]]></relay_city> <relay_postcode><![CDATA[38000]]></relay_postcode> <relay_country_iso><![CDATA[FR]]></relay_country_iso> </relay_info> <delivery_company><![CDATA[Spartoo]]></delivery_company> <delivery_suburb><![CDATA[16 rue Henri Barbusse]]></delivery_suburb> <delivery_street_address><![CDATA[16 rue Henri Barbusse]]> </delivery_street_address> <delivery_city><![CDATA[Grenoble]]></delivery_city> <delivery_postcode><![CDATA[38100]]></delivery_postcode> <delivery_state></delivery_state> <delivery_country><![CDATA[France]]></delivery_country> </delivery> <payment_method><![CDATA[Paiement par carte bancaire]]></payment_method> <payment_price>0</payment_price> <order_total>120.0000</order_total> <orders_status_name><![CDATA[Commande Vérifiée]]></orders_status_name> <orders_status_id>11<orders_status_id> <date_purchased>2013-02-12 14:00:00</date_purchased> <last_modified>2013-02-12 14:00:00</last_modified> <products> <product> <products_reference>ABCD</products_reference> <products_name><![CDATA[ALL STAR HI]]></products_name> <products_qty>2</products_qty> <products_spartoo>123456</products_spartoo> <products_manufacturers><![CDATA[Converse]]></products_manufacturers> <products_size>42></products_size> <products_size_reference><![CDATA[AAAAAA]]></products_size_reference> <products_color><![CDATA[Blanc]]></products_color> <products_price_unit>60.00</products_price_unit> <products_price_unit_with_reduce>200.00</products_price_unit_with_reduce> <products_final_price>120.00</products_final_price> </product> </products> <errors> <error> <id>1</id> <description>Pas d'erreur de paramètres</description> </error> </errors> </order> </orders> <statut> <id>11</id> <description>Commande vérifiée</description> </statut> </root>