user Created with Sketch.
Group 2 Created with Sketch.

Orderhistorik från Affärssystem
Hämta faktura- & orderhistorik från affärssystemet via Vendre Pull API

Hoppa fram till...

Vendre Pull API

Vendres e-handelssystem är utrustat med ett så kallat Pull API som kan hämta information från ert affärssystem när kunden besöker Mitt konto eller på andra ställen i butiken. API.et hämta då genom en request till affärssystemet den inforamtion som behövs i precis det tillfället som krävs för att optimera laddningstid och hastighet för kunden. 

Observera att generell information om produkter, kunder, priser, lager oftast alltid körs via Vendres vanliga API eller via fil för att uträkningar, SEO och andra systemfunktioner kräver att informationen finns i systemet.

Vendre Pull API används för att visa data på sidan från externa källor, inte uppdatera den informationen som finns i Vendres databas. 

Så funkar det 

När kunden loggar in i e-handeln kommer kunden att kunna gå till Mitt konto. Här visas ofta information om adresser, inloggningskonton, inställningar samt faktura- & orderhistorik. Normalt visas enbart orderhistorik som då kommer från de order som har lagts i e-handeln. Vill man att alla kundens order ska visas här så görs en integration till affärssystemet där kundens samlade engagemang finns. Affärssystemet svarar sen med information om alla fakturor, order och annan information som man vill exponera för användaren i butiken. 

Vendre tar emot data i formatet Json enligt det formatet som presenteras nedan.

Autentisering mot ERP:ts API sker antingen via POST eller headers.

Best practice

Baserat på lärdomar och erfarenhet från tidigare integrationer finns det vissa saker att tänka på när dessa integrationer görs. Detta är inte en beskrivning av hur det måste fungera men erfarenheter från de case som har bäst laddningstid och den integration som håller bäst över tid. 

Grund

Följande anrop är vanligt att de finns

  • Lista order
  • Visa enskild order
  • Lista fakturor
  • Visa enskild faktura

Utökade / används ibland

  • Restnoterade produkter
  • Separat anrop för kreditfakturor
  • Hämtning av aktuella adresser (Rekommenderas via Fil eller Vendres vanliga API så det ligger på kundkortet hos Vendre)
  • Hämtning av pris och lagersaldo (kräver att Affärssystemet klarar av denna last)
  • Lista order

    Lista över order bör minst kunna ta emot följande indata:

    • Autentisering via headers
    • Kundnummer
    • Orderdatum från (ÅÅÅÅ-MM-DD)
    • Orderdatum till (ÅÅÅÅ-MM-DD)
    • Sida / offset / antal beroende på hur det lämpligast läggs upp för er


    Detta anrop körs i samband med att kunden går in under Mitt konto > Orderhistorik. Det är relativt lite trafik till denna sida. 

    Följande data är bra om det kommer med i detta anrop. Lägg till mer data om det behövs  

    Fältnamn* Beskrivning
    id Ordernummer
    customer_no Kundnummer
    sum Ordersumma inkl. moms (om moms är applicerbart)
    date Orderdatum
    reference Orderreferens (om applicerbart)

    *Observera att namnen på fälten är förslag. Välj namn som är enkla för er eftersom Vendre inte är beroende av namnen.

  • Visa enskild order

    Enskild order bör ta emot följande indata:

    • Autentisering via headers
    • Kundnummer
    • Ordernummer


    Detta anrop körs i samband med att kunden går in under Mitt konto > Orderhistorik > Visa enskild order. Det är lite trafik till denna sida. 

    Följande data är bra om det kommer med i detta anrop. Lägg till mer data om det behövs  

    Fältnamn* Beskrivning
    id Ordernummer
    po_number PO-nummer (om applicerbart)
    comment Kommentar (om applicerbart)
    total Ordersumma (valutaformaterad)
    shipping_cost Fraktkostnad (valutaformaterad)
    tax Moms (Skicka som array om ni har flera momssatser som ska presenteras)
    customer
     company Företag
    no Kundnummer
    reference Referens / Namn
    address Adressrad 1
    address2 Adressrad 2
    zipcode Postnummer
    ziparea Postort
    Country Land (i klartext, ej ISO)
    country_iso ISO-3 (ex. SWE)
    products
    model Artikelnummer
    name Namn / Benämning
    quantity Antal
    price Pris (valutaformaterad)
    discount Radrabatt (valutaformaterad)
    row_total Radens totalpris (valutaformaterad)
    delivery
    reference Referens / Namn
    address Adressrad 1
    address2 Adressrad 2
    zipcode Postnummer
    ziparea Postort
    Country Land (i klartext, ej ISO)
    country_iso ISO-3 (ex. SWE)
    reference
    packages
    tracing_id Spårningsnummer
    tracking_link Språningslänk. Börjar med https://
    orders
    order_no Ordernummer
    pdf_link PDF-länk https:// (er URL exponeras ej för kund)

    *Observera att namnen på fälten är förslag. Välj namn som är enkla för er eftersom Vendre inte är beroende av namnen.

  • Lista fakturor

    Lista över fakturor bör minst kunna ta följande indata:

    • Autentisering via headers
    • Kundnummer
    • Fakturadatum från (ÅÅÅÅ-MM-DD)
    • Fakturadatum till (ÅÅÅÅ-MM-DD)
    • Sida / offset / antal beroende på hur det lämpligast läggs upp för er


    Detta anrop körs i samband med att kunden går in under Mitt konto > Fakturahistorik. Det är relativt lite trafik till denna sida. 

    Följande data är bra om det kommer med i detta anrop. Lägg till mer data om det behövs  

    Fältnamn* Beskrivning
    id fakturanummer
    customer_no Kundnummer
    sum Fakturasumma inkl. moms (om moms är applicerbart)
    due_date Förfallodatum
    reference Fakturareferens (om applicerbart)
    payment_status Betalningsstatus. Om fakturan har betalats eller ej.

    *Observera att namnen på fälten är förslag. Välj namn som är enkla för er eftersom Vendre inte är beroende av namnen.

  • Visa enskild faktura

    Enskild faktura bör ta emot följande indata:

    • Autentisering via headers
    • Kundnummer
    • Fakturanummer


    Detta anrop körs i samband med att kunden går in under Mitt konto > Fakturahistorik > Visa enskild faktura. Det är lite trafik till denna sida. 

    Följande data är bra om det kommer med i detta anrop. Lägg till mer data om det behövs  

    Fältnamn* Beskrivning
    id Fakturanummer
    po_number PO-nummer (om applicerbart)
    comment Kommentar (om applicerbart)
    total Ordersumma (valutaformaterad)
    shipping_cost Fraktkostnad (valutaformaterad)
    tax Moms (Skicka som array om ni har flera momssatser som ska presenteras)
    customer
     company Företag
    no Kundnummer
    reference Referens / Namn
    address Adressrad 1
    address2 Adressrad 2
    zipcode Postnummer
    ziparea Postort
    Country Land (i klartext, ej ISO)
    country_iso ISO-3 (ex. SWE)
    products
    model Artikelnummer
    name Namn / Benämning
    quantity Antal
    price Pris (valutaformaterad)
    discount Radrabatt (valutaformaterad)
    row_total Radens totalpris (valutaformaterad)
    delivery
    reference Referens / Namn
    address Adressrad 1
    address2 Adressrad 2
    zipcode Postnummer
    ziparea Postort
    Country Land (i klartext, ej ISO)
    country_iso ISO-3 (ex. SWE)
    references
    packages
    tracing_id Spårningsnummer
    tracking_link Språningslänk. Börjar med https://
    orders
    order_no Ordernummer
    pdf_link PDF-länk https:// (er URL exponeras ej för kund)

    *Observera att namnen på fälten är förslag. Välj namn som är enkla för er eftersom Vendre inte är beroende av namnen.

Viktigt med rätt formaterad responsdata

När ni returnerar data till Vendre är det viktigt att ni validerar Json så att den är korrekt. Om den inte skulle vara korrekt kommer Vendre inte kunna läsa av datan och visa den för slutkunden.