- Send ordrer inn: systemet ditt sender signerte webhook-hendelser til kanalens egen mottaks-URL, eller kaller REST API-et (offisielle SDK-er er tilgjengelige).
- Få svar tilbake: abonner på utgående webhooks fra Zippendo (
shipment.dispatched,tracking.updatedog flere) for å motta sporingsnumre og statusendringer.
1. Opprett kanalen
Klikk Ordrekanaler i app.zippendo.com, åpne fanen Katalog og klikk Opprett kanal på kortet Egendefinert kanal. Eller opprett den via API-et:2. Generer signeringshemmeligheten
Klikk Generer hemmelighet på kanalens innstillingsside, eller kallPOST /orgs/{orgId}/order-channels/{channelId}/webhook-secret. Svaret inneholder mottaks-URL-en og hemmeligheten:
3. Send ordrer
Send enPOST til mottaks-URL-en med to headere:
Ordrenyttelast (order.created / order.updated)
Begge emnene oppfører seg likt: ordren upserts på externalId, så gjentatte leveringer og oppdateringer i feil rekkefølge er trygge. Send det systemet ditt synes er enklest.
Nyttelast for kansellering (order.cancelled)
Tilkoblingstest (ping)
Enhver signert innholdsdel med X-Zippendo-Topic: ping returnerer 200 { "received": true } uten å endre data. Bruk den til å sjekke signeringskoden din.
Svar
Hva som skjer med en innsendt ordre
- Ordren upserts i kanalen (og arver kanalens merkevare, hvis den har en).
- En fraktregel finnes: den eksplisitte
serviceCode, ellers kanalens koblinger for leveringsmåter sammenlignet medshippingMethodTitle. - En sending opprettes. Sendinger med en samsvarende regel er klare til å sendes. Hvis bare en Standard avsenderadresse er satt, opprettes et utkast i stedet.
- Hvis Send sendinger automatisk er på for kanalen, sendes en sending med en samsvarende regel til transportøren med en gang, og fraktetiketten havner i Zippendo (automatisk utskrift på regelen gjelder).
REST som alternativ
Hvis du foretrekker forespørsel og svar fremfor webhooks, oppretter du ordrer via API-et med et API-token:- En duplisert
externalIdpå samme kanal returnerer409 ORDER_EXISTS. Behandle den som «allerede mottatt». - Hvis du sender
shippingRuleIdellershippingMethodTitle(eller slår på Send sendinger automatisk for kanalen), opprettes sendingen i samme kall, akkurat som ved en innsending. - Ordrekanaler er en del av det offentlige API-et, så SDK-ene dekker hvert trinn: opprett kanalen, generer hemmeligheten, send ordrer og list sendinger.
Få sporing tilbake
Zippendo varsler systemet ditt via utgående webhooks: abonner påshipment.dispatched og tracking.updated under Innstillinger → Webhooks. Sendinger har ordrenummeret ditt som reference, og nyttelasten inneholder orderId for oppslag.
Neste steg
Utgående webhooks
Motta sporings- og statushendelser, og verifiser signaturene våre.
API-referanse
Alle endepunkter for ordrekanaler og ordrer, med eksempler.