Rechtliches
Datenexport und Datenstrukturen
Welche Daten ein Restaurant in OrderKick selbst exportieren kann, in welchen Formaten und mit welchen Feldern. Die Übersicht dient der Information nach der Verordnung (EU) 2023/2854 (Data Act). Die vertraglichen Regeln zu Export und Anbieterwechsel stehen in den AGB.
1. Zugang
- Exportieren können nach der Anmeldung im Verwaltungsbereich: der Inhaber des Restaurants und Partner-Inhaber (Partner, die das Restaurant betreuen) alle unten genannten Exporte; Partner-Mitarbeiter nur Speisekarte, Berichte und Shop-Auswertung. Mitarbeiterkonten des Restaurants haben keinen Zugang zu Exporten.
- Die unten genannten Pfade sind die Adressen, die der Verwaltungsbereich nach der Anmeldung aufruft; einen eigenen Zugangsschlüssel für einen automatisierten Abruf gibt es nicht.
- Die Exporte sind kostenlos.
- Bei mehreren Standorten gilt jeder Export für den gewählten Standort.
- Im Bestellbetrieb anonymisiert die Software personenbezogene Angaben in Bestellungen und Reservierungen nach Ablauf der Speicherfrist aus dem Auftragsverarbeitungsvertrag. Spätere Exporte enthalten sie nicht mehr.
2. Exporte
Bestellungen
- Abruf
GET /api/
restaurant/ reports/ orders/ export, wählbar: Zeitraum (höchstens 367 Tage), Bestellart, Status in drei Gruppen (Ausstehend; Angenommen und weiterbearbeitet; Abgelehnt / storniert), Zahlungsart - Format
CSV (UTF-8 mit BOM, Komma); „XLS“ ist tabulatorgetrennter Text (UTF-8 mit BOM); PDF nur als Zusammenfassung. Kopfzeile mit deutschen Feldnamen, Zeiten als JJJJ-MM-TT hh:mm:ss, Beträge mit Dezimalpunkt, Steuersätze in der Steueraufschlüsselung mit Dezimalkomma. Zellen, die mit =, +, @ oder einem nicht-numerischen Minus beginnen, erhalten ein vorangestelltes Apostroph (Schutz vor Formeln).
- Zusammenfassung
Bestellnummer, Bestellt am, Gewünscht für, Bestellart, Bestellstatus, Bestellpositionen, Gesamt brutto, Währung, Zahlungsart, Zahlungsstatus
- Frei wählbare Felder
Interne Bestell-ID, Bestellnummer, Bestellt am, Gewünscht für, Angenommen am, Abgelehnt am, Bestellart, Bestellstatus, Bestätigte Minuten, Tisch, Reservierungs-ID, Kundenname, E-Mail, Telefon, Lieferadresse, Bestellpositionen, Artikel brutto, Rabatt, Liefergebühr, Servicegebühr, Verpackungsgebühr, Zahlungsgebühr, Trinkgeld, Netto, Steuer, Gesamt brutto, Erfolgreiche Korrekturen, Realisierter Umsatz, Währung, Steueraufschlüsselung, Zahlungsart, Zahlungsstatus, Gutscheincode, Bestellquelle, Bestellhinweis, Ablehnungsgrund, Rechnungsnummer, Finanzsnapshot-Hash (Auswahl und Reihenfolge frei)
- Hinweis
Die Bestellpositionen stehen als Text in einem Feld. Online-Bestellungen ohne abgeschlossene Zahlung (weder bezahlt noch erstattet) fehlen im Export. Testbestellungen aus der Vorschau der Bestellseite sind enthalten und nicht als solche gekennzeichnet.
Speisekarte
- Abruf
GET /api/
restaurant/ menu-transfer/ export - Format
JSON, Kennung „format“: orderkick.menu, „version“: 1. Die Datei lässt sich wieder in OrderKick importieren (bis 5 MB).
- Aufbau
format, version, source, source_id, currency, tax_context, entities, media_references. Jeder Eintrag in entities hat ref, type, parent, data und bindings (template, size, sort_order).
- Kategorie
name, description, sort_order, is_active, available_from, available_until, tax_category_key
- Speise
name, description, base_price, sizes (name, price, is_default), tax_rate, tax_category_key, sort_order, is_active, is_available, hidden_until, unavailable_until, service_modes (pickup, delivery, dine_in)
- Optionsgruppe und Option
Gruppe: name, min_selections, max_selections, is_required, sort_order. Option: name, price_delta, size_prices, tax_category_key, sort_order, is_active
- Vorlage und Vorlagen-Option
Vorlage: name, min_selections, max_selections, is_required, allow_multiple_same, sort_order. Option: name, price_delta, size_prices, tax_category_key, is_default, sort_order, is_active
- Steuern und Bilder
tax_context: mode, default, categories (key, pickup_rate_bps, delivery_rate_bps, dine_in_rate_bps). media_references: ref, url (Bilder als Adresse)
Rechnungsregister
- Abruf
GET /api/
restaurant/ invoices/ export, wählbar: Dokumentart, Zeitraum - Format
CSV (UTF-8 mit BOM, Komma) oder tabulatorgetrennter Text, Kopfzeile auf Deutsch. Zeitraum höchstens 367 Tage, ohne Zeitraum alle Rechnungen. Ohne Treffer enthält die Datei nur die Zeile „Keine Rechnungen“, ohne Kopfzeile.
- Felder
Dokumentart, Rechnungsnummer, Ausstellungsdatum, Leistungsdatum, Bestellnummer, Bezugsrechnung, Status, Netto, Steuer, Brutto, Netto Minor Units, Steuer Minor Units, Brutto Minor Units, Währung, Dokument-Hash
Einzelne Rechnung
- Abruf
GET /api/
restaurant/ invoices/ {Rechnung} (JSON) und GET /api/ restaurant/ invoices/ {Rechnung}/ pdf (PDF) - Rechnungsdaten
invoice_payload mit contract_version 1, Prüfwert invoice_hash. Felder: document_type, invoice_number, source_invoice_number, issued_at, service_date, retention_until, currency, minor_unit_digits, source_financial_snapshot_hash, totals, customer, order, lines, seller, tax_breakdown, payment
- Positionen
lines: line_key, parent_line_key, line_type, name, sku, quantity, unit_amount_minor, pre_discount_minor, discount_minor, net_amount_minor, tax_amount_minor, gross_amount_minor, tax_name, tax_rate_bps, metadata
- Käufer und Bestellung
customer: name, address_line_1, address_line_2, postal_code, city, country_code, email, tax_identifier, buyer_reference, electronic_address_scheme, electronic_address. order: order_id, order_number, type, status_at_issue, payment_method, payment_status_at_issue, placed_at, accepted_at, requested_for, coupon_code, table_label
- Summen
totals: net_total_minor, tax_total_minor, gross_total_minor, payable_total_minor (Beträge in kleinster Währungseinheit)
E-Rechnung
- Abruf
Erzeugen je Rechnung: POST /api/
restaurant/ accounting/ invoices/ {Rechnung}/ artifacts; Download: GET /api/ restaurant/ invoice-artifacts/ {Datei}/ download - Formate
XRechnung (UN/CEFACT CII, XML) und ZUGFeRD, Profil EN 16931 (PDF mit eingebetteter factur-x.xml), erzeugt mit der Bibliothek horstoeko/zugferd; OrderKick beschriftet sie als XRechnung 3.0.2 und ZUGFeRD 2.3.2. Jede Datei mit SHA-256-Prüfwert.
- Voraussetzung
Aktive Buchhaltungseinstellungen des Restaurants; eine Rechnung mit fehlenden Pflichtangaben wird nicht umgewandelt.
Buchhaltung (DATEV)
- Abruf
Stapel anlegen: POST /api/
restaurant/ accounting/ batches (Zeitraum innerhalb eines Kalenderjahres); Download: GET /api/ restaurant/ accounting/ batches/ {Stapel}/ download - Format
DATEV-Format EXTF 700, Buchungsstapel Version 13; Windows-1252, Semikolon, Zeilenende CRLF. Zeile 1 Kopfsatz, Zeile 2 die 125 Spaltennamen des DATEV-Formats.
- Voraussetzung
Vollständige DATEV-Einstellungen (Bereitschaftsprüfung im Verwaltungsbereich).
- Befüllte Spalten
Umsatz (ohne Soll/Haben-Kz), Soll/Haben-Kennzeichen, WKZ Umsatz, Konto, Gegenkonto (ohne BU-Schlüssel), BU-Schlüssel, Belegdatum, Belegfeld 1, Buchungstext, Leistungsdatum, Datum Zuord. Steuerperiode, Abrechnungsreferenz (nur bei Korrekturrechnungen)
Berichte
- Abruf
GET /api/
restaurant/ reports/ export, Bericht summary, orders, customers, trend oder daily_close - Format
CSV (UTF-8 mit BOM, Komma) oder tabulatorgetrennter Text, Kopfzeile auf Englisch
- summary
Group, Orders, Subtotal tax, Subtotal gross, Delivery fee tax, Delivery fee gross, Tips gross, Discounts gross, Gross order total, Successful adjustments, Realized revenue
- orders
Order number, Date, Time, Type, Customer (maskiert), Payment method, Status, Subtotal, Delivery fee, Tip, Discount, Total, Successful adjustments, Realized revenue
- customers
Name, Email, Phone (jeweils maskiert), Last order, Orders, Realized revenue
- trend
Date, Orders, Realized revenue, Average order value, Tips, Discounts, Delivery fees
- daily_close
Section, Metric, Value, Net, Tax, Gross
Shop-Auswertung
- Abruf
GET /api/
restaurant/ reports/ analytics/ export, Bericht funnel, origins, abandonments, promotions oder delivery-zones - Format
Nur CSV (UTF-8 mit BOM, Komma), Kopfzeile auf Englisch; nur zusammengefasste Werte, keine Angaben zu einzelnen Gästen
- funnel
Measurement (sessions oder counts), Metric key, Current sessions, Current rate from previous stage (%), Current drop-off to next stage, Previous sessions, Previous rate from previous stage (%), Trust level
- origins
Touch model, Channel, Label, Campaign, Bucket, Current placed orders, Current valid orders, Current accepted orders, Current payable order value minor, Current successful adjustments minor, Current net realized order value minor, Previous placed orders, Financial snapshot orders, Currency
- abandonments
Period, Section, Key, Sessions or orders, Share (%)
- promotions
Promotion code, Promotion label, Promotion kind, Application mode, Current placed orders, Current valid orders, Current accepted orders, Current refunded orders, Current discount total minor, Current payable order value minor, Current successful adjustments minor, Current net realized order value minor, Previous placed orders, Financial snapshot orders, Currency, Identity source
- delivery-zones
Zone, Radius km, Minimum order, Configured delivery fee, Current placed orders, Current valid orders, Current accepted orders, Current delivered orders, Current cancelled or rejected orders, Current delivery fee total minor, Current net realized order value minor, Previous placed orders, Financial snapshot orders, Currency, Identity source
Auskunft für einen Gast
- Abruf
POST /api/
restaurant/ guest-privacy/ export mit E-Mail-Adresse oder Telefonnummer des Gastes - Format
JSON, Kennung „format“: orderkick-guest-data-export/v1; alternativ eine Textzusammenfassung
- Aufbau
format, generated_at, restaurant, search, orders, reservations, invoices, loyalty, analytics, not_stored
- Bestellungen
order_number, status, type, customer_name, customer_email, customer_phone, delivery_address, delivery_street, delivery_postal_code, delivery_city, delivery_lat, delivery_lng, table_label_snapshot, notes, subtotal, tip_amount, delivery_fee, discount_amount, total, payment_method, payment_status, coupon_code, requested_for, rejection_reason, rejection_message, created_at, accepted_at, rejected_at, items (name, size, quantity, total_price, options)
- Reservierungen
status, party_size, guest_name, guest_email, guest_phone, guest_notes, deposit_status, deposit_amount_minor, deposit_refunded_minor, deposit_currency, decision_reason, starts_at, created_at, events (type, occurred_at, details)
- Weitere Teile
invoices: invoice_number, document_type, issued_at, retention_until, customer. loyalty: profiles (eligible_order_count, net_revenue_minor, first_order_at, last_order_at), redemptions (status, coupon_id, reserved_at, confirmed_at). analytics: session_ids, linked_qr_scans (Anzahl), linked_events (event_type, session_id, locale, order_type, occurred_at, attribution)
3. Weitere Dateien
- QR-Codes der Bestell-Links und der Tische als PNG oder SVG, Flyer als SVG.
- Support-Anfragen als JSON (Kennung orderkick-support-owner-export-v1, Felder unter anderem reference, subject, status, messages, events, attachments), nur wenn der Support-Bereich in OrderKick freigeschaltet ist.
4. Daten ohne eigenen Export
Für diese Daten bietet die Software derzeit keine eigene Exportdatei: Reservierungen (außer in der Auskunft für einen Gast), Gutscheine und Aktionen, Treueprofile, englische Speisekartentexte, Lieferzonen, Öffnungszeiten, Einstellungen und Inhalte der Restaurant-Website. Ein Gesamtarchiv aller Daten und einen standortübergreifenden Export gibt es ebenfalls nicht.
5. Formate und Normen
CSV mit UTF-8-BOM, JSON mit versionierten eigenen Schemata (Felder „format“ und „version“ beziehungsweise contract_version), XRechnung 3.0.2 (CII), ZUGFeRD 2.3.2 (EN 16931), DATEV-Format EXTF 700.
Fragen zum Datenexport: info@orderkick.com