Tilpassede ordrehandlinger som involverer tredjepartssystemer - med Order Webhooks


Oversikt

Fordeler med egendefinerte handlinger via bestillingswebhooks

Ledere kan ha behov for å utføre ordrerelaterte handlinger som involverer tredjepartssystemer , enten når en ny ordre legges inn eller på et tidspunkt etter at den er lagt inn. Her er noen eksempler:

  • En leder ønsker å importere eksterne gebyrer på en leieordre fra tredjepartssystemer
  • En leder ønsker å sende ordreinnhold til et eksternt system
  • En leder ønsker at en spesifikk handling skal utføres ved ordreplassering, som ikke er en del av standard Sharefox-ordreflyten, men som kan oppnås via API

Det finnes to typer slike egendefinerte handlinger:

  • Automatisk: utløses under bestilling
  • On-demand: initieres av ordrebehandleren når som helst fra Admin Order-siden

Viktig: Oppsettet er avhengig av at de eksterne systemene støtter REST API og spesifikke flyter. Konfigurering av egendefinerte handlinger krever aktivering av Order Webhooks-funksjonen (se mer informasjon nedenfor).

Automatiske tilpassede handlinger ved ordreplassering

Når en ordre legges inn i Sharefox, er det mulig å utløse et API-kall til en egendefinert URL fra et hvilket som helst eksternt system som støtter REST API, for å signalisere at en ny ordre er opprettet, som kan brukes i videre behandling.

Hva ser lederen?

Et aktivitetsnotat vil bli plassert på Sharefox-ordren, under Ordreside ▸ Informasjon ▸ Aktivitet. Navnet på den egendefinerte handlingen og tidsstempelet vil bli inkludert i notatet

Hvordan utløses handlingen?

Denne flyten settes opp ved hjelp av Order Webhooks: en webhook av typen"order-action-on-placement" må konfigureres - se mer informasjon i avsnittet Order Webhooks: Hvordan fungerer de og hvordan du setter dem opp.

Egendefinerte handlinger som utløses på forespørsel av lederen

Når som helst i løpet av bestillingens livssyklus kan administratoren utløse en egendefinert handling, hvis den er forhåndskonfigurert, ved å velge Admin Order Page ▸ Actions menu ▸ Trigger action.

Når handlingen er utløst, logges et aktivitetsnotat på bestillingssiden ▸ Informasjon ▸ Aktivitetspanelet, akkurat som i tilfellet med automatiske handlinger.

Hvordan konfigurerer jeg egendefinerte on-demand-handlinger?

Denne flyten settes opp ved hjelp av Order Webhooks: en webhook av typen"order-action-on-demand" må konfigureres - se mer informasjon i avsnittet Order Webhooks: Hvordan fungerer de og hvordan du setter dem opp.

Bestill webhooks: Hvordan fungerer de og hvordan settes de opp?

Order Webhooks kan initiere sending av ordreinformasjon til eksterne systemer som support REST API-kommunikasjon . De er svært fleksible og kan tilpasses i henhold til egenskapene nedenfor:

Utløsende faktorer:

  • En webhook av typen "order-action-on-placement" utløses når en bestilling legges inn i Shop eller Admin, ved ordrebekreftelseshendelse (når standard e-postbekreftelse sendes til brukeren)
  • En webhook av typen "order-action-on-demand" utløses av administratoren på Admin Order-siden

Innhold:

  • Følgende ordreparametere sendes automatisk: orderId, orderReference
  • Eventuelt ytterligere bestillingsinnhold skal bestilles via Sharefox API (se dokumentasjon her)
  • Hvis det eksterne systemet ikke har en slik fleksibilitet, kan et mellomvareprogram som Zapier brukes til å hente det ekstra ordreinnholdet og legge det ut i det eksterne systemet

Tekniske parametere

  • HTTP-metode: Kan spesifiseres, vanligvis satt til POST-metode
  • Overskrifter. Et hvilket som helst antall egendefinerte header-parametere kan legges til i anropet
  • Kroppsparametere. Følgende parametere vil bli sendt: orderId (heltall), orderReference (streng)
  • Ytterligere bestillingsinnhold kan etterspørres i etterkant via ett GET API-kall ved hjelp av det offentlige Sharefox API-et (se API-dokumentasjon her)

Svar:

For øyeblikket støttes to parametere for svarlegemet:

  • suksess (bool): Styrer den visuelle visningen av toast-meldingen i Admin UI
  • message (streng, valgfri): Meldingen som skal inkluderes i toast-meldingen i Admin UI

Hvordan setter jeg opp Order Webhooks?

Bestill webhooks er en avansert funksjon som kanskje allerede er dekket i ditt Sharefox-abonnement - ta gjerne kontakt med oss for å bekrefte dette. For å aktivere det, vennligst skriv en e-post til support inkludert følgende informasjon:

  • Webhook-type: ordre-handling-på-plassering / ordre-handling-på-behov
  • Handlingsnavn: Et egendefinert visningsnavn som vil være synlig på Admin Order-siden
  • Beskrivelse av handling (valgfritt): En egendefinert beskrivelse som forklarer brukeren hva handlingen vil gjøre
  • HTTP-metode: Tilpasset, som kreves av eksternt system
  • URL: Tilpasset, som kreves av eksternt system
  • Overskrifter: Tilpasset, etter krav fra eksternt system

Andre webhooks

Webhook-dokumentasjon for handlingen "Send faktura" (i tilfelle tilpassede regnskapsintegrasjoner) kan gjøres tilgjengelig på forespørsel.




Nøkkelord: Autopass, bompenger, bompenger, bompenger

Trenger du fortsatt hjelp? Kontakt oss Kontakt oss