API-beskrivning Webbshopsintegration med Specter Business Management Version 2.45

Transkript

1 Sida 1/34 API-beskrivning Webbshopsintegration med Specter Business Management Version 2.45

2 Sida 2/34 Dokumentversioner Versionsnr Färdigställd Ändrad av Beskrivning Jonas Fälth Lade till nya funktioner för synkronisering av artikelinformation till externt system, getarticleinfoexternalneedupdate och updatearticleinfosfrombatch Justeringar och klargöranden vid betalningstypshantering vid skapande av ny order. Justering av resultat vid funktion checkaccountsettings Nya parametrar för koppling av leverantör vid skapande/ändring av ny artikel. Ersatt kreditor med nya företagsnamnet klarna. Skapat nytt avsnitt Viktigt att tänka på vid integration Jonas Fälth Lade till möjligheten till XML-format vid återrapportering av lager samt parametern getmultiplestocksites för att hantera återrapportering av flera lager samtidigt. Lagt till usexml=2 (xml-format) på de ställen de stöds; "getarticleinfoexternalneedupdate", "updatearticleinfosfrombatch", "getarticleexternalneedupdate", "updatearticlesfrombatch" Jonas Fälth Lade till 2 st nya betalningsidentifierare: Autogiro och Handelsbanken Finans Jonas Fälth Nya parametrar för externt ordernr vid skapande av ny order (externalorderno) Jonas Fälth Ny funktion getordersexternalneedupdate, hämta uppdatering på orderstatus/leveranser m.m. Ny trigger (actionorderchange) Nya webbshop-info fält på artikeln. Vikt & Volym tillagt på artikeln Leveransmetod vid skapande av order. Inkl SMSavisering och mobilnummer. Nya betaltyper (Payex, Moneybrookers och Fortus Finance) Ignore-fält för matchning vid skapande av ny kund Jonas Fälth Diverse småändringar Nytt betalsätt, Svea Kortbetalning (SK) Jonas Fälth Justering av datatyper på sendordermail och sendordermail to user. Småjusteringar på betaltyper (benämningar)

3 Sida 3/ Kjell Björnemyr Lagt till avståndstagande/disclaimer text Jonas Fälth Kundreferns och kundens orderreferens inlagt vid skapande av ny order Jonas Fälth Ny funktion för hantering hämtning av artikelgrupper samt nytt element vid artiklar för hämtning av fler artikelgrupper om detta finns kopplat, <multiplearticlegroups>

4 Sida 4/34 Viktigt att tänka på vid integration Här försöker vi påvisa hinder som kan uppstå vid en integration och som lätt kan undvikas för att datat skall synkroniseras snabbt och korrekt. Artikelnummer Tänk på att artikelnummer är en extern nyckel och SBM kräver att denna är unik. Viktigt att det externa systemet har krav på unikt artikelnummer. Om en artikel inte är unik tolkar SBM flera artiklar i externt system som samma artikel vilket skapar direkta fel. Mellanslag är inte tillåtet i artikelnummret. Lagersaldoinformation Vid skapande av artikel så kan information om lagersaldo tas emot av SBM. Efter detta så äger SBM rätten till lagersaldot och gör alltid en triggning i realtid om det nya lagersaldot. Denna trigger kan användas synkront eller asynkront då det inte är någon större mängd data och en process som går snabbt att uppdatera. För att inte förvilla om lagersaldon i flera system som skall möjligheten att ändra lagersaldon i externt system inaktiveras. Detta förbryllar annars slutanvändaren då man tror att lagersaldoändringen som gjorts i externt system gäller, vilket den inte gör utan skrivs över nästa gång en saldojustering görs i SBM. Artikelsynkronisering När en artikel skapas/ändras i SBM triggas en URL i externt system. Denna triggning måste jobba asynkront. Detta på grund av att en hel mängd artiklar kan ändras samtidigt och den datamängd XML som skall skickas och behandlas måste göras av bakomliggande system då användaren inte kan invänta klartecken från externt system. Förslaget är att man sätter en flagga i externt system som checkas av med jämna, täta mellanrum (ex: 1-4 minuter).

5 Sida 5/34 Allmänt Genom följande funktioner ges möjlighet att koppla samman en e-butik med Specter Business Management, nedan kallat SBM. Detta minskar mängden administration som krävs av e-handlaren. Dubbelarbetet att skapa artiklar, kunder, order etc. i flera system tas bort. Lagersaldo hålls alltid aktuellt i realtid. Tekniken HTTP-GET/POST används för att skicka in data i API. Svar lämnas via HTTP och plockas ut av klient för vidare hantering. Kontroller tillsammans med felkoder finns i API. Som säkerhet används dubbla MD5-nycklar, tillsammans med SSL-certifiering för kryptering. För att uppnå högsta möjliga säkerhet rekommenderas att även klienten använder SSL-certifikat. Teckenuppsättningen som används är ISO Förutom de API-funktioner som specificeras i detta dokument finns det andra funktioner som kan användas för olika typer av lösningar utöver denna webbshopsintegration. Kontakta oss för mer information på telefon

6 Sida 6/34 Beskrivning Genom att e-butiken kommunicerar med SBM i realtid innehåller bägge systemen alltid samma information. Om en ändring gör i det ena systemet syns det genast i det andra systemet. Nedan visualiseras det föreslagna informationsflödet. Kundens Webb-butik Kund Orderbekräftelse mailas till kund vid ny order. Utleverans inkl. ev. fraktsystem Nya artiklar Ny kund / Order E-shop gränssnitt Lagerförändring Artikelhantering - Ny artikel - Ändra artikel - Ta bort artikel SBM-API Vidare i SBM för fakturering, leverans etc. SBM En kund lägger en order i en webb-butik och informationen skickas till e-shop-gränssnittet. E-shop-gränssnittet skickar kundinformation till SBM-API. När SBM-API sedan återrapporterar att kundinformationen är OK skickas även order över. Denna dyker upp som en order i SBMs orderbild, och en orderbekräftelse mailas direkt ut till kunden. Även artikelinfo synkroniseras i realtid mellan SBM och e-shopen via SBM-API. Om en artikel skapas, ändras eller tas bort i e-handelsgränssnittet syns detta direkt i SBM, och vice versa om man väljer detta. Lagerförändring (från exempelvis saldojustering, kassan, order m.m.) rapporteras direkt tillbaka till e-butiken genom förinställd URL som körs, vilken i sin tur hämtar de justerande lagersaldona och uppdaterar dessa i e-butiken.

7 Sida 7/34 Beskrivning av funktioner i SBM-API Start / Kontroll av md5-nycklar och återrapportering Använd fil: getinfo.asp (action, sbmid och usexml skall alltid skickas in via querysträng) Namn Obligatoriskt Standardvärde Datatyp Beskrivning fält action Ja checkaccount Settings Sträng Händelse i API (md5-nyckel kontroll). Använd värdet. sbmid Ja Heltal Affärssystemets id-nummer usexml Ja 1 Bool Flagga för att ange om man vill ha resultat i textformat eller callback. actionarticlechange Nej Sträng URL att använda vid artikeluppdatering (ny/ändrad artikel) actionstockchange Nej Sträng URL att trigga vid lagersaldoförändring. actionorderchange Nej Sträng URL att trigga vid förändring på order. actionnewinvoice Nej Sträng URL att använda vid skapande av ny faktura i affärssystemet. Sträng: $invoiceid ersätts med fakturanummret. $orderid ersätts med ordernummret (om fakturan görs från order). $invoicesource ersätter var fakturan skapades av ( standard = order) actionremoveorder Nej Sträng URL vid radering av order. $orderno erätts med orderummret på ordern som tagits bort. key Ja Sträng MD5 nyckel för konfirmering av information. Nyckelberäkning key = MD5(md5key2 & MD5(md5Key1 & sbmid)) Observera &-tecken = konkaternering av strängar Nyckelberäkningen görs på rådata (före eventuell URL/HTML-enkodning). Returnerat resultat, kontroll av md5-nycklar och återrapportering Resultatet returneras i text i http-gränssnittet, i detta fall noll (0) eller ett (1). JA/NEJ/E-post Meddelande 0 Felaktig md5-nyckel 1 Korrekt md5-nyckel och ev. action är sparade.

8 Sida 8/34 Ny/Ändra artikel Använd fil: putinfo.asp (action, sbmid och usexml skall alltid skickas in via querysträng) Namn Obligatoris Standard Datatyp Beskrivning kt fält värde Action Ja newarticlesu bmit Sträng Händelse i API (ny artikel). Använd värdet. sbmid Ja Heltal Affärssystemets id-nummer usexml Ja 1 Bool Flagga för att ange om man vill ha resultat i textformat eller en redirectreturnering. forcearticleupdate Nej 0 Bool(0/1) Flagga om artikeln skall uppdateras om den redan finns. articleno_x Ja Sträng (25) Artikelnummret (mellanslag ej tillåtet) oldarticleno_x Nej Sträng Gammalt artikelnummer (25) name_x Ja Sträng Namn på artikel articlecomment_x Nej Sträng Artikelkommentar barcode_x Nej Sträng Streckkod productweight_x Nej 0 Dec. tal Artikelns vikt i kg productvolume_x Nej 0 Dec. tal Artikelns volym i m 3 buyprice_x Nej Dec.tal Inköpspris vatpercent_x Nej Heltal Artikelns momssats i % (ex: 25) priceexclvat_x Ja Dec.tal Artikelpris exklusive moms. stockprice_x Nej Dec.tal Lagervärdering exklusive moms createarticlestock_x Nej 0 Bool Flagga om lagersaldo skall läggas in direkt på artikeln. noitemsinstock_x Nej Dec.tal Antal i lager (huvudlager). addsupplier Nej 0 Bool(0/1) Om leverantör skall läggas till på artiklarna (observera, skickas ej per rad) supplierno_x Nej Sträng Leverantörens id/nr i externt system (används som extern nyckel mellan systemen) suppliername_x Nej Sträng Leverantörens namn supplierarticleno_x Nej Sträng Leverantörens artikelnummer på aktuell artikel supplierbuyprice_x Nej Dec. tal Leverantörens pris exkl. moms på aktuell artikel inshop_x Nej 0 Bool(0/1) Webbshopinfo Visa artikel i webbshop (Inställning visning GUI*) articleisnew_x Nej 0 Bool(0/1) Webbshopinfo Artikeln är ny (Inställning visning GUI*) campaignarticle_x Nej 0 Bool(0/1) Webbshopinfo Kampanjartikel (Inställning visning GUI*) hidebuybtn_x Nej 0 Bool(0/1) Webbshopinfo Dölj köpknapp

9 Sida 9/34 (Inställning visning GUI*) hideprice_x Nej 0 Bool(0/1) Webbshopinfo Dölj försäljningspris (Inställning visning GUI*) shortarticleinfo_x Nej text Webbshopinfo Kort artikelinformation (Inställning visning GUI*) articleinfo_x Nej text Webbshopinfo Lång artikelinformation (Inställning visning GUI*) standardoldprice_x Nej Dec. tal Webbshopinfo Ordinarie pris (Inställning visning GUI*) showstandardoldprice _x Nej 0 Bool(0/1) Webbshopinfo Visa ordinarie pris i webshop (Inställning visning GUI*) extraurl_x Nej Sträng Webbshopinfo Extra url (Inställning visning GUI*) extraurltext_x Nej Sträng Webbshopinfo Extra url länktext (Inställning visning GUI*) metatitle_x Nej Sträng Webbshopinfo Meta-titel (Inställning visning GUI*) metakeywords_x Nej Sträng Webbshopinfo Meta-keywords (Inställning visning GUI*) metadescription_x Nej Sträng Webbshopinfo Meta-Description (Inställning visning GUI*) Key Ja Sträng MD5 nyckel för konfirmering av information. - Namnsuffixet _x (_ och radnummer) kan uteslutas om man enbart skickar med en artikel. */ För att fältet skall visas i GUI måste ansvarig för API-koppling inkomma med info kring vilka fält av markerade som synkroniseras och därmed bör visas i GUI. Nyckelberäkning key = MD5(md5Key2 & MD5(md5Key1 & sbmid & articleno_1)) Observera &-tecken = konkaternering av strängar Nyckelberäkningen görs på rådata (före eventuell URL/HTML-enkodning). Returnerat resultat, ny / ändra artikel Resultatet returneras i form av semikolonseparerad text i http-gränssnittet. Exempel: 0;1;Kan ej hitta servern Resultat Felkod / Artikel nr Felmeddelande 0 1 Kan ej hitta servern 0 2 Sidan kan ej hittas 0 3 Felaktig nyckel (md5) 0 5 Felaktig indata (beskrv.) 1 artikelid Funktionen utfördes korrekt 3 artikelid Artikelnummer fanns redan

10 Sida 10/34 Inaktivering av artikel Använd fil: putinfo.asp (action, sbmid och usexml skall alltid skickas in via querysträng) Namn Obligatoriskt Standard Datatyp Beskrivning fält värde action Ja removearticle Submit Sträng Händelse i API (ny artikel). Använd värdet. sbmid Ja Heltal Affärssystemets id-nummer usexml Ja 1 Bool Flagga för att ange om man vill ha resultat i textformat eller en redirectreturnering. articleno_x Ja Sträng Artikelnummret på artikeln som ska inaktiveras. Key Ja Sträng MD5 nyckel för konfirmering av information. - Namnsuffixet _x (_ och radnummer) kan uteslutas om man enbart skickar med en artikel. Nyckelberäkning key = MD5(md5Key2 & MD5(md5Key1 & sbmid & articleno_1)) Observera &-tecken = konkaternering av strängar Nyckelberäkningen görs på rådata (före eventuell URL/HTML-enkodning) Returnerat resultat, ny / ändra artikel Resultatet returneras i form av semikolonseparerad text i http-gränssnittet. Exempel: 0;1;Kan ej hitta servern Resultat Felkod Felmeddelande 0 1 Kan ej hitta servern 0 2 Sidan kan ej hittas 0 3 Felaktig md5-nyckel 0 5 Felaktig indata 0 6 Artikeln är en huvudvariant och kan därför ej tas bort 0 x Annat / Övrigt fel 1 x Funktionen utfördes korrekt

11 Sida 11/34 Skapa/ändra kund Använd fil: putinfo.asp (action, sbmid och usexml skall alltid skickas in via querysträng) Datafält Obligatoriskt Standardvärde Datatyp Beskrivning Fält Action Ja newcusto mersubmit VARCHAR Händelse i API (ny kund). Använd värdet. sbmid Ja Heltal Affärssystemets idnummer usexml Ja 1 Bool Flagga för att ange om man vill ha resultat i textformat eller en redirect-returnering. forcecustomerupdate Nej 0 Bool Flagga om man vill uppdatera kundinfo ifall kunden hittades. customerorganizational Form Nej C Sträng(1) Organisationsform, C=Företag, P=Privatperson (Om privatperson, använd firstname och surname istället samt räkna nyckeln på dessa) name Ja (om företag) Sträng (100) Kundnamn firstname surname Ja (om Privatperson) Ja (om Privatperson) Sträng(50) Sträng(50) Förnamn (om organisationsform = privatperson) Efternamn (om organisationsform = privatperson) typecustomer Nej C (kund) Sträng (1) Kundtyp: C = Kund P = Prospect currency Nej SEK Sträng Standardvaluta på kund (valutan måste finnas i affärssystemet) language Nej SV Sträng Standardspråk på dokumenten (språket måste finnas i affärssystemet) customergroupid Nej Standardgr upp Heltal Kundgruppens idnummer campaigncode Nej Sträng Kampanjkod (för att koppla kunden till rätt källa) contactperson Nej Sträng Kontaktperson orgno Nej (del av extern nyckel om värde finns) Sträng (20) Kundens organisationsnummer / personnummer vatno Nej Sträng (30) Kundens momsnummer invoicecompanyname Nej (kundnamn Sträng (100) Faktureringsadress: et) namnfält attention Nej Sträng (100) Faktureringsaddress: Att. address Nej Sträng (100) Faktureringsaddress: Adressrad 1

12 Sida 12/34 addressrow2 Nej Sträng (100) Faktureringsaddress: Adressrad 2 addressrow3 Nej Sträng (100) Faktureringsaddress: Adressrad 3 zipcodeeng Nej Sträng (10) Faktureringsaddress: Postnummer city Nej Sträng (50) Faktureringsaddress: Stad countrycode Nej Hemlandet Sträng(2) Faktureringsaddress: Land, ISO-2 standard (Ex. Sverige = SE) deliverycompanyname Nej Sträng (100) Leveransadress: namnfält deliveryattention Nej Sträng (100) Leveransadress: Leveransattention deliveryaddress Nej Sträng (100) Leveransadress: Leveransadressrad 1 deliveryaddressrow2 Nej Sträng (100) Leveransadress: Leveransadressrad 2 deliveryaddressrow3 Nej Sträng (100) Leveransadress: Leveransadressrad 3 deliveryzipcodeeng Nej Sträng (10) Leveransadress: Postnummer deliverycity Nej Sträng (50) Leveransadress: Leveransstad deliverycountrycode Nej Hemlandet Sträng(2) Leveransadress: Land, ISO-2 standard (Ex. Sverige = SE) address Ja (del av Sträng (100) E-postadress extern nyckel) phoneno Nej Sträng (50) Telefonnummer faxno Nej Sträng (50) Faxnummer mobileno Nej Sträng (50) Mobilnummer Homepage Nej Sträng (100) Hemsideadress ignorecontrolorgno Nej 0 Bool(0/1) Flagga om organisationsnummerkontrollen skall ignoreras vid match av kund ignorecontrol Nej 0 Bool(0/1) Flagga om e- postkontrollen skall ignoreras vid match av kund Key Ja Sträng MD5 nyckel för konfirmering av rätt information. Nyckelberäkning key = MD5(md5Key2 & MD5(md5Key1 & sbmid & name)) eller (beroende om kundtyp är privatperson eller företag) key = MD5(md5Key2 & MD5(md5Key1 & sbmid & firstname & & surname)) Observera &-tecken = konkaternering av strängar Nyckelberäkningen görs på rådata (före eventuell URL/HTML-enkodning)

13 Sida 13/34 Returnerat resultat, skapa ny kund Resultatet returneras i form av semikolonseparerad text i http-gränssnittet. Exempel: 0;1;Kan ej hitta servern JA/NEJ/E-post Felkod/Kund nr Felmeddelande 0 1 Kan ej hitta servern 0 2 Sidan kan ej hittas 0 3 Fel nyckel (md5) 0 5 Felaktig indata (variabler) 0 x Annat / övrigt fel 1 kundnr Inga fel påträffades 2 kundnr E-postadressen fanns redan, kundnummer där det hittades bifogas 3 kundnr Organisationsnummret fanns redan, bifogas

14 Sida 14/34 Skapa ny order Använd fil: putinfo.asp (action, sbmid och usexml skall alltid skickas in via querysträng) Datafält Obligatoriskt Standard Datatyp Beskrivning fält -värde action Ja neworder Submit Sträng Händelse i API (ny order). Använd standardvärdet. sbmid Ja Heltal Affärssystemets id-nummer usexml Ja 1 Bool (0/1) Flagga för att ange om man vill ha resultat i textformat eller callback. customerid Ja Heltal Kundens id-nummer externalorderno Nej Sträng(30) Externt ordernr. OBS! Detta nr är unikt och kan ej skickas in 2ggr som std. ignoreexternalorderno Control Nej Bool(0/1) Sätts om externa ordernummerkontrollen inte skall gälla (se ovan). date Nej Dagens datum deliverydate Nej Orderdatu m + std. Inställning antal dagar till leverans Datum (ÅÅÅÅ-MM- DD) Datum (ÅÅÅÅ-MM- DD) Orderdatum (ÅÅÅÅ-MM-DD) Leveransdatum (ÅÅÅÅ-MM- DD) customerreference Nej Sträng(70) Om fältet inte skickas med tas kontaktpersonfältet på kopplad kund. customerorderreferen Nej Sträng(50) ce paytypeidentifier Nej Faktura Sträng(2) Betalningstypsidentifierare (för lista se nedan) paytypereference Nej Sträng(60) Betalningsnummer vid extern betalningstyp (ex. Klarnas reservationsnr eller DIBS transaktionsnummer) externaldeliverymethod Nej Sträng(100) Leveransmetod. Kopplas mot extern nyckel på leveranssätt i SBM (ställs in under inställningar->leveranssätt) notifydeliverybymobile Nej Bool(0/1) Om leverans-avi skall skickas via SMS (kräver inställning i SBM) notifydeliverymobileno Nej Sträng Mobilnr för SMS vid användning av leverans-avi. Currency Nej Kundens förvalda Sträng Använd valuta (valutan måste finnas i affärsystemet). Language Nej Kundens förvalda Sträng Dokumentspråk (språket måste finnas i affärsystemet). pclass Nej Heltal Klarna dela upp betalning, pclass (Avbetalningsmall) ysalary Nej Heltal Klarna dela upp betalning, ysalary (Årsinkomst) publishedcomment Nej Sträng Publiserad kommentar på order (visas på orderbekr.)

15 Sida 15/34 internalcomment Nej Sträng Intern kommentar på ordern (visas enbart i affärsystemet, ej för kund) articleno_x Ja Sträng (25) Orderradens artikelnummer som ska in på orderrad X. articlename_x Ja Sträng (130) Orderradens benämning som ska in på orderrad X. articlecomment_x Nej Sträng (200) Orderradens artikelkommentar som ska in på orderrad X. priceexclvat_x Ja Dec. tal Pris exklusive moms som skall in på orderrad X. noofitems_x Ja Heltal Antal beställda artiklar i orderrad X. vatpercent_x Ja Heltal Moms % ska ska in på orderrad X. discount_x Nej Dec. Tal Rabatt % som ska in på orderrad X. sendordermail Nej 0 Bool(0/1) Flagga om e-post med ordern skall skickas till slutkunden. sendordermailtouser Nej 0 Bool(0/1) Flagga om ordermail skall skickas till administratören av webbshoppen. usermail1 Nej Sträng Administratörens e-postadress key Ja Sträng MD5 nyckel för konfirmering av information. - Datafält med X kan upprepas flera gånger, ex noofitems_1, noofitems_2 osv. Nyckelberäkning key = MD5(md5Key2 & MD5(md5Key1 & sbmid & customerid)) Observera &-tecken = konkaternering av strängar Nyckelberäkningen görs på rådata (före eventuell URL/HTML-enkodning) Returnerat resultat, skapa order Resultatet returneras i form av semikolonseparerad text i http-gränssnittet. Exempel: 0;1;Kan ej hitta servern JA/NEJ/E-post Felkod/OrderNr Felmeddelande 0 1 Kan ej hitta servern 0 2 Sidan kan ej hittas 0 3 Fel nyckel (md5) 0 4 Kund kunde ej hittas 0 5 Felaktig indata (variabler) 0 x Annat / övrigt fel 1 ordernr Inga fel påträffades 2 ordernr Order skapades, men ingen e-postadress hittades Lista på betalningsidentifierare Betalningstypen måste finnas i systemet annars blir betalningen en standardbetalning Identifierare Namn på betalninghanterare K Faktura genom Klarna - Fakturera mig (OBS! Reservationsnummer skall skickas in, ej passivt fakturanummer) I Fakturabetalning (standard) D Kontantbetalning

16 Sida 16/34 PP P PN CB DP DD SD S PE PY CN SP SS SK PL AE AG HF FI PC PD PI MB Förskottsbetalning Postförskottsbetalning Paynova ClickandBuy DIBS DIBS/Debitech SAMPORT Direktbetalning SAMPORT Payer Payson Certitradenet Svea web faktura Svea delbetalning Svea kortbetalning Paypal Auriga epayment Autogiro Handelsbanken Finans Fortus Finance faktura Payex kort Payex direktbetalning Payex faktura Moneybrokers

17 Sida 17/34 Hämta nya/uppdaterade artiklar (starta batchjobb) Använd fil: getinfo.asp (action, sbmid och usexml skall alltid skickas in via querysträng) Datafält Obligatoriskt Standard-värde Datatyp Beskrivning fält Action Ja getarticleinfoextern alneedupdate Sträng Händelse i API (hämta lagersaldo). Använd standardvärdet. sbmid Ja Heltal Affärssystemets id-nummer usexml Ja 2 Heltal Flagga för att ange i vilket dataformat svaret skall skickas. 2=XML-format (enda formatet som stöds i denna funktion) batchno Ja Sträng Batchnummer som används för hämtning (autogenereras hos klienten och skickas vid förfrågan) Key Ja Sträng MD5 nyckel för konfirmering av information. Nyckelberäkning key = MD5(md5Key2 & MD5(md5Key1 & sbmid & batchno)) Observera &-tecken = konkaternering av strängar Nyckelberäkningen görs på rådata (före eventuell URL/HTML-enkodning) Returnerat resultat nya/uppdaterade artiklar Resultatet returneras i XML-format Exempel retur: <?xml version="1.0" encoding="iso "?> <sbmdatainfo> <articles> <article articleid='1' parentarticleid='0' articletype='gw' viewchildarticles='0' grouppositionno='0' havecommision='0' articleflag1='0' articleflag2='0' saleaccount='3041' itemunitid='1' itemunitshortening='st' barcode='' serialnumber='0' productweight= 10.2 productvolume= 1.03 buyprice='1000' vatid='1' vatpercent='25' priceexclvat='2000' stockprice='0' costaccount='4010' orderpoint='0' packagingsize='0' nopackagestoorder='0' orderitem='0' noitemsonorder='0' nextdeliverydateonorder='' isdeleted='0'> <articlegroup rowno='1' id='53'><![cdata[standard]]></articlegroup> <articleno><![cdata[000001]]></articleno> <name><![cdata[lagerfönster 1]]></name> <articlecomment><![cdata[]]></articlecomment> <suppliers> <supplier> <rowno>1</rowno> <suppliername><![cdata[leverantör1]]></suppliername> <externalsupplierno>2712</externalsupplierno> <useassuggestion>1</useassuggestion> <supplierid>1</supplierid> <supplierarticleno><![cdata[32abc44]]></supplierarticleno> <priceexclvat>452</priceexclvat> <pricecurrencyshortening>sek</pricecurrencyshortening> <grossornet>n</grossornet> </supplier> </suppliers> <variantarticletype>n</variantarticletype>

18 Sida 18/34 <variants></variants> <havediscountinterval>1</havediscountinterval> <priceintervaldiscounts> <priceinterval> <frominterval>1</frominterval> <tointerval>10</tointerval> <percentdiscount>0</percentdiscount> </priceinterval> <priceinterval> <frominterval>11</frominterval> <tointerval>20</tointerval> <percentdiscount>10</percentdiscount> </priceinterval> <priceinterval> <frominterval>21</frominterval> <tointerval> </tointerval> <percentdiscount>20</percentdiscount> </priceinterval> </priceintervaldiscounts> </article> </articles> <batchno>3232</batchno> </sbmdatainfo> Förklaring av XML-data Datat är uppdelat i flera nivåer. I artikelnivån återfinns det generella artikeldatat såsom artikelnummer, namn, priser, bokföringskonton etc. I underliggande nivåer presenteras mer ingående information såsom leverantörskopplingar, varianthantering, prisintervall m.m. Nedan finner ni en lista över de värden som kan förekomma i XML-filen och en förklaring över dessa. Variabel Förklaring articleid SBM artikelid parentarticleid Föräldraartikel id articletype Artikeltyp - GN = Vara icke lagerförd - GW = Vara lagerförd - PA = Paketartikel - SN = Tjänst/ej planerbar - SP = Tjänst/planerbar viewchildarticles Visa underartiklar (om paketartikel) havecommision Artikel är provisionsgrundande (0/1) articleflag1 Artikelflagga 1 satt (konfigureras per system) (0/1) articleflag2 Artikelflagga 2 satt (konfigureras per system) (0/1) saleaccount Försäljningskonto (bokföringskonto) itemunitid SBM standardenhets id itemunitshortening SBM standardenhetsförkortning barcode Streckkod serialnumber Använder serienummer (0/1) productweight Artikelns vikt i kg productvolume Arikeln volym i m 3 buyprice Inköpspris vatid SBM moms id vatpercent Momsprocent, anges i heltal priceexclvat Artikelpris exkl moms stockprice Lagervärde costaccount Kostnadskonto (bokföringskonto) orderpoint Beställningspunkt (vid inköp) packagingsize Förpackningsstorlek (vid inköp) nopackagestoorder Antal att beställa (vid inköp) orderitem

19 Sida 19/34 noitemsonorder Antal artiklar i order, ej inlevererade nextdeliverydateonorder Nästa beräknade inleverans på artikel isdeleted Artikel inaktiverad (0/1) variantarticletype Variantartikeltyp N = Varianter används ej på denna artikel M = Huvudartikel (Ex: Sko) S = Underartikel (Ex: Sko storlek 38) articlegroup Kopplad artikelgrupp radnummer, idnummer och namn (finns även under multiplearticlegroups) articleno Artikelnummer name Artikelnamn articlecomment Artikelkommentar Multipla artikelgrupper multiplearticlegroups articlegroup Namn på artikelgruppen - rowno Radnummer (löpande) - id Artikelgruppens interna id-nummer i SBM Webbshop-information webshopinfo viewinshop Visa artikeln i shop articleisnew Artikeln är ny campaignarticle Kampanjartikel hidebuybtn Dölj köpknapp hideprice Dölj pris showstandardoldprice Visa standard/ordinarie pris standardoldprice Standard/ordinarie pris extraurltext Extra url-text shortarticleinfo Kort artikelinformation metatitle Metadata titel metakeyword Metadata nyckelord metadescription Metadata beskrivning Information på andra språk languagearticleinfo language Eventuella leverantörer kopplade till artikeln. - languageid SBM språk id - languageshortening1 Språkförkortning enligt ISO639-1 (2 tecken) - languageshortening2 Språkförkortning enligt ISO639-2 (3 tecken) - name Artikelns namn - comment Artikelkommentar - shortarticleinfo Webshopsinfo kort artikelinformation - articleinfo Webshopsinfo artikelinformation - metatitle Webshopsinfo metadata titel - metakeywords Webshopsinfo metadata nyckelord - metadescripton Webshopsinfo metadata beskrivning Priser i andra valutor currencyarticleprice currency Eventuella leverantörer kopplade till artikeln. - currencyid SBM valuta id - currencyshortening Valutaförkortning (3 tecken) - priceexclvat Pris i valuta exklusive moms Leverantörer suppliers supplier Eventuella leverantörer kopplade till artikeln. - rowno Radnummer - suppliername Leverantörens namn

20 Sida 20/34 - externalsupplierno Externt leverantörsnummer - useassuggestion Föreslagen leverantör vid inköpsförslag (en per artikel) - supplierid SBM leverantörs id - supplierarticleno Leverantörens artikelnummer - priceexclvat Inköpspris exkl moms - pricecurrencyshortening Valuta på inköpspris - grossornet Inköpspris brutto/netto Prisintervall priceintervaldiscounts priceinterval Eventuell rabatt-prisstaffling på artikeln (rabatt vid köp av fler än 1) - frominterval Frånintervall - tointerval Till i intervall - percentdiscount Rabatt i procent Om huvudartikel vid varianthantering Variants Variant Innehåller variantinformation om huvudartikel. - variantpostion Position i listning om flera varianttyper - variantname Variantnamn (ex: Färg) values > value variantrowid SBM internt variantrowid (kan användas för att matcha) positionno Position i listning name Namn på variantvärdet (ex: Svart) Om underartikel vid varianthantering Variants parentarticleid Huvudartikelns id-nummer (Interna nr) parentarticleno Huvudartikelns artikelnummer Value Innehåller värde på varianter. - variantname Variantens namn - variantrowid SBM internt variantrowid (kan användas för att matcha) - positionno Positionsnummer i listning - name Namn på värdet (ex: Svart)

21 Sida 21/34 Slutför batch av uppdatering av artiklar Använd fil: getinfo.asp (action, sbmid och usexml skall alltid skickas in via querysträng) Datafält Obligatoriskt Standard-värde Datatyp Beskrivning Fält Action Ja updatearticleinfos FromBatch Sträng Händelse i API (hämta artikelinfo). Använd standardvärdet. sbmid Ja Heltal Affärssystemets id-nummer usexml Ja 1 Heltal Flagga för att ange i vilket dataformat svaret skall skickas. 1=Semikolonseparerat 2=XML-format batchno Ja Sträng Batchnummer som används för hämtning. Samma som skickades in vid hämtning. Key Ja Sträng MD5 nyckel för konfirmering av information. Nyckelberäkning key = MD5(md5Key2 & MD5(md5Key1 & sbmid & batchno)) Observera &-tecken = konkaternering av strängar Nyckelberäkningen görs på rådata (före eventuell URL/HTML-enkodning) Returnerat resultat nya/uppdaterade artiklar Resultatet returneras i form av semikolonseparerad text i http-gränssnittet alternativt XML-format (usexml) Exempel semikolonformat (usexml=1) 1;0;Inga fel påträffades Exempel XML-format (usexml=2) <?xml version="1.0" encoding="iso "?> <sbmdatainfo> <APIresponse> <result>1</result> <code>0</code> <message>inga fel påträffades</message> </APIresponse> </sbmdatainfo> JA/NEJ/E-post Felkod/OrderNr Felmeddelande 0 1 Kan ej hitta servern 0 2 Sidan kan ej hittas 0 3 Fel nyckel (md5) 1 1 Inga fel påträffades

22 Sida 22/34 Hämta artikelgrupper Använd fil: getinfo.asp (action, sbmid och usexml skall alltid skickas in via querysträng) Datafält Obligatoriskt Standardvärde Datatyp Beskrivning Fält Action Ja getarticleg roups Sträng Händelse i API (hämta artikelgrupper). Använd standardvärdet. sbmid Ja Heltal Affärssystemets id-nummer usexml Ja 2 Heltal Flagga för att ange i vilket dataformat svaret skall skickas. 1=Semikolonseparerat 2=XML-format. Enbart usexml=2 stödjs i denna funktion. Key Ja Sträng MD5 nyckel för konfirmering av information. Nyckelberäkning key = MD5(md5Key2 & MD5(md5Key1 & sbmid & action)) Observera &-tecken = konkaternering av strängar Nyckelberäkningen görs på rådata (före eventuell URL/HTML-enkodning) Returnerat resultat artiklar med nytt lagersaldo Resultatet returneras i form av semikolonseparerad text i http-gränssnittet. ArtikelId;ArtikelNo;Antal i lager;batch nr Exempel retur vid usexml=2 (krav) <?xml version="1.0" encoding="iso "?> <sbmdatainfo> <APIresponse> <result>1</result> <code>0</code> <message>inga fel påträffades</message> </APIresponse> <articlegrups> <articlegroup articlegroupid='53' parentid='0' isstandard='1'> <name>standard</name> </articlegroup> <articlegroup articlegroupid='54' parentid='0' isstandard='0'> <name>artikelgrupp2</name> </articlegroup> </articlegrups> </sbmdatainfo> Förklaring av XML-data Datat är uppdelat per lagerställe. Varje lagerställe innehåller de artiklar som behöver uppdateras med nya lagersaldon. Variabel articlegroup articlegroupid Förklaring Artikelgrupp Artikelgruppens Id-nummer