Varegruppestruktur.xml eksporteres som et komplett register fra alle eksporttjenester.

Transkript

1 Beskrivelse av eksportformater på XML Dette dokumentet inneholder beskrivelser av NOBB XML-formatene. Disse formatene innholder det meste av vareinformasjonen i NOBB, og benyttes for eksport av vare-, modul-, pris og varegruppeinformasjon. Generelt om XML-formatene NOBB XML-formatene består av flere xml-meldinger. Skissen nedenfor viser meldingene, hva de inneholder og relasjonene mellom dem. Detaljert beskrivelse av innholdet i den enkelte melding er beskrevet senere i dokumentet. NOBB Varegruppestruktur er en hierarkisk struktur som har tre nivåer; overgruppe, hovedgruppe og varegruppe. Denne strukturen er bransjestandard og er felles for alle vareeiere i NOBB. Varegruppestruktur.xml eksporteres som et komplett register fra alle eksporttjenester. Modul.xml inneholder NOBB moduler. En modul inneholder varer som naturlig hører sammen og har felles egenskaper (ofte en leverandørs produktserie der f.eks. dimensjon varierer). Modulen har generisk informasjon for "sine varer" som beskrivelse, dokumentasjon, merkenavn, produsent etc. En modul er spesifikk for en vareeier, i motsetning til varegruppestrukturen som er felles for alle. Modulen er knyttet til én deltaker (deltakerregister.xml) som er eier av modulen og dens varer, og én produsent (produsentregister.xml). I meldingen Vare.xml kommer informasjon om den konkrete varen, og tilhørende pakninger. side 1

2 Varens priser kommer i en egen melding, Pris.xml. Denne inneholder kun prisinformasjon, og relateres til varen via NOBB-nummeret. Siste versjon av XML-formatene er 8.0. Denne versjonen anbefales benyttet da den inneholder de nyeste feltene som er opprettet i NOBB. Eksportformat Vare.xml versjon 8.0 Nedenfor vises skjematisk fremstilling av eksportformatet for varer. VareResult Header Eksport metadata EksportType EksportType Complex Type Eksport metadata. EksportId xs:int Eksportmetode xs:string Eksportservice metode som har levert XML dokumentet. EksportParametre optional xs:string Parametere som er benyttet for eksport. StartIndex xs:int Index i eksportens totale resultatsett det er hentet elementer fra. BatchSize xs:int Antall elementer i XML dokument. TotalCount xs:int Totalt antall elementer i eksporten VersionNr xs:string NOBB XML versjonsnummer Result ResultType Complex Type ResultValue ResultEnum Simple Type Description optional xs:string VareListe Vare 0.. VareType Complex Type Status EndringsType Complex Type side 2

3 Created xs:datetime Updated optional xs:datetime NOBBNr NobbNr Simple Type Varens NOBBnr, 8 siffer. NOBBModulNr NobbNr Simple Type Varens NOBB-modulnummer. Referanse til modul schema. VareType VareTypeEnum Simple Type Varetype, er en av følgende: - Standard - Sammensatt - Display - Spesialvare VareTekst1 Varetekst1Type Simple Type Varetekst1, maks 35 tegn VareTekst2 optional Varetekst2Type Simple Type Varetekst2, maks 35 tegn LangVaretekst optional LangVaretekstType Simple Type Lang varetekst, maks 100 tegn ProdusentVareNr ProdusentVarenummerType Simple Type Produsentens varenummer, max 20 tegn. UnderArbeid optional BooleanEnum Simple Type Er varen under arbeid (Ja/Nei) BestarAvVareListe optional Liste av varer som inngår i display eller sammensatt vare BestarAvVare 1.. BestarAvVareType Complex Type NOBBNr NobbNr Simple Type GTIN GTIN Simple Type Enhet EnhetEnum Simple Type Antall xs:decimal Lagerfort BooleanEnum Simple Type Er varen normalt lagerført? (Ja/Nei) HarHoldbarhetsdato optional BooleanEnum Simple Type Har varen holdbarhetsdato? (Ja/nei) TalerFrost optional BooleanEnum Simple Type side 3

4 Tåler varen frost? (Ja/nei) TUNKoblinger optional TUNType Complex Type TUN 1.. ProduktIdentifikatorType Complex Type Produktidentifikator (Danmark) Nummer Restriction of xs:string Navn Restriction of xs:string FINFOKoblinger optional FINFOType Complex Type FINFO 1.. ProduktIdentifikatorType Complex Type Produktidentifikator (Sverige) Nummer Restriction of xs:string Navn Restriction of xs:string PrisEnhet EnhetEnum Simple Type Enhet varen er priset i PSEVaregruppe optional EnhetEnum Simple Type Enhet for prissammenligning som er definert for varens varegruppe HarVarePSE optional BooleanEnum Simple Type Har varen enhet for prissammenligning? (Ja/nei) Statistikkenhet optional EnhetEnum Simple Type Statistikkenhet definert på varens varegruppe ErstattesAvNOBBnr optional NobbNr Simple Type NOBB-nummer for vare som erstatter varen, dersom den utgår SorteringsIndex optional xs:int Brukes for styring av egendefinert sorteringsrekkefølge Varebeskrivelse optional xs:string Beskrivelse av varen og varens egenskaper Leverandorer LeverandorerType Complex Type Varens leverandører og deres spesifikke informasjon Leverandor 1.. LeverandorType Complex Type DeltakerNummer DeltagerNrType Simple Type Leverandørens deltakernummer i NOBB Navn Restriction of xs:string Leverandørens navn ErVareeier BooleanEnum Simple Type Er leverandøren vareeier for varen? (Ja/Nei) side 4

5 VareNummer Restriction of xs:string Leverandørens varenummer Pakninger LeverandorPakningerType Complex Type Leverandørens pakninnger Pakning 1.. PakningType Complex Type Merkinger optional Extension of MerkingerType Complex Type Leverandørens merkinger Merking 1.. Restriction of xs:string Svane, Blomst, NAAF, FSC, PEFC Medier optional MedierType Complex Type Leverandørens medier Media 1.. MediaLinkType Complex Type UtgarDato optional xs:date Varen utgår fra leverandøren denne dato Avgifter optional AvgifterType Complex Type Avgift 1.. VareAvgiftType Complex Type AvgiftsKode Restriction of xs:string EM - (Emballasje miljøavgift) EG - (Emballasje grunnavgift) BAT - (Batteriavgift) RA - (Særavgift radio/fjernsyn) TBT - (Særavgift tobakk) LB - (Særavgift uinnspilte kasetter og videobånd) KF - (Særavgift kullsyrefrie alkoholfrie drikker) KU - (Særavgift kullsyreholdige alkoholfrie drikker) MI - (Særavgift mineralolje) MM - (Særavgift mineralolje til motorvogn) SM - (Smøreavgift) BE - (Bensinavgift) KK - (Kull og koks) BM - (Båtmotorer) SJ - (Særavgift på sjokolade og sukkervarer) ACT - (Særavgift på brennevin og vin) OL - (Særavgift på øl) PCB - (PCB-avgift) CM - (CO2-avgift mineralolje) CB - (CO2-avgift bensin) CN - (CO2-avgift naturgass) CL - (CO2-avgift LPG) FK - (Avgift på HFK og PFK) AvgiftsTekst Restriction of xs:string NRFData optional NRFDataType Complex Type NRFNr xs:int NRFGruppeNr xs:int NRFLeverandorNr Restriction of xs:string Dimensjon optional Restriction of xs:string Navn Restriction of xs:string Tilleggsopplysninger optional Restriction of xs:string FarligGods optional FarligGodsType Complex Type side 5

6 TransportMerking optional TransportMerkingType Complex Type UNNr Restriction of xs:string FareNr Restriction of xs:string Beskrivelse optional Restriction of xs:string EmballasjeGruppe optional Restriction of xs:string EmballasjeMerking 0.. Restriction of xs:string TollKoder optional TollkoderType Complex Type NoTollKode optional Restriction of xs:string EuTollKode optional Restriction of xs:string GodkjenningsStatus optional GodkjenningStatusEnum Simple Type VareGruppeNr optional VaregruppeNrType Simple Type Varegruppenummer, 7 siffer HovedGruppeNr optional HovedgruppeNrType Simple Type Hovedgruppenummer, 4 siffer OverGruppeNr optional OvergruppeNrType Simple Type Overgruppenummer, 2 siffer VareGruppeNavn optional Restriction of xs:string Varegruppens navn HovedGruppeNavn optional Restriction of xs:string Hovedgruppens navn OverGruppeNavn optional Restriction of xs:string Overgruppens navn ModulTekst1 optional Restriction of xs:string Modultekst 1 fra varens modul, maks 35 tegn EndredeFelt optional FeltEndringerVare Complex Type StatusCreated optional BooleanEnum Simple Type StatusUpdated optional BooleanEnum Simple Type NOBBNr optional BooleanEnum Simple Type NOBBModulNr optional BooleanEnum Simple Type VareTekst1 optional BooleanEnum Simple Type VareTekst2 optional BooleanEnum Simple Type LangVaretekst optional BooleanEnum Simple Type LeverandorVareNr optional BooleanEnum Simple Type ProdusentVareNr optional BooleanEnum Simple Type Lagerfort optional BooleanEnum Simple Type side 6

7 Spesialvare optional BooleanEnum Simple Type HarHoldbarhetsdato optional BooleanEnum Simple Type TalerFrost optional BooleanEnum Simple Type UtgarDato optional BooleanEnum Simple Type TUNKoblinger optional BooleanEnum Simple Type FINFOKoblinger optional BooleanEnum Simple Type Merkinger optional BooleanEnum Simple Type Medier optional BooleanEnum Simple Type PrisEnhet optional BooleanEnum Simple Type Statistikkenhet optional BooleanEnum Simple Type ErstattesAvNOBBnr optional BooleanEnum Simple Type SorteringsIndex optional BooleanEnum Simple Type Varebeskrivelse optional BooleanEnum Simple Type Avgifter optional BooleanEnum Simple Type NRFData optional BooleanEnum Simple Type FarligGods optional BooleanEnum Simple Type TollKoder optional BooleanEnum Simple Type GodkjenningsStatus optional BooleanEnum Simple Type VareGruppeNr optional BooleanEnum Simple Type HovedGruppeNr optional BooleanEnum Simple Type OverGruppeNr optional BooleanEnum Simple Type PSEVaregruppe optional BooleanEnum Simple Type Egenskaper optional EgenskaperType Complex Type Varens IFD egenskaper Egenskap EgenskapdataType Complex Type Navn xs:string Egenskapens navn GUID Restriction of xs:string Egenskapens unike GUID Verdi xs:string Eganskapens verdi Enhet xs:string Egenskapens enhet side 7

8 Eksportformat modul.xml versjon 8.0 Nedenfor vises skjematisk fremstilling av eksportformatet for Modul. ModulResult Rot-element for modul meldingen Header EksportType EksportType Complex Type EksportId xs:int Eksportmetode xs:string Eksportservice metode som har levert XML dokumentet. EksportParametre optional xs:string Parametere som er benyttet for eksport. StartIndex xs:int Index i eksportens totale resultatsett det er hentet elementer fra. BatchSize xs:int Antall elementer i XML dokument. TotalCount xs:int Totalt antall elementer i eksporten VersionNr xs:string NOBB XML versjonsnummer Result ResultType Complex Type ResultValue ResultEnum Simple Type Description optional xs:string ModulListe Modul 0.. ModulType Complex Type Status EndringsType Complex Type Created xs:datetime Updated optional xs:datetime NOBBmodulNr optional xs:int Modulens NOBB modullnummer - 8 siffer InterntModulnr InternModulNr Simple Type Vareeiers interne modulnummer - maks 8 tegn side 8

9 DeltakerNr DeltagerNrType Simple Type Vareeiers NOBB deltakernummer - maks 6 tegn ProdusentNr xs:string Produsentens nummer ProdusentNavn xs:string Navn for produsent av varene i modulen VareGruppeNr VaregruppeNrType Simple Type Modulen tilhører dette varegruppenummer - maks 7 tegn Merkenavn xs:string Merkenavn for varene i modulen - maks 30 tegn Stikkord 0.. ModulStikkordType Complex Type Stikkord for varene i modulen StikkOrd Restriction of xs:string Standard 0.. ModulStandardType Complex Type Standard for varene i modulen StandardKode xs:string Beskrivelse xs:string Modulbeskrivelse optional xs:string Beskrivelse av varene i modulen. ModulTekst1 Restriction of xs:string Moduletekst 1 - maks 35 tegn ModulTekst2 optional Restriction of xs:string Moduletekst 2 - maks 35 tegn Deltakernavn optional xs:string Navn på vareeier for modulen VareGruppeNavn optional xs:string Modulens varegruppenavn HovedGruppeNr optional HovedgruppeNrType Simple Type Modulens hovedgruppenummer - 4 tegn OverGruppeNr optional OvergruppeNrType Simple Type Modulens overgruppenummer - 2 tegn HovedGruppeNavn optional xs:string Modulens hovedgruppenavn OverGruppeNavn optional xs:string Modulens overgruppenavn Eksportformat Pris.xml versjon 8.0 Nedenfor vises skjematisk fremstilling av eksportformatet for Pris. En vare kan ha priser fra flere leverandører/prisgivere. En vare kan også ha både gjeldende og fremtidig gjeldende priser. side 9

10 PrisResult Header EksportType EksportType Complex Type EksportId xs:int Eksportmetode xs:string Eksportservice metode som har levert XML dokumentet. EksportParametre optional xs:string Parametere som er benyttet for eksport. StartIndex xs:int Index i eksportens totale resultatsett det er hentet elementer fra. BatchSize xs:int Antall elementer i XML dokument. TotalCount xs:int Totalt antall elementer i eksporten VersionNr xs:string NOBB XML versjonsnummer Result ResultType Complex Type ResultValue ResultEnum Simple Type Description optional xs:string PrisListe Pris 0.. PrisType Complex Type NOBBNr xs:int NOBBPris 1.. PrisDatoType Complex Type Pris PrisType Simple Type PrisType PrisTypeEnum Simple Type PrisDatoFOM optional xs:date PrisDatoTOM optional xs:date DeltagerNr DeltagerNrType Simple Type ValutaKode xs:string PrisEnhet optional xs:string Status optional EndringsType Complex Type side 10

11 Created xs:datetime Updated optional xs:datetime Eksportformat Varegruppestruktur.xml versjon 8.0 Nedenfor vises skjematisk beskrivelse av eksportformatet for NOBB varegruppestruktur. VaregruppestrukturResult Header EksportType EksportType Complex Type EksportId xs:int Eksportmetode xs:string Eksportservice metode som har levert XML dokumentet. EksportParametre optional xs:string Parametere som er benyttet for eksport. StartIndex xs:int Index i eksportens totale resultatsett det er hentet elementer fra. BatchSize xs:int Antall elementer i XML dokument. TotalCount xs:int Totalt antall elementer i eksporten VersionNr xs:string NOBB XML versjonsnummer Result ResultType Complex Type ResultValue ResultEnum Simple Type Description optional xs:string VaregruppestrukturListe Overgruppe 0.. OvergruppeType Complex Type OvergruppeNr xs:string Beskrivelse xs:string Hovedgruppe 0.. HovedgruppeType Complex Type HovedgruppeNr xs:string side 11

12 Beskrivelse xs:string Varegruppe 0.. VaregruppeType Complex Type VaregruppeNr xs:string Beskrivelse xs:string PSE optional xs:string UNSPSCnr xs:string Status EndringsType Complex Type Created xs:datetime Updated optional xs:datetime Status EndringsType Complex Type Created xs:datetime Updated optional xs:datetime Status EndringsType Complex Type Created xs:datetime Updated optional xs:datetime side 12