Anpassade orderåtgärder som involverar system från tredje part - med Order Webhooks


Översikt

Fördelar med anpassade åtgärder via orderwebhooks

Chefer kan behöva utföra orderrelaterade åtgärder som involverar tredjepartssystem antingen direkt när en ny order läggs eller vid någon tidpunkt efter att ordern har lagts. Här är några exempel:

  • En chef vill importera externa avgifter på en hyresorder från 3:e parts system
  • En chef vill skicka orderinnehåll till ett externt system
  • En chef vill att en specifik åtgärd ska utföras vid orderläggning, som inte är en del av Sharefox standardorderflöde men som kan uppnås via API

Det finns två typer av sådana anpassade åtgärder:

  • Automatisk: utlöses vid orderläggning
  • On-demand: initieras av orderhanteraren när som helst från Admin Order-sidan

Viktigt: Installationen är beroende av att de externa systemen stöder REST API och specifika flöden. För att konfigurera anpassade åtgärder krävs att funktionen Order Webhooks aktiveras (se mer information nedan).

Automatiska anpassade åtgärder vid orderläggning

När en order läggs i Sharefox är det möjligt att utlösa ett API-anrop till en anpassad URL från ett externt system som stöder REST API, vilket signalerar att en ny order har skapats för att användas i den fortsatta behandlingen.

Vad ser chefen?

En aktivitetsanteckning kommer att placeras på Sharefox-ordern, under Order Page ▸ Information ▸ Activity. Den anpassade åtgärdens namn och tidsstämpel kommer att inkluderas i anteckningen

Hur utlöses åtgärden?

Detta flöde konfigureras med hjälp av Order Webhooks: en webhook av typen"order-action-on-placement" måste konfigureras - se mer information i avsnittet Order Webhooks: Hur fungerar de och hur konfigurerar man dem?

Anpassade åtgärder som utlöses på begäran av chefen

När som helst under orderns livscykel kan chefen utlösa en anpassad åtgärd, om den har förkonfigurerats, genom att välja Admin Order Page ▸ Actions menu ▸ Trigger action.

När åtgärden har utlösts kommer en aktivitetsanteckning att loggas på panelen Order Page ▸ Information ▸ Activity, precis som i fallet med den automatiska åtgärden.

Hur ställer jag in anpassade åtgärder på begäran?

Detta flöde konfigureras med hjälp av Order Webhooks: en webhook av typen"order-action-on-demand" måste konfigureras - se mer information i avsnittet Order Webhooks: Hur fungerar de och hur konfigurerar man dem?

Beställ webhooks: Hur fungerar de och hur ställer man in dem?

Order Webhooks kan initiera sändning av orderinformation till externa system som support REST API-kommunikation . De är mycket flexibla och anpassningsbara inom ramen för nedanstående egenskaper:

Utlösande faktorer:

  • En webhook av typen "order-action-on-placement" utlöses när en order läggs i Shop eller Admin, vid orderbekräftelsehändelsen (när standardbekräftelsemailet skickas till användaren)
  • En webhook av typen "order-action-on-demand" utlöses av chefen på Admin Order-sidan

Innehåll:

  • Följande orderparametrar skickas automatiskt: orderId, orderReference
  • Eventuellt ytterligare orderinnehåll ska begäras via Sharefox API (se dokumentation här)
  • Om det externa systemet inte har en sådan flexibilitet kan ett mellanprogram som Zapier användas för att hämta det extra orderinnehållet och skicka det till det externa systemet

Tekniska parametrar

  • HTTP-metod: Kan anges, vanligtvis inställd på POST-metod
  • Rubriker. Valfritt antal anpassade headerparametrar kan läggas till i anropet
  • Parametrar i meddelandet. Följande parametrar kommer att skickas: orderId (integer), orderReference (string)
  • Ytterligare orderinnehåll kan begäras i efterhand via ett GET API-anrop med hjälp av det offentliga Sharefox API (se API-dokumentation här)

Svar:

För närvarande stöds två parametrar för svarskroppar:

  • framgång (bool): Styr den visuella visningen av Admin UI:s skålmeddelande
  • message (sträng, valfritt): Det meddelande som ska inkluderas i Admin UI toast message

Hur ställer man in Order Webhooks?

Order Webhooks är en avancerad funktion som kanske redan täcks av din Sharefox-prenumeration - kontakta oss gärna för att bekräfta. För att aktivera det, vänligen skriv ett e-postmeddelande till support inklusive följande information:

  • Webhook-typ: order-action-on-placement / order-action-on-demand
  • Åtgärdsnamn: Ett anpassat visningsnamn som kommer att synas på Admin Order Page
  • Beskrivning av åtgärden (valfritt): En anpassad beskrivning som förklarar för användaren vad åtgärden kommer att göra
  • HTTP-metod: Anpassad, enligt krav från externt system
  • URL: Anpassad, enligt krav från externt system
  • Rubriker: Anpassad, enligt krav från externt system

Andra webhooks

Webhook-dokumentation för åtgärden "Skicka faktura" (vid anpassade bokföringsintegrationer) kan göras tillgänglig på begäran.




Nyckelord: Autopass, vägtullar, bompenger

Behöver du fortfarande hjälp? Kontakta oss Kontakta oss på