Isolda Webservice Specifikation v 3.00

Transkript

1 Isolda Webservice Specifikation v 3.00

2 Innehållsförteckning INNEHÅLLSFÖRTECKNING... 2 FIGURFÖRTECKNING INTRODUKTION VAD ÄR EN WEBSERVICE? BEGREPPSFÖRVIRRING?! Webservice (Tjänsten) HTTP (Kommunikationssättet) XML (Språket/Formatet) STRUKTURER Kategorisöket Klassificeringssöket Tillverkarsöket URL WEBSERVICEN DEMO VERSION DOKUMENTATION FUNKTION EXEMPEL PÅ ANVÄNDNINGSOMRÅDE FLÖDEN Orderläggning FÖRDEFINIERADE FRÅGOR OCH SVAR Språk get_languagelist Tillverkare get_manufacturerlist get_manufacturerlist_filteredbycustomitemno Huvudklasser get_mainclasslist get_mainclasslist_bymanufacturer Artikelklasser get_itemclasslist_bymainclass get_itemclasslist_bymainclassandmanufacturer Produktgrupper get_prodgrplist_bymanufacturer get_prodgrplist_bymanufacturer_filteredbycustomitemno ProduktgruppsProdukter get_productgrpproductlist_filteredbycustomitemno Produkter get_productlist_bymanufacturerandprodgrp get_productlist_bymanufacturerandprodgrp_filteredbycustomitemno Artiklar get_itemlist_bymainclassanditemclass get_itemlist_bymainclassanditemclass_filteredbycustomitemno get_itemlist_bymanufactureranditemclass get_itemlist_bymanufactureranditemclass_filteredbycustomitemno get_itemlist_bymanufacturerandprodgrpandproduct get_itemlist_bymanufacturerandprodgrpandproduct_filteredbycustomitemno get_itemlist_byparentsectionid get_itemlist_byparentsectionid_filteredbycustomitemno Artikelinformation get_iteminfo_byisoldaitemno get_iteminfo_bycustomitemno get_iteminfo_byean get_iteminfo_byoem get_iteminfo_bycartridgeno

3 Artikelbilder get_imagearchive_defaultsize_bycartridgeno get_imagearchive_defaultsize_bycustomitemno get_imagearchive_defaultsize_byean get_imagearchive_defaultsize_byisoldaitemno get_imagearchive_defaultsize_byoem Lagersaldo get_stockinfo_byisoldaitemno get_stockinfo_bycustomitemno get_stockinfo_byean get_stockinfo_byoem Isoldas inköpsorder get_onpurchaseorder_byisoldaitemno get_onpurchaseorder_bycustomitemno get_onpurchaseorder_byean get_onpurchaseorder_byoem Priser get_priceinfo_byisoldaitemno get_priceinfo_bycustomitemno get_priceinfo_byean get_priceinfo_byoem Leveransinformation get_shipmentinfo_byisoldashipmentno get_shipmentinfo_byisoldaorderno get_shipmentinfo_bycustomref Länder get_countrylist Kategorier get_sectionlist_topparentsections get_sectionlist_topparentsections_filteredbycustomitemno get_sectionlist_byparentsectionid get_sectionlist_byparentsectionid_filteredbycustomitemno Orderläggning send_sendorder * Orderhead * Orderlines Postnummer check_shippingpostcode * Orderhead * Orderlines STATUSKODER SÄKERHET OCH MISSBRUK AV TJÄNSTEN DATUMKODER TECKENKONVERTERING SUPPORT DOKUMENTATION UPPDATERINGAR DRIFTAVBROTT FELRAPPORTERING F.A.Q VERSIONER v v v v v V V V V

4 Figurförteckning FIGUR 1: HUR FRÅGOR STÄLLS VIA TELEFON... 6 FIGUR 2: HUR FRÅGOR STÄLLS VIA WEBSERVICE... 6 FIGUR 3: ÖVERBLICK AV ISOLDAS WEBSERVICE FIGUR 4: EXEMPEL PÅ HUR ISOLDAS WEBSERVICE KAN ANVÄNDAS FIGUR 5: ORDERFLÖDE VIA WEBSERVICE

5 1 Introduktion Denna specifikation är framtagen av Isolda AB som ett stöd till dig som vill börja nyttja Isoldas webservice. Specifikationen skall ses som ett komplement till den befintliga dokumentation som webservicen i sig utgör. 5

6 1.1 Vad är en Webservice? Isoldas webservice kan på ett enkelt sätt liknas vid ett telefonsamtal. Återförsäljaren ringer Isoldas kundtjänst för att få en specifik fråga besvarad. I det här fallet vill återförsäljaren veta hur stor kvantitet, av artikeln med artikelnummer 51645A, Isolda har i lager. Frågan är enkel för kundtjänst att svara på: Isolda har för närvarande 4123 st på lager Figur 1: Hur frågor ställs via telefon På samma sätt kan återförsäljaren, via sitt IT-system, nyttja Isoldas webservice för att få svar på frågan. Isoldas webservice använder sig av samma information som kundtjänst har tillgång till, och svaret blir därför detsamma. Isolda har för närvarande 4123 st på lager Figur 2: Hur frågor ställs via webservice Den största skillnaden mellan att ställa frågan via telefon och webservice är att webservicen bara kan svara på en uppsättning fördefinierad frågor. (3.3 Fördefinierade frågor och svar) 6

7 1.2 Begreppsförvirring?! Webservice (Tjänsten) Isoldas webservice, eller webbtjänst, är som namnet skvallrar om, en tjänst på internet. Tjänsten webservice baseras på fördefinierade frågor och svar, där användaren (kunden) står för frågorna och webservicen för svaren HTTP (Kommunikationssättet) Hyper Text Transfer Protocol är ett kommunikationsprotokoll som används för att överföra data över informationsnätverket WWW. Dvs, det man i dagligt tal kallar för Internet. Isoldas webservice använder sig utav HTTP-protokollet för att skicka och ta emot data. Kundens system som han/hon önskar koppla ihop med Isoldas webservice måste därför ha stöd för kommunikation via HTTP XML (Språket/Formatet) Isoldas webservice kommunicerar XML. XML är ett s.k. märkspråk och fungerar så att man märker upp all data som skall skickas med fördefinierade namn. Principen bygger på att både den frågande parten och den svarande parten har en gemensam uppfattning om vad märkningen betyder. 1.3 Strukturer Kategorisöket Kategorisöket är framtaget för att du som användare skall kunna leta efter artiklar där du vill hitta dom. Kategorisöket är ett sökträd med kategorisering av artiklar i tre nivåer. Artiklar kan här exister under en eller flera olika kategorier. Struktur: Exempel: Kategori Kategori o Kategori Kategori Artikel Artikel Artikel Artikel o Kategori Artikel Artikel o Kategori o Artikel o Artikel Kategori Audio & video Backup & Lagring o AIT AIT 1 Q1997A HP SDX1-35C SAIT2-800N SONY SAIT1-500 SONY o CD/DVD/Blue Ray VERBATIM VERBATIM o DC Tape o IMATION Super DLT o MAXELL DVD+R Batterier & laddare 7

8 1.3.2 Klassificeringssöket Isolda grupperar hela sitt artikelregister med hjälp av ett internt klassificeringssystem. En artikel kan bara tillhöra en artikelklass. (Se struktur och exempel nedan) Struktur: Exempel: Huvudklass Huvudklass o Artikelklass Artikel Artikel Artikel o Artikelklass o Artikelklass o Artikelklass Huvudklass Backup & Lagring Nätverksprodukter o Brännare EK o PCI Card o Routers o Switches Reservdelar Tillverkarsöket Isolda använder sig också av ett s.k Tillverkarsök. Detta struktur används i första hand för att hitta förbrukning till sin maskin. Men kan också användas för att se en viss tillverkares sortiment. (Se struktur och exempel nedan) 8

9 Struktur: Exempel: Tillverkare o Produktgrupp o Produktgrupp Produkt Produkt Artikel Artikel Artikel Artikel Produkt Produkt o Produktgrupp Tillverkare Tillverkare CANON o Bläckstråleskrivare o Laserskrivare CLBP 460 series Laser Shot LBP A A A A003 LBP 430w LBP 460 o Matrisskrivare HP ISOTECH För att se detta sökträd in action, besök alt.

10 2 URL 2.1 Webservicen Isoldas webservice hittar du på adressen: Demo version Isolda demo version av en webbshop utvecklad utifrån webservicen Dokumentation Senaste version av det här dokumentet hittar du på: 10

11 3 Funktion Isoldas webservice erbjuder en mängd olika funktioner för att hämta information ur Isoldas informationsdatabas. Du kan t.ex. hämta ut både pris och lagersaldo på enskilda artiklar i realtid. Trädstruktur: Klassificering Huvudklass / Artikelklass / Artikel Orderläggning Artikelbilder $ Artikelpris Utförlig artikelinformation Isoldas WebService Trädstruktur: Kategorisering Kategori / Artikel Trädstruktur: Förbrukning Tillverkare / Produktgrupp / Produkt / Artikel Leveransinformation Lagersaldo På Isoldas inköpsorder Figur 3: Överblick av Isoldas webservice 11

12 3.1 Exempel på användningsområde Figur 4: Exempel på hur Isoldas webservice kan användas 12

13 3.2 Flöden Orderläggning Genom Isoldas webservice har våra kunder möjlighet att lägga skarpa orders direkt in till Isolda. Se figuren nedan för att bättre förstå orderflödet via webservice. Figur 5: Orderflöde via Webservice 13

14 3.3 Fördefinierade frågor och svar Fälten nedan finns med i samtliga frågor/svar. Username String 20 demo Password String 20 demopass StatusID Int - 10 StatusMessage String - O.K ImputString* String - PA327015, SE Results* Int - 4 Generated Datetime :51 * ingår inte i funktionen för orderläggning Språk get_languagelist Vilka språk kan Isolda erbjuda översättningar på? Lista på: Språkkoder och språkbeskrivningar LanguageCode String 10 SE LanguageDescription String 50 Svenska" Tillverkare get_manufacturerlist Vilka tillverkare tillhandahåller Isolda? Lista på: Tillverkare ManufacturerCode String ISOTECH 14

15 get_manufacturerlist_filteredbycustomitemno Vilka tillverkare tillhandahåller Isolda vars artiklar innehåller mitt eget artikelnummer? Lista på: Tillverkare ManufacturerCode String ISOTECH Huvudklasser get_mainclasslist Vilka huvudklasser använder Isolda sig av för att kategorisera sitt artikelregister? Språkkod Lista på: Huvudklasskoder och Huvudklassbeskrivningar LanguageCode String 10 SE MainClassCode String 30 PAPPER & MainClassDescription String 30 Papper & utskr get_mainclasslist_bymanufacturer Vilka huvudklasser hittar jag filtrerat på en specifik tillverkare? Tillverkare av artikeln Språkkod Lista på: Huvudklasskoder och Huvudklassbeskrivningar ManufacturerCode String 20 ISOTECH LanguageCode String 10 SE 15

16 MainClassCode String 30 PAPPER & MainClassDescription String 30 Papper & utskr Artikelklasser get_itemclasslist_bymainclass Vilka artikelklasser hittar jag filtrerat på en specifik huvudklass? Huvudklasskod Språkkod Lista med: Artikelklasskoder och Artikelklassbeskrivningar MainClassCode String 30 PAPPER & LanguageCode String 10 SE ItemClassCode String 10 PAPPER ItemClassDescription String 30 Paper get_itemclasslist_bymainclassandmanufacturer Vilka artikelklasser hittar jag filtrerat på huvudklass och tillverkare? Huvudklasskod Tillverkare av artikeln Språkkod Lista med: Artikelklasskoder och Artikelklassbeskrivningar MainClassCode String 30 PAPPER & ManufacturerCode String 20 ISOTECH LanguageCode String 10 SE ItemClassCode String 10 PAPPER ItemClassDescription String 30 Paper 16

17 3.3.5 Produktgrupper get_prodgrplist_bymanufacturer Vilka produktgrupper hittar jag filtrerat på en specifik tillverkare? Tillverkare av produkt Språkkod Lista med: Produktgruppskoder och produktgruppsbeskrivningar ManufacturerCode String 20 ISOTECH LanguageCode String 10 SE ProdGrpCode String 20 Papper ProdGrpDescription String 30 Papper get_prodgrplist_bymanufacturer_filteredbycustomitemno Vilka produktgrupper, vars underliggande artiklar innehåller mitt eget artikelnummer, hittar jag filtrerat på en specifik tillverkare? Tillverkare av produkt Språkkod Lista med: Produktgruppskoder och produktgruppsbeskrivningar ManufacturerCode String 20 ISOTECH LanguageCode String 10 SE ProdGrpCode String 20 Papper ProdGrpDescription String 30 Papper ProduktgruppsProdukter get_productgrpproductlist_filteredbycustomitemno Vilka produktgruppsprodukter, vars underliggande artiklar innehåller mitt eget artikelnummer, hittar jag filtrerat på en specifik tillverkare? Tillverkare av produkt Språkkod 17

18 Lista med: Produktkoder, produktbeskrivningar, tillverkarkoder, produktgruppskoder, produktgruppsbeskrivningar, produktgruppsbeskrivning kombinerat med produktbeskrivning ManufacturerCode String 20 ISOTECH LanguageCode String 10 SE ProductCode String 40 PIXMA IP5200 ProductDescription String 40 PIXMA IP5200 ManufacturerCode String 20 ISOTECH ProdGrpCode String 20 Papper ProdGrpDescription String 30 Papper ProductGrpAndProductDescription String 71 Papper PIXMA Produkter get_productlist_bymanufacturerandprodgrp Vilka produkter hittar jag filtrerat på tillverkare och produktgrupp? Tillverkare av produkt Produktgruppskod Språkkod Lista med: Produktkoder och produktbeskrivningar ManufacturerCode String 20 ISOTECH ProdGrpCode String 20 Papper LanguageCode String 10 SE ProductCode String 40 PIXMA IP5200 ProductDescription String 40 PIXMA IP get_productlist_bymanufacturerandprodgrp_filteredbycustomitemno Vilka produkter, vars underliggande artiklar innehåller mitt eget artikelnummer, hittar jag filtrerat på tillverkare och produktgrupp? Tillverkare av produkt Produktgruppskod Språkkod 18

19 Lista med: Produktkoder och produktbeskrivningar ManufacturerCode String 20 ISOTECH ProdGrpCode String 20 Papper LanguageCode String 10 SE ProductCode String 40 PIXMA IP5200 ProductDescription String 40 PIXMA IP Artiklar get_itemlist_bymainclassanditemclass Vilka artiklar hittar jag filtrerat på huvudklass och artikelklass? Huvudklasskod Aritkelklasskod Språkkod Lista med: Isoldas artikelnummer, kundspecifikt artikelnummer, beskrivningstext, EAN-kod, OEM-nummer, patronnummer, minsta möjliga köpvolym, beställningsvara? Ja/Nej, Artikelklassbeskrivning, tillverkare. MainClassCode String 30 PAPPER & ItemClassCode String 10 PAPPER LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H71190 CartridgeNo String 20 MinimumBuy Double - 1 OrderItem Boolean - false ItemClassDescription String 30 Papper ManufacturerCode String 20 ISOTECH get_itemlist_bymainclassanditemclass_filteredbycustomitemno Vilka artiklar med mitt eget artikelnummer hittar jag filtrerat på huvudklass och artikelklass? Huvudklasskod Aritkelklasskod 19

20 Språkkod Lista med: Isoldas artikelnummer, kundspecifikt artikelnummer, beskrivningstext, EAN-kod, OEM-nummer, patronnummer, minsta möjliga köpvolym, beställningsvara? Ja/Nej, Artikelklassbeskrivning, tillverkare. MainClassCode String 30 PAPPER & ItemClassCode String 10 PAPPER LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H71190 CartridgeNo String 20 MinimumBuy Double - 1 OrderItem Boolean - false ItemClassDescription String 30 Papper ManufacturerCode String 20 ISOTECH get_itemlist_bymanufactureranditemclass Vilka artiklar hittar jag filtrerat på tillverkare och artikelklass? Tillverkare av artikeln Aritkelklasskod Språkkod Lista med: Isoldas artikelnummer, kundspecifikt artikelnummer, beskrivningstext, EAN-kod, OEM-nummer, patronnummer, minsta möjliga köpvolym, beställningsvara? Ja/Nej, Artikelklassbeskrivning, tillverkare. ManufacturerCode String 20 ISOTECH ItemClassCode String 10 PAPPER LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H71190 CartridgeNo String 20 MinimumBuy Double - 1 OrderItem Boolean - false ItemClassDescription String 30 Papper 20

21 ManufacturerCode String 20 ISOTECH get_itemlist_bymanufactureranditemclass_filteredbycustomitemno Vilka artiklar med mitt eget artikelnummer hittar jag filtrerat på tillverkare och artikelklass? Tillverkare av artikeln Aritkelklasskod Språkkod Lista med: Isoldas artikelnummer, kundspecifikt artikelnummer, beskrivningstext, EAN-kod, OEM-nummer, patronnummer, minsta möjliga köpvolym, beställningsvara? Ja/Nej, Artikelklassbeskrivning, tillverkare. ManufacturerCode String 20 ISOTECH ItemClassCode String 10 PAPPER LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H71190 CartridgeNo String 20 MinimumBuy Double - 1 OrderItem Boolean - false ItemClassDescription String 30 Papper ManufacturerCode String 20 ISOTECH get_itemlist_bymanufacturerandprodgrpandproduct Vilka artiklar hittar jag filtrerat på tillverkare av artikeln, produktgrupp och produkt? Tillverkare av artikeln Produktgruppskod Produktkod Språkkod Lista med: Isoldas artikelnummer, kundspecifikt artikelnummer, beskrivningstext, EAN-kod, OEM-nummer, patronnummer, minsta möjliga köpvolym, beställningsvara? Ja/Nej, Artikelklassbeskrivning, tillverkare. ManufacturerCode String 20 ISOTECH 21

22 ProdGrpCode String Papper ProductCode String 40 PIXMA IP5200 LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H71190 CartridgeNo String 20 MinimumBuy Double - 1 OrderItem Boolean - false ItemClassDescription String 30 Papper ManufacturerCode String 20 ISOTECH get_itemlist_bymanufacturerandprodgrpandproduct_filteredbycustomitemno Vilka artiklar med mitt eget artikelnummer hittar jag filtrerat på tillverkare av artikeln, produktgrupp och produkt? Tillverkare av artikeln Produktgruppskod Produktkod Språkkod Lista med: Isoldas artikelnummer, kundspecifikt artikelnummer, beskrivningstext, EAN-kod, OEM-nummer, patronnummer, minsta möjliga köpvolym, beställningsvara? Ja/Nej, Artikelklassbeskrivning, tillverkare. ManufacturerCode String 20 ISOTECH ProdGrpCode String Papper ProductCode String 40 PIXMA IP5200 LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H71190 CartridgeNo String 20 MinimumBuy Double - 1 OrderItem Boolean - false ItemClassDescription String 30 Papper ManufacturerCode String 20 ISOTECH get_itemlist_byparentsectionid Vilka artiklar hittar jag under angiven kategori? 22

23 KetegoriID Språkkod Lista med: Isoldas artikelnummer, kundspecifikt artikelnummer, beskrivningstext, EAN-kod, OEM-nummer, patronnummer, minsta möjliga köpvolym, beställningsvara? Ja/Nej, Artikelklassbeskrivning, tillverkare. ManufacturerCode String 20 ISOTECH ProdGrpCode String Papper ProductCode String 40 PIXMA IP5200 LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H71190 CartridgeNo String 20 MinimumBuy Double - 1 OrderItem Boolean - false ItemClassDescription String 30 Papper ManufacturerCode String 20 ISOTECH get_itemlist_byparentsectionid_filteredbycustomitemno Vilka artiklar med mina egna artikelnummer hittar jag under angiven kategori? KetegoriID Språkkod Lista med: Isoldas artikelnummer, kundspecifikt artikelnummer, beskrivningstext, EAN-kod, OEM-nummer, patronnummer, minsta möjliga köpvolym, beställningsvara? Ja/Nej, Artikelklassbeskrivning, tillverkare. ManufacturerCode String 20 ISOTECH ProdGrpCode String Papper ProductCode String 40 PIXMA IP5200 LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H

24 CartridgeNo String 20 MinimumBuy Double - 1 OrderItem Boolean - false ItemClassDescription String 30 Papper ManufacturerCode String 20 ISOTECH Artikelinformation get_iteminfo_byisoldaitemno Vilken artikelinformation hittar jag på följande artikelnummer (Isoldas)? Språkkod Kundspecifikt ordernummer Beskrivningstext EAN-kod Lista med: OEM-nummer och förpackningsstorlekar Minsta möjliga köpvolym Tillverkare Patronnummer Beställningsvara? Ja/Nej Vikt Livslängd Artikelklassbeskrivning Extratext IsoldaItemNo String 20 PA LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H71190 PackageSize Int - 1, 500 MinimumBuy Double - 1 ManufacturerCode String 20 ISOTECH CartridgeNo String 20 OrderItem Boolean - false Weight Decimal - 0,318 Durability String ItemClassDescription String 30 Paper ItemInfo String - Ett fotopapper 24

25 get_iteminfo_bycustomitemno Vilken artikelinformation hittar jag på följande artikelnummer (kundspecifikt)? Kundspecifikt artikelnummer Språkkod Kundspecifikt ordernummer Beskrivningstext EAN-kod Lista med: OEM-nummer och förpackningsstorlekar Minsta möjliga köpvolym Tillverkare Patronnummer Beställningsvara? Ja/Nej Vikt Livslängd Artikelklassbeskrivning Extratext CustomItemNo String 20 DEMO1234 LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H71190 PackageSize Int - 1, 500 MinimumBuy Double - 1 ManufacturerCode String 20 ISOTECH CartridgeNo String 20 OrderItem Boolean - false Weight Decimal - 0,318 Durability String ItemClassDescription String 30 Paper ItemInfo String - Ett fotopapper get_iteminfo_byean Vilken artikelinformation hittar jag på följande EAN-kod? EAN-kod Språkkod 25

26 Kundspecifikt ordernummer Beskrivningstext EAN-kod Lista med: OEM-nummer och förpackningsstorlekar Minsta möjliga köpvolym Tillverkare Patronnummer Beställningsvara? Ja/Nej Vikt Livslängd Artikelklassbeskrivning Extratext EAN String LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H71190 PackageSize Int - 1, 500 MinimumBuy Double - 1 ManufacturerCode String 20 ISOTECH CartridgeNo String 20 OrderItem Boolean - false Weight Decimal - 0,318 Durability String ItemClassDescription String 30 Paper ItemInfo String - Ett fotopapper get_iteminfo_byoem Vilken artikelinformation hittar jag på följande OEM-nummer? OEM-nummer Språkkod Kundspecifikt ordernummer Beskrivningstext EAN-kod Lista med: OEM-nummer och förpackningsstorlekar Minsta möjliga köpvolym 26

27 Tillverkare Patronnummer Beställningsvara? Ja/Nej Vikt Livslängd Artikelklassbeskrivning Extratext OEM String 20 H71190 LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H71190 PackageSize Int - 1, 500 MinimumBuy Double - 1 ManufacturerCode String 20 ISOTECH CartridgeNo String 20 OrderItem Boolean - false Weight Decimal - 0,318 Durability String ItemClassDescription String 30 Paper ItemInfo String - Ett fotopapper get_iteminfo_bycartridgeno Vilken artikelinformation hittar jag på följande patronnummer? Patronnummer Språkkod Kundspecifikt ordernummer Beskrivningstext EAN-kod Lista med: OEM-nummer och förpackningsstorlekar Minsta möjliga köpvolym Tillverkare Patronnummer Beställningsvara? Ja/Nej Vikt Livslängd Artikelklassbeskrivning Extratext 27

28 CartridgeNo String LanguageCode String 10 SE IsoldaItemNo String 20 PA CustomItemNo String 20 DEMO1234 Description String 100 ISOTECH A4 EAN String OEM String 20 H71190 PackageSize Int - 1, 500 MinimumBuy Double - 1 ManufacturerCode String 20 ISOTECH CartridgeNo String 20 OrderItem Boolean - false Weight Decimal - 0,318 Durability String ItemClassDescription String 30 Paper ItemInfo String - Ett fotopapper Artikelbilder get_imagearchive_defaultsize_bycartridgeno Vad har Isolda för artikelbild på artikeln med följande artikelnummer (Isoldas)? Bilden i form av text (bytearray) IsoldaItemNo String 20 PA ImageBytes Byte[] get_imagearchive_defaultsize_bycustomitemno Vad har Isolda för artikelbild på artikeln med följande artikelnummer (kundspecifikt)? Kundspecifikt artikelnummer Bilden i form av text (bytearray) 28

29 CustomItemNo String 20 DEMO1234 ImageBytes Byte[] get_imagearchive_defaultsize_byean Vad har Isolda för artikelbild på artikeln med följande EAN-kod? EAN-kod Bilden i form av text (bytearray) EAN String ImageBytes Byte[] get_imagearchive_defaultsize_byisoldaitemno Info saknas get_imagearchive_defaultsize_byoem Vad har Isolda för artikelbild på artikeln med följande OEM-nummer? OEM-nummer Bilden i form av text (bytearray) OEM String 20 H71190 ImageBytes Byte[]

30 Lagersaldo get_stockinfo_byisoldaitemno Vad är aktuell lagerstatus för artikel med följande artikelnummer (Isoldas)? Tillgängligt lagersaldo IsoldaItemNo String 20 PA AvailableQuantity Int get_stockinfo_bycustomitemno Vad är aktuell lagerstatus för artikel med följande artikelnummer (Kundspecifikt)? Kundspecifikt artikelnummer Tillgängligt lagersaldo CustomItemNo String 20 DEMO1234 AvailableQuantity Int get_stockinfo_byean Vad är aktuell lagerstatus för artikel med följande EAN-kod? EAN-kod Tillgängligt lagersaldo 30

31 EAN String AvailableQuantity Int get_stockinfo_byoem Vad är aktuell lagerstatus för artikel med följande OEM-nummer? OEM-nummer Tillgängligt lagersaldo OEM String 20 H71190 AvailableQuantity Int get_stockinfo_bycartridgeno Vad är aktuell lagerstatus för artikel med följande CartridgeNo? CartridgeNo Tillgängligt lagersaldo CartridgeNo String 20 H71190 AvailableQuantity Int

32 get_stockinfoadvanced_byisoldaitemno Hämta detaljerad lagerinformation filtrerat på Isolda artikelnummer. IsoldaItemNo Tillgängligt lagersaldo Lagerställe AvailableQuantity Int LocationCode String 20 "JKP" get_stockinfoadvanced_bycustomitemno Hämta detaljerad lagerinformation filtrerat på kundspecifikt artnr. IsoldaItemNo Tillgängligt lagersaldo Lagerställe AvailableQuantity Int LocationCode String 20 "JKP" 32

33 get_stockinfoadvanced_byean Hämta detaljerad lagerinformation filtrerat på EAN. EAN Tillgängligt lagersaldo Lagerställe EAN String AvailableQuantity Int LocationCode String 20 "JKP" get_stockinfoadvanced_byoem Hämta detaljerad lagerinformation filtrerat på OEM. OEM Tillgängligt lagersaldo Lagerställe OEM String AvailableQuantity Int LocationCode String 20 "JKP" get_stockinfoadvanced_bycartridgeno Hämta detaljerad lagerinformation filtrerat på CartridgeNo. CartridgeNo Tillgängligt lagersaldo Lagerställe 33

34 CartridgeNo String 20 H71190 AvailableQuantity Int LocationCode String 20 "JKP" Isoldas inköpsorder get_onpurchaseorder_byisoldaitemno Vad är Isoldas inköpsstatus på artikel med följande artikelnummer (Isoldas)? Lista på: Beräknat inkommande saldo och leveransdatum till Isolda IsoldaItemNo String 20 PA Quantity Int DeliveryDate DateTime get_onpurchaseorder_bycustomitemno Vad är Isoldas inköpsstatus på artikel med följande artikelnummer (Kundspecifikt)? Kundspecifikt artikelnummer Lista på: Beräknat inkommande saldo och leveransdatum till Isolda CustomItemNo String 20 DEMO1234 Quantity Int DeliveryDate DateTime

35 get_onpurchaseorder_byean Vad är Isoldas inköpsstatus på artikel med följande EAN-kod? EAN-kod Lista på: Beräknat inkommande saldo och leveransdatum till Isolda EAN String Quantity Int DeliveryDate DateTime get_onpurchaseorder_byoem Vad är Isoldas inköpsstatus på artikel med följande OEM-nummer? OEM-nummer Lista på: Beräknat inkommande saldo och leveransdatum till Isolda OEM String 20 H71190 Quantity Int DeliveryDate DateTime get_onpurchaseorder_bycartridgeno Vad är Isoldas inköpsstatus på artikel med följande CartridgeNo? CartridgeNo Lista på: Beräknat inkommande saldo och leveransdatum till Isolda CartridgeNo String 20 H

36 Quantity Int DeliveryDate DateTime Priser get_priceinfo_byisoldaitemno Vad är priset för artikel med följande artikelnummer (Isoldas)? Lista med: Isoldas artikelnummer, förpackningsstorlek priset gäller, pris och valutakod PackageSize Int - 40 ItemPrice Decimal - 4,90 CurrencyCode String 10 EUR get_priceinfo_bycustomitemno Vad är priset för artikel med följande artikelnummer (Kundspecifikt)? Kundspecifikt artikelnummer Lista med: Isoldas artikelnummer, förpackningsstorlek priset gäller, pris och valutakod CustomItemNo String 20 DEMO1234 PackageSize Int - 40 ItemPrice Decimal - 4,90 CurrencyCode String 10 EUR 36

37 get_priceinfo_byean Vad är priset för artikel med följande EAN-kod? EAN-kod Lista med: Isoldas artikelnummer, förpackningsstorlek priset gäller, pris och valutakod EAN String PackageSize Int - 40 ItemPrice Decimal - 4,90 CurrencyCode String 10 EUR get_priceinfo_byoem Vad är priset för artikel med följande OEM-nummer? OEM-nummer Lista med: Isoldas artikelnummer, förpackningsstorlek priset gäller, pris och valutakod OEM String 20 H71190 PackageSize Int - 40 ItemPrice Decimal - 4,90 CurrencyCode String 10 EUR get_priceinfo_bycartridgeno Vad är priset för artikel med följande CartridgeNo? 37

38 CartridgeNo Lista med: Isoldas artikelnummer, förpackningsstorlek priset gäller, pris och valutakod CartridgeNo String 20 H71190 PackageSize Int - 40 ItemPrice Decimal - 4,90 CurrencyCode String 10 EUR Leveransinformation get_shipmentinfo_byisoldashipmentno Vad kan jag få för leveransinformation på leverans med följande leveransnummer (Isoldas)? Isoldas leveransnummer Isoldas leveransnummer Isoldas ordernummer Kundspecifik orderreferens Status ID Statusmeddelande Speditörskod Paketnummer Datum då paketet skickades från Isolda IsoldaShipmentNo String 20 SN IsoldaShipmentNo String 20 SN IsoldaOrderNo String CustomRef String StatusID Int - 10 StatusMessage String - Sent 38

39 Agent String 10 PLC PackageNo String ShippingDate Datetime get_shipmentinfo_byisoldaorderno Vad kan jag få för leveransinformation på leverans med följande Ordernummer (Isoldas)? Isoldas ordernummer Isoldas leveransnummer Isoldas ordernummer Kundspecifik orderreferens Status ID Statusmeddelande Speditörskod Paketnummer Datum då paketet skickades från Isolda IsoldaOrderNo String IsoldaShipmentNo String 20 SN IsoldaOrderNo String CustomRef String StatusID Int - 10 StatusMessage String - Sent Agent String 10 PLC PackageNo String ShippingDate Datetime get_shipmentinfo_bycustomref Vad kan jag få för leveransinformation på leverans med följande orderreferens (Kundspecifikt)? Kundspecifik orderreferens Isoldas leveransnummer Isoldas ordernummer Kundspecifik orderreferens Status ID Statusmeddelande Speditörskod Paketnummer Datum då paketet skickades från Isolda 39

40 CustomRef String IsoldaShipmentNo String 20 SN IsoldaOrderNo String CustomRef String StatusID Int - 10 StatusMessage String - Sent Agent String 10 PLC PackageNo String ShippingDate Datetime Länder get_countrylist Vilka länder kan Isolda leverera till via E-Order? Lista med: Landskoder och Landsnamn CountryCode String 10 SE Country String 50 Sverige Kategorier get_sectionlist_topparentsections Vilka kategorier ligger högst i kategoriträdet? Språkkod Lista med: KategoriID och Kategorinamn LanguageCode String 10 SE SectionID Int Text String 250 Audio & Video 40

41 get_sectionlist_topparentsections_filteredbycustomitemno Vilka kategorier, vars underliggande artiklar innehåller mitt eget artikelnummer, ligger högst i kategoriträdet? Språkkod Lista med: KategoriID och Kategorinamn LanguageCode String 10 SE SectionID Int Text String 250 Audio & Video get_sectionlist_byparentsectionid Vilka kategorier ligger under angiven kategori? KategoriID Språkkod Lista med: KategoriID och Kategorinamn SectionID Int LanguageCode String 10 SE SectionID Int Text String 250 Audio & Video get_sectionlist_byparentsectionid_filteredbycustomitemno Vilka kategorier, vars underliggande artiklar innehåller mitt eget artikelnummer, ligger under angiven kategori? KategoriID Språkkod Lista med: KategoriID och Kategorinamn SectionID Int LanguageCode String 10 SE 41

42 SectionID Int Text String 250 Audio & Video Orderläggning send_sendorder Kan jag skicka den här ordern? En komplett order enligt specificerat format o Orderhuvud Är ordern en testorder? Ja/Nej Kundspecifik orderreferens Godsmärke Kontaktperson Önskas endast komplett leverans? Ja/Nej Skall leveransen skickas som en direktleverans? Ja/Nej Leveransadress: Namnfält 1 Leveransadress: Namnfält 2 Leveransadress: Adressfält 1 Leveransadress: Adressfält 2 Leveransadress: Postnummer Leveransadress: Postort Leveransadress: Landskod Leveransadress: Leveranskontaktperson Lagerställekod Leveranssättskod Orderrader* o Orderrader Isoldas artikelnummer Kundspecifikt artikelnummer Egen artikelbeskrivning (valbart) Antal att beställa Märkning av orderrad Accepteras delleverans av artikeln? Ja/Nej - OrderHead Orderhead* * Orderhead 42

43 TestOrder Boolean - false CustomRef String CustomLabel String 30 Demo Delivery CustomContact* String 30 Demo Contact FullDelivery* Boolean - true DirectDelivery Boolean - false ShipToName* String 30 Isolda AB ShipToName2 String 30 IT-Avdelningen ShipToAddress* String 30 Box ShipToAddress2 String 30 Södra Torgg. 18 ShipToZip* String ShipToCity* String 30 Kungsbacka ShipToCountryCode* String 10 SE ShipToContact* String 30 Demokontakt ShippingMethod String 10 STH_HÄMT LocationId String 10 STH Orderlines* Orderlines * Orderlines IsoldaItemNo** String 20 PA CustomItemNo** String 20 DEMO1234 CustomDescription String 90 Customized d Quantity* Int - 12 Label String 30 IT-Department AcceptSplit Boolean - false * Obligatoriska fält ** Endast ett av fälten kommer användas Postnummer check_shippingpostcode Kontrollera om ett specifikt postnummer är giltigt för en leveransmetod. Leveransmetod Postnummer (fortsätt här) 43

44 o Orderhuvud Är ordern en testorder? Ja/Nej Kundspecifik orderreferens Godsmärke Kontaktperson Önskas endast komplett leverans? Ja/Nej Skall leveransen skickas som en direktleverans? Ja/Nej Leveransadress: Namnfält 1 Leveransadress: Namnfält 2 Leveransadress: Adressfält 1 Leveransadress: Adressfält 2 Leveransadress: Postnummer Leveransadress: Postort Leveransadress: Landskod Leveransadress: Leveranskontaktperson Orderrader* o Orderrader Isoldas artikelnummer Kundspecifikt artikelnummer Egen artikelbeskrivning (valbart) Antal att beställa Märkning av orderrad Accepteras delleverans av artikeln? Ja/Nej - OrderHead Orderhead* * Orderhead TestOrder Boolean - false CustomRef String CustomLabel String 30 Demo Delivery CustomContact* String 30 Demo Contact FullDelivery* Boolean - true DirectDelivery Boolean - false ShipToName* String 30 Isolda AB ShipToName2 String 30 IT-Avdelningen ShipToAddress* String 30 Box ShipToAddress2 String 30 Södra Torgg. 18 ShipToZip* String ShipToCity* String 30 Kungsbacka ShipToCountryCode* String 10 SE ShipToContact* String 30 Demokontakt Orderlines* Orderlines

45 * Orderlines IsoldaItemNo** String 20 PA CustomItemNo** String 20 DEMO1234 CustomDescription String 90 Customized d Quantity* Int - 12 Label String 30 IT-Department AcceptSplit Boolean - false * Obligatoriska fält ** Endast ett av fälten kommer användas. 45

46 3.4 Statuskoder StatusID och StatusMessage finns med på flera olika ställen och används till att returnera svar tillbaka till användaren. Gick allting som det skulle, skrev jag in information på rätt sätt osv. ID Message 10 O.K 15 O.K, no results found 20 Error: Wrong username or password 21 Error: User not authorized for this service 22 Error: User banned 30 Error: Missing input 31 Error: Wrong input format 32 Error: Wrong input size 50 Order received 51 Shipment in process 52 Shipment sent 70 Error: Customer banned 71 Error: Customer not allowed to place order 73 Error: CustomItem matches more than one items 74 Error: Wrong quantity 75 Error: Not allowed to use BOX-addresses 76 Error: Post code not valid 77 Error: Combination of ShippingMethod is not valid 78 Error: Country not allowed 90 Error: Service offline 91 Error: Service under construction 99 Error: Unidentified error 3.5 Säkerhet och missbruk av tjänsten Missbruk av tjänsten i form av s.k tankning av data kan leda till att din användare blir blockad/spärrad. Inga svar kommer då att kunna hämtas från Isoldas Webservice. Din användare kan bara bli aktiverad igen genom kontakt med Isolda. Se stycket om support. (5 Support) 3.6 Datumkoder Följande datum avser obekräftade datum: , , ,

47 3.7 Teckenkonvertering Konverteringsfunktionen används för att ersätta bland annat nordiska tecken när anropen kommer från klassisk ASP (ej.net) eftersom dessa tecken tolkas fel i webservicen. På den frågande sidan måste man därför ersätta med ett tillfälligt tecken enligt nedanstående tabell. Tillfälligt tecken Korrekt tecken E_ È e_ è E. É e. é U: Ü u: ü A. Å A: Ä O: Ö a. å a: ä o: ö 47

48 4 Support All support vad gäller Isoldas webservice, sker via senaste version av detta dokument. (2.3 Dokumentation) Isoldas IT-avdelning arbetar ständigt för att hålla detta dokument uppdaterat och fyllt med vanliga frågor och svar. (4.6 F.A.Q) Förbättringsförslag och andra önskemål hanteras i första hand skriftligen via er säljkontakt hos Isolda. Övriga förfrågningar handhavs enligt punkten felrapportering. (4.4 Felrapportering) 4.1 Dokumentation Samlad dokumentation om Isoldas webservice återfinns i detta dokument, som ett komplement till den dokumentation som webservicen i sig utgör. (2.3 Dokumentation) 4.2 Uppdateringar Uppdateringar och förbättringar som ej berör driften, sker löpande vardagar under kontorstid. Uppdateringar och förbättringar som kan påverka driften ses som ett avbrott. (4.3 Driftavbrott) Information om föregångna uppdateringar och förändringar hittas i senaste version av detta dokument. (2.3 Dokumentation) 4.3 Driftavbrott Annonsering av eventuella driftstop sker via till angiven driftkontakt hos er, senast 7 dagar innan driftstoppet infaller. Isolda förbehåller sig dock rätten att åtgärda kritiska driftproblem utan föravisering. Närmare information om planerade avbrott ges på förfrågan av Isoldas kundtjänst. 4.4 Felrapportering Fel- och buggrapportering skickas till angiven säljkontakt hos Isolda (se tillhörande kontakt formulär), i form av formuläret på Webservice - Supportformulär.doc

49 4.6 F.A.Q - 49

50 5 Versioner v 1.0 Första versionen av dokumentet. Publicerad v 1.01 Uppdaterad överblick av webservicen (Figur 3: Överblick av Isoldas webservice) Publicerad v 1.02 Uppdaterad kontaktinformation för support och felanmälan. (5 Support) Publicerad v 1.03 Ett stycke om strukturer har lagts till. (1.3 Strukturer) I nuläget innehållandes exempel på de två sökstrukturer som kan hämtas ut ur Isoldas webservice. v 1.10 Kategoriträdet har i denna dokumentation döpts om till Klassificeringsträdet, för att inte blanda ihop sökträdet webbservicen returnerar, med det som finns på Isoldas webshop. Uppdaterad information om den support Isolda erbjuder. Ny funktion get_itemlist_bymainclassanditemclass Används för att hämta ut artikellistor med hjälp av huvudklass och artikelklass. Se detaljerad information under get_itemlist_bymainclassanditemclass V 1.20 Säkerhetsskydd mot tankning av data har införts i systemet. Läs mer om detta under 3.5 Säkerhet och missbruk av tjänsten Publicerad V 1.30 För att ge våra kunder bättre förståelse om hur webservice fungerar och hur man kan nyttja den så har en demo shop utvecklats. Demoshopen ska fungera som ett komplement till övrig dokumentation och källkod samt ny dokumentation har tillkommit. V 2.00 Webservicen har nu fyllts på till hela 50 olika fördefinierade frågor. Bl.a. frågor för att hämta ut det flexibla kategoriträdet på isolda.se som hjälper kunder att hitta rätt artiklar på rätt 50

51 ställen, samt frågor som gör det möjligt att filtrera ut alla svar på Isoldas kunders egna artikelnummer. Detta gör det möjligt för kunden att bygga en webbshopp på Isoldas webbservice utan att behöva filtrera bort artiklar och steg i trädstrukturerna som inte ingår i sortimentet. Dessutom har webbservicen trimmats en hel del för att bättre tillmötesgå de krav på svarstider som krävs av större kunder. Nya funktioner get_iteminfo_bycartrideno get_itemlist_bymainclassanditemclass_filteredbycustomitemno get_itemlist_bymanufactureranditemclass_filteredbycustomitemno get_itemlist_bymanufacturerandprodgrpandproduct_filteredbycustomitemno get_itemlist_byparentsectionid get_itemlist_byparentsectionid_filteredbycustomitemno get_manufacturerlist_filteredbycustomitemno get_prodgrplist_bymanufacturer_filteredbycustomitemno get_productgrpproductlist_filteredbycustomitemno get_productlist_bymanufacturerandprodgrp_filteredbycustomitemno get_sectionlist_topparentsections get_sectionlist_topparentsections_filteredbycustomitemno get_sectionlist_byparentsectionid get_sectionlist_byparentsectionid_filteredbycustomitemno V 3.00 Two new fields have been added in OrderHeader of function send_sendorder. Names of the fileds are : LocationID (Lagerställekod) and ShippingMethod (Leveranssättskod). Function Modified send_sendorder Fields Added LocationID (Lagerställekod) ShippingMethod (Leveranssättskod) 51