Prøv tjenesten: XML API
Du kan hente data fra Bring direkte i XML format. Denne metoden er ikke så avansert som å bruke Web Service, men gir fortsatt de fleste muligheter.
Tjenesten er gratis tilgjengelig forutsatt aksept av bruksvilkårene. Merk at kun registerte brukere vil få meldinger om endringer i tjenesten!
Eksempler på bruk
| Sending | Ett produkt | To eller flere produkter | Alle produkter |
|---|---|---|---|
| Pris basert på vekt | xml | xml | xml |
| Pris basert på alle parametre | xml | xml | xml |
| Kun transporttid | xml | xml | xml |
| Pris, transporttid og produkttekster | xml | xml | xml |
| Pris, transporttid og produkttekster basert på alle parametere | xml | xml | xml |
I tabellen finnes flere brukseksempler for tjenesten. Eksemplene tar for seg sending av en pakke på 1500 gram fra postnummer 7600 til 1407. Der pakkemål og dato er relevant, brukes målene 40x40x33 (cm) og datoen 03.02.2009.
NB! Husk å legge på timeout på kall til tjenesten og håndtering av feilmeldinger som f.eks for stor pakke eller utenfor dekningsområde. En mulighet er å gi en fast standardpris på pakken dersom tjenesten ikke svarer eller gir feilmelding (dog bør f.eks utenfor dekningsområde håndteres spesielt). Se oversikt over feilkoder.
Velge ressurs og produkt
XML APIet kan kalles på forskjellige måter avhengig av hvilke data man skal ha ut. Det er mulig å spørre om ressursene pris, transporttid, produkttekster - eller alle tre. På samme måte kan det spørres om ett produkt, flere spesifikke produkter eller alle produktene som passer for en pakke med gitte mål.
Valg av ressurs det spørres etter gjøres på følgende måte:
- Transporttid (xml)
- Pris (xml)
- Pris, forsendelsestid og produkttekster (xml)
Begrensningen av produkt gjøres på følgende måte:
- Ett produkt (xml)
- Flere produkter (xml)
- Alle produkter (xml)
Ved å endre på ressurser og parametere i adressefeltet kan du tilpasse data til ditt behov!
Parametere
Tjenesten tar som vist over inn et sett med parametre. Disse angir forsendelsesinformasjon som brukes til å beregne resultatet. Hver spørring har et minimum sett med informasjon, men som hovedregel vil også mer informasjon medføre bedre og mer korrekt svar. Den følgende listen viser de mulige parametrene:
| Parameter | Beskrivelse |
|---|---|
| Postnummer (Postalcode) | Oppgis ved å legge på ?from=7600&til=1407 (xml). |
| Vekt i gram (Weight) | Oppgis ved å legge på ?weightInGrams=1500 (xml). Merk at vekten oppgis i gram. |
| Pakkemål i centimeter (Dimensions) | Oppgis ved å legge på &length=30&width=40&height=40 (xml). |
| Volum i kubikkdesimeter (Volume) | Oppgis ved å legge på &volume=33 (xml). |
| Forsendingsdato (ShippingDate) | Forsendingsdatoen angir hvilken dato pakken blir levert til Bring (innenfor tidsfristen), og brukes til å beregne leveringsdato. Oppgis ved å legge på &date=2009-02-03 (xml). Datoen oppgis på ISO-format, altså YYYY-MM-DD. |
| Forhåndsmeldt (m/EDI) (EDI setting) | Flagg som angir om pakken er forhåndsmeldt. Oppgis ved å legge på &edi=false (xml). Default er true. Merk at dette flagget utover pris kan påvirke hvilke produkter som er tilgjengelig. |
| Innlevert på postkontor (Shipped from post office) | Flagg som angir om du leverer pakken til postkontor når den sendes. Oppgis ved å legge på &postingAtPostoffice=true (xml). Default er false. |
| Tilleggstjenester (Additional services) | Gir pris på de oppgitte tilleggstjenester. Oppgis ved å legge på &additional=postoppkrav&additional=evarsling &additional=lordagsutkjoring (xml). |
| Prisjustering (Price adjustments) |
Gir mulighet til å justere prisene som returneres. Oppgis ved å legge på &priceAdjustment=m20p (xml). Merk at prisjusteringen gjøres på prisen uten MVA. Mer informasjon om prisjustering finnes under. |
Prisjustering
Fraktguiden tilbyr justering av prisene som vises. Denne tjenesten er tilgjengelig både i XML APIet og i Levert av Bring. For å justere prisen legges parameteren &priceAdjustment=m20p på i spørringen.
Parameteren bygges opp på formen [produktkode_][o]10[p]. Deler av parameteren med firkantklammer ([ ]) rundt er frivillige. De ulike delene av parameteren har følgende betydning:
- produktkode_ brukes dersom prisjusteringen kun skal gjøres for ett produkt. Eksempel: &priceAdjustment=SERVICEPAKKE_m20 senker prisen på Servicepakke med 20 kroner.
- o angir hvilken operasjon som skal utføres. Støttede operasjoner er 'p' for pluss, 'm' for minus eller blankt for fastprisjustering. Eksempel:
- &priceAdjustment=m20 slår av 20 kroner på alle produktene.
- &priceAdjustment=p20 legger til 20 kroner på alle produktene.
- &priceAdjustment=SERVICEPAKKE_79 setter Servicepakke til fastpris på 79 kroner.
- 10 angir faktoren som skal brukes i prisjusteringen. Dette tallet kan angi et fast kronebeløp som skal legges til/trekkes fra, en prosent som skal legges til/trekkes fra eller en fastpris avhengig av de andre parametrene.
- p angir at operasjonen gjelder prosent. Merk at dette kun er gyldig for pluss- og minusoperasjoner (ikke fastpris).
Det er mulig å kombinere flere prisjusteringer i en spørring. Det er ikke anbefalt å gjøre overlappende spørringer. Dersom det er behov for å gjøre flere samtidige prisjusteringer bør det gjøres for hvert enkelt produkt ved hjelp av produktkode-prefikset.
Eksempel: &priceAdjustment=SERVICEPAKKE_79 &priceAdjustment=EKSPRESS09_m20p setter fastpris på 79 kroner for Servicepakke og trekker fra 20% på Bedriftspakke Ekspress Over natten 09.
Støtte for flere kolli
XML API'et har støtte for å spørre om summert pris for flere kolli. For å sende inn pakkemål for flere kolli, send inn pakkemålsparameterne på normal måte, men sett på et tall-suffix (0-9) for å identifisere de ulike kolli.
Eksempel-pakkemålsparametre:
weightInGrams1=1500&weightInGrams2=2500
Legg merke til at packageId attributten til resultatet har verdien PACKAGE_AGGREGATE_1_2. Dette er for å vise at resultatet er en aggregert (summert) pakke av kolli med suffix 1 og 2. Generelt listes alle gjenkjente pakker (suffix) opp her.
Intet tall-suffix er samme som suffix 0.
Man trenger ikke å ha de samme pakkemålsparametre på hvert kolli.
Dvs. følgende parametre er helt OK:
weightInGrams=1500&volume2=150.
PackageId attributten i dette tilfellet blir som forventet satt til PACKAGE_AGGREGATE_0_2.
Begrensninger i XML API
XML API har noen begrensninger. Dersom du har behov utover dette bør du ta en kikk på Prøv tjenesten - Web Service.
- XML API håndterer spesialgodstillegg som er en følge av lengde, bredde og høyde på pakken, men du kan ikke selv definere den som spesialgods.
