Metafelder schreiben
Was sind Metafelder?
Mit Metafeldern kannst du die Funktionalität und das Erscheinungsbild deines Shopify-Shops anpassen, indem du spezielle Informationen speichern kannst, die normalerweise nicht im Shopify-Adminbereich erfasst werden. Mehr dazu im Shopify Help Center.
Du kannst nahezu alle sevdesk-Daten zu Kontakten, Rechnungen und Gutschriften in Metafelder der zugehörigen Shopify-Bestellung übertragen. Dadurch kannst du diese Daten mit anderen Shopify-Apps oder deiner eigenen Schnittstelle teilen und direkt im Shopify-Admin anzeigen.
Für Metafelder wird die Shopify-Berechtigung WRITE_ORDERS benötigt.
Welche Metafelder gibt es?
Es lassen sich nahezu alle sevdesk-Daten in Metafelder übertragen. Da jede Bestellung mehrere Belege besitzen kann, sind einige Metafelder Listen.
Hauptrechnung
Die Hauptrechnung (oder Primärrechnung) ist die erste von dieser App erstellte Rechnung. Sie ist nach dem in den Einstellungen festgelegten Erstellungszeitpunkt verfügbar.
- Rechnungsnummer (invoice_number)
- Datentyp: single_line_text_field; Definitionstyp: Ein Wert, Einzeiliger Text
RE-1000
- Rechnung: ID (invoice_id)
- Datentyp: number_integer; Definitionstyp: Ein Wert, Ganze Zahl
1000
- Rechnung: Titel (invoice_header)
- Datentyp: single_line_text_field; Definitionstyp: Ein Wert, Einzeiliger Text
Rechnung zur Bestellung #1000
- Rechnung: Status (invoice_status)
- Datentyp: single_line_text_field; Definitionstyp: Ein Wert, Einzeiliger Text
- DRAFT: Entwurf; OPEN_DUE: Offen / Fällig; PAID: Bezahlt (und festgeschrieben)
DRAFT
- Rechnung: Festschreibungsdatum (invoice_enshrined)
- Datentyp: date_time; Definitionstyp: Ein Wert, Datum und Uhrzeit
2023-01-01T12:00:00
- Rechnung-PDF: Download (invoice_pdf_save)
- Datentyp: url; Definitionstyp: Ein Wert, URL
https://sevify.app/invoice/1000/$token/download
- Rechnung-PDF: Ansehen (invoice_pdf_view)
- Datentyp: url; Definitionstyp: Ein Wert, URL
https://sevify.app/invoice/1000/$token
- Rechnung (JSON) (invoice_json)
- Datentyp: json; Definitionstyp: JSON
<Invoice>
Kontakt
Der Kontakt, der für den Shopify-Kunden angelegt bzw. ihm zugewiesen wurde.
- Kontakt-ID (contact_id)
- Datentyp: number_integer; Definitionstyp: Ein Wert, Ganze Zahl
1000
Alle Rechnungen
Jede Bestellung kann mehrere Rechnungen besitzen, die entweder als Werte-Liste (getrennt durch Zeilenumbrüche) oder JSON-Array in Metafelder übertragen werden können.
- Rechnungsnummern (invoices_number)
- Datentyp: list.single_line_text_field; Definitionstyp: Werteliste, Einzeiliger Text
RE-1000 RE-1001 ...
- Rechnungen: IDs (invoices_id)
- Datentyp: list.number_integer; Definitionstyp: Werteliste, Ganze Zahl
1000 1001 ...
- Rechnungen: Titel (invoices_header)
- Datentyp: list.single_line_text_field; Definitionstyp: Werteliste, Einzeiliger Text
Rechnung zur Bestellung #1000 Rechnung zur Bestellung #1001 ...
- Rechnung-PDFs: Download (invoices_pdf_save)
- Datentyp: list.url; Definitionstyp: Werteliste, URL
https://sevify.app/invoice/1000/$token https://sevify.app/invoice/1001/$token ...
- Rechnung-PDFs: Ansehen (invoices_pdf_view)
- Datentyp: list.url; Definitionstyp: Werteliste, URL
https://sevify.app/invoice/1000/$token/download https://sevify.app/invoice/1001/$token/download ...
- Rechnungen (JSON) (invoices_json)
- Datentyp: json; Definitionstyp: JSON
Array<Invoice>
Alle Gutschriften
Jede Bestellung kann mehrere Gutschriften besitzen, die entweder als Werte-Liste (getrennt durch Zeilenumbrüche) oder JSON-Array in Metafelder übertragen werden können.
- Gutschriften-Nummern (credits_number)
- Datentyp: list.single_line_text_field; Definitionstyp: Werteliste, Einzeiliger Text
GU-1000 GU-1001 ...
- Gutschriften: IDs (credits_id)
- Datentyp: list.number_integer; Definitionstyp: Werteliste, Ganze Zahl
1000 1001 ...
- Gutschriften: Titel (credits_header)
- Datentyp: list.single_line_text_field; Definitionstyp: Werteliste, Einzeiliger Text
Gutschrift zur Bestellung #1000 Gutschrift zur Bestellung #1001 ...
- Gutschrift-PDFs: Download (credits_pdf_save)
- Datentyp: list.url; Definitionstyp: Werteliste, URL
https://sevify.app/credit/1000/$token https://sevify.app/credit/1001/$token ...
- Gutschrift-PDFs: Ansehen (credits_pdf_view)
- Datentyp: list.url; Definitionstyp: Werteliste, URL
https://sevify.app/credit/1000/$token/download https://sevify.app/credit/1001/$token/download ...
- Gutschriften (JSON) (credits_json)
- Datentyp: json; Definitionstyp: JSON
Array<CreditNote>
Alle Aufträge
Jede Bestellung kann mehrere Aufträge besitzen, die entweder als Werte-Liste (getrennt durch Zeilenumbrüche) oder JSON-Array in Metafelder übertragen werden können.
- Auftragsnummern (docs_number)
- Datentyp: list.single_line_text_field; Definitionstyp: Werteliste, Einzeiliger Text
AN-1000 AB-1001 LI-1002 ...
- Aufträge: IDs (docs_id)
- Datentyp: list.number_integer; Definitionstyp: Werteliste, Ganze Zahl
1000 1001 1002 ...
- Aufträge: Titel (docs_header)
- Datentyp: list.single_line_text_field; Definitionstyp: Werteliste, Einzeiliger Text
Angebot zur Bestellung #1000 Auftragsbestätigung zur Bestellung #1000 ...
- Auftrag-PDFs: Download (docs_pdf_save)
- Datentyp: list.url; Definitionstyp: Werteliste, URL
https://sevify.app/doc/1000/$token https://sevify.app/doc/1001/$token ...
- Auftrag-PDFs: Ansehen (docs_pdf_view)
- Datentyp: list.url; Definitionstyp: Werteliste, URL
https://sevify.app/doc/1000/$token/download https://sevify.app/doc/1001/$token/download ...
- Aufträge (JSON) (docs_json)
- Datentyp: json; Definitionstyp: JSON
Array<Order>
Wir empfehlen die JSON-Metafelder (invoice_json, invoices_json, credits_json und docs_json) nur zu verwenden, wenn die benötigten Werte über andere Metafelder nicht verfügbar sind.
Wie erstelle ich ein Metafeld?
Du kannst Metafelder in den Einstellungen verwalten:
- Öffne die Metafeld-Einstellungen.
- Scrolle zum Bereich "Metafelder schreiben"
- Wähle den gewünschten sevdesk-Wert im Dropdown-Menü aus
- Lege Namensraum und Schlüssel fest oder übernehme die Standardwerte
- Lege das Metafeld über den Hinzufügen-Button an und Speichere die Einstellungen
Was ist der Namensraum?
Das Gruppieren von Metafeldern innerhalb eines Namensraums („Namespace“) verhindert, dass Metafelder mit anderen Metafeldern mit demselben Schlüsselnamen in Konflikt geraten. Zusammen ergeben Namensraum und Schlüssel eine eindeutige ID für das Metafeld.
Der Namensraum muss mindestens 3 und maximal 255 Zeichen lang sein.
Was ist der Schlüssel?
Der Schlüssel ("Key") dient in Verbindung mit dem Namensraum zur eindeutigen Identifizierung eines Metafeldes. Schlüssel können bis zu 64 Zeichen lang sein und alphanumerische Zeichen, Bindestriche, Unterstriche und Punkte enthalten.
Wann werden Metafelder erstellt?
Metafelder werden durch Webhooks verwaltet und unmittelbar nach Fertigstellung der sevdesk-Operationen an Shopify gesendet.
In der Bestellansicht kannst du nachvollziehen, welche Metafelder übertragen wurden.
Wo werden die Metafelder erstellt?
Diese App erstellt ausschließlich Metafelder für die Shopify-Ressource Orders (Bestellungen).
Werden Metafelder aktualisiert?
Ja, unter Umständen:
- Wenn die App eine Shopify-Bestellung verarbeitet oder Belege importiert, werden die konfigurierten Metafelder aktualisiert.
- Änderungen, die du direkt in sevdesk vornimmst, aktualisieren die Shopify-Metafelder nicht in jedem Fall sofort. Eine spätere Verarbeitung oder ein erneuter Belegimport aktualisiert sie.
Wie bekomme ich andere Daten in Metafelder?
Wenn du neben den vorhandenen Metafeldern eine Angabe vermisst, schicke uns eine Nachricht. Die Chancen stehen gut, dass wir dir helfen können!
Weiterführende Links
- Shopify Help Center: Metafelder
- REST Admin API: Metafield
- GraphQL Admin API: Metafield