API for egendefinerte kanaler

En egendefinert kanal lar din egen nettbutikk, ERP eller ditt eget lagersystem sende ordrer rett inn i Zippendo, når det ikke finnes en ferdig tilkobling for det. Denne siden dekker hver kontroll i opprettingsvinduet og i kanalinnstillingene, og hvordan en utvikler sender en ordre. Veiviseren steg for steg er Koble til ordrekanaler. Den fullstendige referansen for innholdet er Egendefinerte kanaler. Klikk på Ordrekanaler i sidefeltet, og deretter på fanen Katalog. Kortet Egendefinert kanal sier Koble til din egen nettbutikk eller ditt eget ERP-system. Knappen er Opprett kanal.

Katalogen over ordrekanaler med kortet Egendefinert kanal og knappen Opprett kanal — Kortet Egendefinert kanal i katalogen

Opprett kanalen

Klikk på Opprett kanal. Vinduet Opprett egendefinert kanal åpnes: En ordrekanal for din egen nettbutikk eller ditt eget ERP-system.

Vinduet Opprett egendefinert kanal med Kanalnavn utfylt som My webshop, Opprett kanal og Avbryt — Opprett egendefinert kanal: skriv inn et Kanalnavn

Felt	Påkrevd	Hva du skriver inn
Kanalnavn	Ja	Et navn du kjenner igjen, for eksempel «Nettbutikken min». Opprett kanal er inaktiv til du har skrevet inn ett.
Merkevare	Nei	Vises bare når organisasjonen din har merkevarer. Ordrer fra denne kanalen tilhører denne merkevaren.

Klikk på Opprett kanal (den viser Oppretter…). Du ser Ordrekanalen er opprettet, og Zippendo åpner innstillingene til den nye kanalen. Hvis du ser Kunne ikke opprette ordrekanalen, prøver du igjen. Avbryt lukker vinduet.

Ordremottak

Innstillingssiden har kanalnavnet som overskrift, og Din egen integrasjon: send ordrer til mottaks-URL-en, eller bruk API-et og SDK-ene. Se dokumentasjonen åpner referansen Egendefinerte kanaler.

Kortet Ordremottak: Systemet ditt sender signerte ordrer til mottaks-URL-en nedenfor. Signer råinnholdet i hver forespørsel med HMAC-SHA256, med signeringshemmeligheten.

Kontroll	Hva den gjør
Mottaks-URL	Adressen systemet ditt sender ordrer til, på formen `https://api.zippendo.com/webhooks/order-channels/<channel id>`. Kopier den fra din egen kanal. Kopier viser Kopiert til utklippstavlen., eller Kunne ikke kopiere til utklippstavlen.
Generer hemmelighet	Oppretter signeringshemmeligheten. Viser Genererer…, deretter Signeringshemmeligheten er generert. eller Kunne ikke generere signeringshemmeligheten.
Erstatt hemmelighet	Erstatter en eksisterende hemmelighet. Zippendo ber deg bekrefte: systemet ditt avvises til det signerer med den nye hemmeligheten.
Trekk tilbake	Slår av hemmeligheten. Alle ordrer systemet ditt sender, avvises til du genererer en ny hemmelighet. Viser Signeringshemmeligheten er tilbakekalt. eller Kunne ikke tilbakekalle signeringshemmeligheten.
Aktiv signeringshemmelighet opprettet	Etterfulgt av datoen og klokkeslettet da den gjeldende hemmeligheten ble opprettet.

Kanalen godtar bare ordrer når en signeringshemmelighet finnes. Det finnes ingen egen bryter for å slå på ordremottak. Etter Generer hemmelighet eller Erstatt hemmelighet vises hemmeligheten én gang:

Ordremottak med engangs-signeringshemmeligheten, Kopier, Tilbakekall og Erstatt hemmelighet — Kopier signeringshemmeligheten nå. Den vises bare én gang

Kopier hemmeligheten nå. Den vises bare én gang. Hvis du erstatter den senere, slutter den gjeldende hemmeligheten å virke med en gang. Hemmeligheten starter med zwhs_. Lagre den i konfigurasjonen til systemet ditt.

Send en ordre

Send en POST til Mottaks-URL med to headere:

Header	Verdi
`X-Zippendo-Topic`	`order.created`, `order.updated`, `order.cancelled` eller `ping`
`X-Zippendo-Signature`	HMAC-SHA256 av råinnholdet i forespørselen, hex-kodet, med signeringshemmeligheten som nøkkel

order.created og order.updated oppretter eller oppdaterer begge ordren etter externalId. Innholdet i order.cancelled er { "externalId": "…" }. ping returnerer 200 { "received": true } uten å endre noe.

import crypto from "node:crypto"

const body = JSON.stringify(order)
const signature = crypto.createHmac("sha256", process.env.ZIPPENDO_WEBHOOK_SECRET)
  .update(body)
  .digest("hex")

await fetch(webhookUrl, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Zippendo-Topic": "order.created",
    "X-Zippendo-Signature": signature
  },
  body
})

Påkrevde felt i innholdet: externalId, orderNumber og orderLines (minst én linje med name og quantity). Valgfrie: customerName, customerEmail, shippingAddress, subtotalAmount, totalAmount, currency, notes, shippingMethodTitle og serviceCode. Full felttabell: Egendefinerte kanaler.

Status	Betydning
`200`	Godtatt og behandlet
`400`	Manglende eller ukjent topic, innhold som ikke besto valideringen, eller Kanal aktivert er av
`401`	Signatursjekken mislyktes: feil hemmelighet, manglende header, eller ingen hemmelighet generert ennå
`404`	Ukjent kanal
`429`	For mange ordrer samtidig. Prøv igjen etter forsinkelsen i `Retry-After`
`5xx`	Behandlingen mislyktes. Prøv igjen: det er trygt å sende den samme ordren på nytt

Foretrekker du forespørsel og svar? Opprett ordrer med POST /orgs/{orgId}/orders, med orderChannelId, og et API-token. En ny ordre med samme externalId på den samme kanalen returnerer 409 ORDER_EXISTS. For å få sporingsnumre og statusendringer tilbake abonnerer du på webhooks for organisasjonen din (shipment.dispatched, tracking.updated). En egendefinert kanal har ingen egen tilbakekalling for sporing, og ingen skjerm for å koble leveringsmåter. En ordre du sender, vises under Ordrer. Statusen kan være Feil når Zippendo importerte ordren, men ikke kunne opprette en sending som er klar til å sendes, for eksempel fordi ingen fraktregel samsvarte eller adressen er ufullstendig. Ordren tilhører fortsatt kanalen.

Ordrelisten med en ordre som kom inn gjennom en egendefinert kanal — En ordre sendt av systemet ditt på siden Ordrer

Drift

Innstilling	Lagres	Hva den gjør
Kanal aktivert	Med en gang	Slår kanalen på eller av. Når den er av, avviser Zippendo alle ordrer som sendes til denne kanalen.
Send sendinger automatisk	Med Lagre endringer	Sender sendingen til transportøren automatisk når en innkommende ordre samsvarer med en fraktregel. Av som standard.
Merkevare	Med en gang	Ordrer fra denne kanalen tilhører denne merkevaren. Listen vises bare når organisasjonen din har merkevarer.
Standard avsenderadresse	Med Lagre endringer	Avsenderen for sendinger når ingen fraktregel samsvarer med ordren. Hvis ingen er lagret ennå, står det Ingen adresser ennå i listen.
Siste ordre mottatt	Skrivebeskyttet	Når kanalen sist mottok en ordre, eller Aldri.

Lagre endringer (Lagrer…) lagrer Send sendinger automatisk og Standard avsenderadresse. Du ser Ordrekanalen er oppdatert, eller Kunne ikke oppdatere ordrekanalen.

Slå av en kanal

Slå av Kanal aktivert. På fanen Tilkoblet står det da Deaktivert på raden til kanalen i kortet Egendefinert kanal. Egendefinerte kanaler blir alltid værende på fanen Tilkoblet, og blir aldri kanaler som er blitt liggende igjen.

Siden Ordrekanaler med en egendefinert kanal merket Deaktivert — En egendefinert kanal som er slått av

Shopify- eller WooCommerce-kanaler som er blitt liggende igjen, merket Ingen aktiv tilkobling og Frakoblet, er noe annet. Se Innstillinger for ordrekanaler.

Slett

Under Faresone finner du Slett kanal: Slett denne egendefinerte kanalen. Integrasjonen din kan ikke lenger sende ordrer til den.

Klikk på Slett og bekreft: Slette denne egendefinerte kanalen? Mottaks-URL-en slutter umiddelbart å godta ordrer. Du ser Ordrekanalen er slettet, eller Kunne ikke slette ordrekanalen.

Relatert

Koble til ordrekanaler

Opprett kanalen fra katalogen, og åpne deretter Ordrer.

Referanse for egendefinerte kanaler

Fullt innhold, avbestilling, ping og REST-eksempler.

Innstillinger for ordrekanaler

Siden Ordrekanaler, merkevarer og kanaler som er blitt liggende igjen.

Opprett et API-token

Et token for POST /orgs/{orgId}/orders i stedet for signerte push-forespørsler.

Oversikt

Sendinger

Ordrer og kanaler

Transportører

Koble til en transportør

Koble til en integrasjon

Utskrift

Automatisering

Konto

Søk og dashboard

API og hendelser

API for egendefinerte kanaler

Opprett kanalen

Ordremottak

Send en ordre

Drift

Slå av en kanal

Slett

Relatert

Koble til ordrekanaler

Referanse for egendefinerte kanaler

Innstillinger for ordrekanaler

Opprett et API-token

​Opprett kanalen

​Ordremottak

​Send en ordre

​Drift

​Slå av en kanal

​Slett

​Relatert

Koble til ordrekanaler

Referanse for egendefinerte kanaler

Innstillinger for ordrekanaler

Opprett et API-token

Opprett kanalen

Ordremottak

Send en ordre

Drift

Slå av en kanal

Slett

Relatert