Algemeen Sleutel Om gebruik te kunnen maken van de MWW orders feed heeft u een geldige sleutel nodig. Deze sleutel kan vanuit het Mijnwebwinkel beheer worden gegenereerd. Heeft u geen (geldige) sleutel neem dan contact op met de eigenaar van de webwinkel waarmee u een koppeling wilt maken.
Versie Naast een geldige sleutel dient ook de versie van de feed meegegeven te worden via de GET parameter ‘v’.
URL De URL voor de orders feed is https://feed.mijnwebwinkel.nl/orders/[SLEUTEL]/?v=[VERSIE] De eigenaar van de webwinkel waarmee u een koppeling wilt maken kan u de volledige URL inclusief sleutel en versie verstrekken. N.B. Deze verbinding is via SSL beveiligd en alleen via https:// beschikbaar.
Output De output van de koppeling is in XML formaat. De gebruikte character encoding is UTF-8.
Vragen? Heeft u vragen of opmerkingen m.b.t. de koppeling of documentatie? Neem dan contact met ons op via http://www.mijnwebwinkel.nl/contact/. Selecteer bij ‘onderwerp’ de optie ‘technisch probleem / vraag’.
Changelog Overzicht van aanpassingen per versie.
Versie
Informatie
1.0 1.0.1
Eerste versie van de orders feed. Toevoeging van nieuwe betaalmethodes voor de providers Sisow en Mollie. Ogone heet voortaan Ingenico.
Pagina | 3
MWW orders feed documentatie: versie 1.0.1
Veld definities In de tabellen hieronder staan per onderdeel de velden in de XML output beschreven.
Algemene informatie Algemene informatie over de XML export Pad: mwwfeed
Veldnaam
Type
Omschrijving
[attribuut ‘version’] total_records
string integer
Versie van het export script. Totaal aantal orders in de XML export. Default worden 10 orders getoond, dit is aan te passen via de GET parameter limit. Meer informatie hierover staat in het hoofdstuk ‘GET parameters’.
Pagina | 4
MWW orders feed documentatie: versie 1.0.1
Orders Alle aanwezige orders in de XML export. Pad: mwwfeed->orders
Order De details van elke order. Pad: mwwfeed->orders->order
Veldnaam
Type [max veldlengte]
Omschrijving
[attribuut ‘number’] date time description
integer [ 11] date [yyyy-mm-dd] time [HH:ii:ss] string [17]
date [yyyy-mm-dd] time [HH:ii:ss] string [variabel]
payment_method
integer [2]
weight
float [11,3]
comment
string [variabel]
Het ordernummer van de order. De datum van de order. De tijd van de order. Tekstuele weergave: ‘Order [ordernummer]’. Geeft aan of de order gearchiveerd is binnen het MWW beheer. 0 = niet gearchiveerd, 1 = gearchiveerd. De status van de order. De waarden staan gedefinieerd in de tabel ‘Orderstatus‘. De datum van wijzigen van de orderstatus. De tijd van wijzigen van de orderstatus. Tekstuele status van de betaling, indien beschikbaar. De tekst kan per gebruikte betaalmethode afwijken. De gebruikte betaalmethode. De waarden staan gedefinieerd in de tabel ‘Betaalmethode’. Het totaal gewicht van de order (indien gedefinieerd per artikel) in kilogrammen. Een door de klant bijgevoegde opmerking.
Pagina | 5
MWW orders feed documentatie: versie 1.0.1
Debiteur De debiteur (klant) gegevens. Pad: mwwfeed->orders->order->debtor
Het geslacht van de debiteur. De naam van de debiteur. De bedrijfsnaam van de debiteur. Het emailadres van de debiteur. Het telefoonnummer van de debiteur. Het bankrekeningnummer van de debiteur.
Adressen Het factuur- en bezorgadres van de debiteur. Indien het bezorgadres niet afwijkt van het factuuradres wordt het bezorgadres gevuld met dezelfde gegevens als het factuuradres. Pad: mwwfeed->orders->order->debtor->address
Veldnaam
Type [max veldlengte]
Omschrijving
[attribuut ‘type’] gender name company street number zipcode city country
Het type adres, waarde ‘invoice’ of ‘delivery’. Het geslacht van de klant. De naam van de klant. De bedrijfsnaam van de klant. De straatnaam van de klant. Het huisnummer van de klant. De postcode van de klant. De woonplaats van de klant. Het land van de klant.
Pagina | 6
MWW orders feed documentatie: versie 1.0.1
Orderregels Alle aanwezige orderregels. Pad: mwwfeed->orders->order->orderlines
Orderregel De inhoud van een enkele orderregel . Het type van de orderregel staat in het attribuut ‘type’. Pad: mwwfeed->orders->order->orderlines->orderline
Veldnaam
Type [max veldlengte]
Omschrijving
[attribuut ‘type’]
string [8]
description
string [255]
price [attribuut ‘tax’]
float [15,6] float [2,2]
Het type van de orderregel. De mogelijke waarden staan gedefinieerd in de tabel ‘Ordertype’. Tekstuele omschrijving van het type orderregel. Indien het type orderregel ‘article’ betreft bestaat deze uit de naam van het artikel, aangevuld met eventuele gekozen opties (maat, kleur e.d.) en/of toegepaste actieprijs. Het totaalbedrag van de orderregel, excl. BTW. Het attribuut bevat het BTW percentage. Eventuele korting en/of meerprijs is in dit bedrag wel opgenomen.
quantity weight
integer [16] float [11,3]
N.B. Orderregels van het type ‘payment’ en ‘discount’ kunnen meerdere BTW tarieven bevatten. In dat geval is per gebruikt BTW tarief een ‘price’ veld aanwezig. Het totaal aantal van dit type. Het totaal gewicht van de orderregel.
Artikelinformatie Indien de orderregel van het type ‘article’ is bevat deze een element <article>. Pad: mwwfeed->orders->order->orderlines->orderline->article
Veldnaam
Type [max veldlengte]
Omschrijving
description price [attribuut ‘tax’]
string [255] float [15,6] float [2,2]
Tekstuele omschrijving van het artikel De stuksprijs van het artikel, excl. BTW. Het attribuut bevat het BTW percentage Eventuele korting en/of meerprijs is in deze prijs niet meegenomen.
Pagina | 7
MWW orders feed documentatie: versie 1.0.1
Kortingsinformatie Indien er een korting is toegepast op de orderregel staat dit vemeld in het element . Pad: mwwfeed->orders->order->orderlines->orderline->discount
Veldnaam
Type [max veldlengte]
Omschrijving
description price [attribuut ‘tax’]
string [255] float [15,6] float [2,2]
Tekstuele omschrijving van de korting De stuksprijs van de korting, excl. BTW. Het attribuut bevat het BTW percentage. Het kortingsbedrag is een min-bedrag.
Keuzelijstinformatie Indien bij een artikel één of meerdere opties uit keuzelijsten (bijv. maat of kleur) zijn opgegeven dan staan deze vermeld in het element
